Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Users suspended from a Team account are dissociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.
Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.
To sign out users without suspending them, use the LogoutUser action.
" + "documentation":"Suspends up to 50 users from a Team or EnterpriseLWA Amazon Chime account. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Users suspended from a Team account are dissasociated from the account, but they can continue to use Amazon Chime as free users. To remove the suspension from suspended Team account users, invite them to the Team account again. You can use the InviteUsers action to do so.
Users suspended from an EnterpriseLWA account are immediately signed out of Amazon Chime and can no longer sign in. To remove the suspension from suspended EnterpriseLWA account users, use the BatchUnsuspendUser action.
To sign out users without suspending them, use the LogoutUser action.
" }, "BatchUnsuspendUser":{ "name":"BatchUnsuspendUser", @@ -170,6 +170,26 @@ ], "documentation":"Creates an Amazon Chime account under the administrator's AWS account. Only Team account types are currently supported for this action. For more information about different account types, see Managing Your Amazon Chime Accounts in the Amazon Chime Administration Guide.
Creates a bot for an Amazon Chime Enterprise account.
" + }, "CreatePhoneNumberOrder":{ "name":"CreatePhoneNumberOrder", "http":{ @@ -229,6 +249,24 @@ ], "documentation":"Deletes the specified Amazon Chime account. You must suspend all users before deleting a Team account. You can use the BatchSuspendUser action to do so.
For EnterpriseLWA and EnterpriseAD accounts, you must release the claimed domains for your Amazon Chime account before deletion. As soon as you release the domain, all users under that account are suspended.
Deleted accounts appear in your Disabled accounts list for 90 days. To restore a deleted account from your Disabled accounts list, you must contact AWS Support.
After 90 days, deleted accounts are permanently removed from your Disabled accounts list.
Deletes the events configuration that allows a bot to receive outgoing events.
" + }, "DeletePhoneNumber":{ "name":"DeletePhoneNumber", "http":{ @@ -402,6 +440,45 @@ ], "documentation":"Retrieves account settings for the specified Amazon Chime account ID, such as remote control and dial out settings. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
" }, + "GetBot":{ + "name":"GetBot", + "http":{ + "method":"GET", + "requestUri":"/accounts/{accountId}/bots/{botId}", + "responseCode":200 + }, + "input":{"shape":"GetBotRequest"}, + "output":{"shape":"GetBotResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"}, + {"shape":"BadRequestException"} + ], + "documentation":"Retrieves details for the specified bot, such as bot email address, bot type, status, and display name.
" + }, + "GetEventsConfiguration":{ + "name":"GetEventsConfiguration", + "http":{ + "method":"GET", + "requestUri":"/accounts/{accountId}/bots/{botId}/events-configuration", + "responseCode":200 + }, + "input":{"shape":"GetEventsConfigurationRequest"}, + "output":{"shape":"GetEventsConfigurationResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"NotFoundException"} + ], + "documentation":"Gets details for an events configuration that allows a bot to receive outgoing events, such as an HTTPS endpoint or Lambda function ARN.
" + }, "GetGlobalSettings":{ "name":"GetGlobalSettings", "http":{ @@ -618,6 +695,25 @@ ], "documentation":"Lists the Amazon Chime accounts under the administrator's AWS account. You can filter accounts by account name prefix. To find out which Amazon Chime account a user belongs to, you can filter by the user's email address, which returns one account result.
" }, + "ListBots":{ + "name":"ListBots", + "http":{ + "method":"GET", + "requestUri":"/accounts/{accountId}/bots", + "responseCode":200 + }, + "input":{"shape":"ListBotsRequest"}, + "output":{"shape":"ListBotsResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"BadRequestException"}, + {"shape":"NotFoundException"} + ], + "documentation":"Lists the bots associated with the administrator's Amazon Chime Enterprise account ID.
" + }, "ListPhoneNumberOrders":{ "name":"ListPhoneNumberOrders", "http":{ @@ -734,6 +830,26 @@ ], "documentation":"Logs out the specified user from all of the devices they are currently logged into.
" }, + "PutEventsConfiguration":{ + "name":"PutEventsConfiguration", + "http":{ + "method":"PUT", + "requestUri":"/accounts/{accountId}/bots/{botId}/events-configuration", + "responseCode":201 + }, + "input":{"shape":"PutEventsConfigurationRequest"}, + "output":{"shape":"PutEventsConfigurationResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"ResourceLimitExceededException"}, + {"shape":"NotFoundException"} + ], + "documentation":"Creates an events configuration that allows a bot to receive outgoing events sent by Amazon Chime. Choose either an HTTPS endpoint or a Lambda function ARN. For more information, see Bot.
" + }, "PutVoiceConnectorOrigination":{ "name":"PutVoiceConnectorOrigination", "http":{ @@ -793,6 +909,25 @@ ], "documentation":"Adds termination SIP credentials for the specified Amazon Chime Voice Connector.
" }, + "RegenerateSecurityToken":{ + "name":"RegenerateSecurityToken", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/bots/{botId}?operation=regenerate-security-token", + "responseCode":200 + }, + "input":{"shape":"RegenerateSecurityTokenRequest"}, + "output":{"shape":"RegenerateSecurityTokenResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"} + ], + "documentation":"Regenerates the security token for a bot.
" + }, "ResetPersonalPIN":{ "name":"ResetPersonalPIN", "http":{ @@ -892,6 +1027,25 @@ ], "documentation":"Updates the settings for the specified Amazon Chime account. You can update settings for remote control of shared screens, or for the dial-out option. For more information about these settings, see Use the Policies Page in the Amazon Chime Administration Guide.
" }, + "UpdateBot":{ + "name":"UpdateBot", + "http":{ + "method":"POST", + "requestUri":"/accounts/{accountId}/bots/{botId}", + "responseCode":200 + }, + "input":{"shape":"UpdateBotRequest"}, + "output":{"shape":"UpdateBotResponse"}, + "errors":[ + {"shape":"ServiceUnavailableException"}, + {"shape":"ServiceFailureException"}, + {"shape":"ForbiddenException"}, + {"shape":"BadRequestException"}, + {"shape":"UnauthorizedClientException"}, + {"shape":"NotFoundException"} + ], + "documentation":"Updates the status of the specified bot, such as starting or stopping the bot from running in your Amazon Chime Enterprise account.
" + }, "UpdateGlobalSettings":{ "name":"UpdateGlobalSettings", "http":{ @@ -1252,6 +1406,56 @@ } }, "Boolean":{"type":"boolean"}, + "Bot":{ + "type":"structure", + "members":{ + "BotId":{ + "shape":"String", + "documentation":"The bot ID.
" + }, + "UserId":{ + "shape":"String", + "documentation":"The unique ID for the bot user.
" + }, + "DisplayName":{ + "shape":"SensitiveString", + "documentation":"The bot display name.
" + }, + "BotType":{ + "shape":"BotType", + "documentation":"The bot type.
" + }, + "Disabled":{ + "shape":"NullableBoolean", + "documentation":"When true, the bot is stopped from running in your account.
" + }, + "CreatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The bot creation timestamp, in ISO 8601 format.
" + }, + "UpdatedTimestamp":{ + "shape":"Iso8601Timestamp", + "documentation":"The updated bot timestamp, in ISO 8601 format.
" + }, + "BotEmail":{ + "shape":"SensitiveString", + "documentation":"The bot email address.
" + }, + "SecurityToken":{ + "shape":"SensitiveString", + "documentation":"The security token used to authenticate Amazon Chime with the outgoing event endpoint.
" + } + }, + "documentation":"A resource that allows Enterprise account administrators to configure an interface to receive events from Amazon Chime.
" + }, + "BotList":{ + "type":"list", + "member":{"shape":"Bot"} + }, + "BotType":{ + "type":"string", + "enum":["ChatBot"] + }, "BusinessCallingSettings":{ "type":"structure", "members":{ @@ -1301,6 +1505,38 @@ } } }, + "CreateBotRequest":{ + "type":"structure", + "required":[ + "DisplayName", + "AccountId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"The Amazon Chime account ID.
", + "location":"uri", + "locationName":"accountId" + }, + "DisplayName":{ + "shape":"SensitiveString", + "documentation":"The bot display name.
" + }, + "Domain":{ + "shape":"NonEmptyString", + "documentation":"The domain of the Amazon Chime Enterprise account.
" + } + } + }, + "CreateBotResponse":{ + "type":"structure", + "members":{ + "Bot":{ + "shape":"Bot", + "documentation":"The bot details.
" + } + } + }, "CreatePhoneNumberOrderRequest":{ "type":"structure", "required":[ @@ -1388,6 +1624,27 @@ "members":{ } }, + "DeleteEventsConfigurationRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BotId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"The Amazon Chime account ID.
", + "location":"uri", + "locationName":"accountId" + }, + "BotId":{ + "shape":"NonEmptyString", + "documentation":"The bot ID.
", + "location":"uri", + "locationName":"botId" + } + } + }, "DeletePhoneNumberRequest":{ "type":"structure", "required":["PhoneNumberId"], @@ -1540,13 +1797,31 @@ "PreconditionFailed" ] }, + "EventsConfiguration":{ + "type":"structure", + "members":{ + "BotId":{ + "shape":"String", + "documentation":"The bot ID.
" + }, + "OutboundEventsHTTPSEndpoint":{ + "shape":"SensitiveString", + "documentation":"HTTPS endpoint that allows a bot to receive outgoing events.
" + }, + "LambdaFunctionArn":{ + "shape":"SensitiveString", + "documentation":"Lambda function ARN that allows a bot to receive outgoing events.
" + } + }, + "documentation":"The configuration that allows a bot to receive outgoing events. Can be either an HTTPS endpoint or a Lambda function ARN.
" + }, "ForbiddenException":{ "type":"structure", "members":{ "Code":{"shape":"ErrorCode"}, "Message":{"shape":"String"} }, - "documentation":"The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported region.
", + "documentation":"The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported Region.
", "error":{"httpStatusCode":403}, "exception":true }, @@ -1592,6 +1867,66 @@ } } }, + "GetBotRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BotId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"The Amazon Chime account ID.
", + "location":"uri", + "locationName":"accountId" + }, + "BotId":{ + "shape":"NonEmptyString", + "documentation":"The bot ID.
", + "location":"uri", + "locationName":"botId" + } + } + }, + "GetBotResponse":{ + "type":"structure", + "members":{ + "Bot":{ + "shape":"Bot", + "documentation":"The chat bot details.
" + } + } + }, + "GetEventsConfigurationRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BotId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"The Amazon Chime account ID.
", + "location":"uri", + "locationName":"accountId" + }, + "BotId":{ + "shape":"NonEmptyString", + "documentation":"The bot ID.
", + "location":"uri", + "locationName":"botId" + } + } + }, + "GetEventsConfigurationResponse":{ + "type":"structure", + "members":{ + "EventsConfiguration":{ + "shape":"EventsConfiguration", + "documentation":"The events configuration details.
" + } + } + }, "GetGlobalSettingsResponse":{ "type":"structure", "members":{ @@ -1916,6 +2251,43 @@ } } }, + "ListBotsRequest":{ + "type":"structure", + "required":["AccountId"], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"The Amazon Chime account ID.
", + "location":"uri", + "locationName":"accountId" + }, + "MaxResults":{ + "shape":"ResultMax", + "documentation":"The maximum number of results to return in a single call. Default is 10.
", + "location":"querystring", + "locationName":"max-results" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token to use to retrieve the next page of results.
", + "location":"querystring", + "locationName":"next-token" + } + } + }, + "ListBotsResponse":{ + "type":"structure", + "members":{ + "Bots":{ + "shape":"BotList", + "documentation":"List of bots and bot details.
" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token to use to retrieve the next page of results.
" + } + } + }, "ListPhoneNumberOrdersRequest":{ "type":"structure", "members":{ @@ -2433,6 +2805,41 @@ "max":200, "min":1 }, + "PutEventsConfigurationRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BotId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"The Amazon Chime account ID.
", + "location":"uri", + "locationName":"accountId" + }, + "BotId":{ + "shape":"NonEmptyString", + "documentation":"The bot ID.
", + "location":"uri", + "locationName":"botId" + }, + "OutboundEventsHTTPSEndpoint":{ + "shape":"SensitiveString", + "documentation":"HTTPS endpoint that allows the bot to receive outgoing events.
" + }, + "LambdaFunctionArn":{ + "shape":"SensitiveString", + "documentation":"Lambda function ARN that allows the bot to receive outgoing events.
" + } + } + }, + "PutEventsConfigurationResponse":{ + "type":"structure", + "members":{ + "EventsConfiguration":{"shape":"EventsConfiguration"} + } + }, "PutVoiceConnectorOriginationRequest":{ "type":"structure", "required":[ @@ -2505,6 +2912,33 @@ } } }, + "RegenerateSecurityTokenRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BotId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"The Amazon Chime account ID.
", + "location":"uri", + "locationName":"accountId" + }, + "BotId":{ + "shape":"NonEmptyString", + "documentation":"The bot ID.
", + "location":"uri", + "locationName":"botId" + } + } + }, + "RegenerateSecurityTokenResponse":{ + "type":"structure", + "members":{ + "Bot":{"shape":"Bot"} + } + }, "RegistrationStatus":{ "type":"string", "enum":[ @@ -2543,6 +2977,16 @@ } } }, + "ResourceLimitExceededException":{ + "type":"structure", + "members":{ + "Code":{"shape":"ErrorCode"}, + "Message":{"shape":"String"} + }, + "documentation":"The request exceeds the resource limit.
", + "error":{"httpStatusCode":400}, + "exception":true + }, "RestorePhoneNumberRequest":{ "type":"structure", "required":["PhoneNumberId"], @@ -2796,6 +3240,40 @@ "members":{ } }, + "UpdateBotRequest":{ + "type":"structure", + "required":[ + "AccountId", + "BotId" + ], + "members":{ + "AccountId":{ + "shape":"NonEmptyString", + "documentation":"The Amazon Chime account ID.
", + "location":"uri", + "locationName":"accountId" + }, + "BotId":{ + "shape":"NonEmptyString", + "documentation":"The bot ID.
", + "location":"uri", + "locationName":"botId" + }, + "Disabled":{ + "shape":"NullableBoolean", + "documentation":"When true, stops the specified bot from running in your account.
" + } + } + }, + "UpdateBotResponse":{ + "type":"structure", + "members":{ + "Bot":{ + "shape":"Bot", + "documentation":"The updated bot details.
" + } + } + }, "UpdateGlobalSettingsRequest":{ "type":"structure", "required":[ diff --git a/botocore/data/comprehend/2017-11-27/service-2.json b/botocore/data/comprehend/2017-11-27/service-2.json index 020d718c06..1923937356 100644 --- a/botocore/data/comprehend/2017-11-27/service-2.json +++ b/botocore/data/comprehend/2017-11-27/service-2.json @@ -1128,6 +1128,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
" } } }, @@ -1177,6 +1181,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
" } } }, @@ -1566,6 +1574,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
" } }, "documentation":"Provides information about a document classification job.
" @@ -1676,6 +1688,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom classifier. For more information, see Amazon VPC.
" } }, "documentation":"Provides information about a document classifier.
" @@ -1762,6 +1778,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.
" } }, "documentation":"Provides information about a dominant language detection job.
" @@ -1843,6 +1863,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
" } }, "documentation":"Provides information about an entities detection job.
" @@ -2063,6 +2087,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your custom entity recognizer. For more information, see Amazon VPC.
" } }, "documentation":"Describes information about an entity recognizer.
" @@ -2281,6 +2309,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.
" } }, "documentation":"Provides information about a key phrases detection job.
" @@ -2722,6 +2754,18 @@ "max":1024, "pattern":"s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?" }, + "SecurityGroupId":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[-0-9a-zA-Z]+" + }, + "SecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "max":5, + "min":1 + }, "SentimentDetectionJobFilter":{ "type":"structure", "members":{ @@ -2790,6 +2834,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.
" } }, "documentation":"Provides information about a sentiment detection job.
" @@ -2866,6 +2914,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your document classification job. For more information, see Amazon VPC.
" } } }, @@ -2914,6 +2966,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your dominant language detection job. For more information, see Amazon VPC.
" } } }, @@ -2971,6 +3027,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your entity detection job. For more information, see Amazon VPC.
" } } }, @@ -3024,6 +3084,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your key phrases detection job. For more information, see Amazon VPC.
" } } }, @@ -3077,6 +3141,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your sentiment detection job. For more information, see Amazon VPC.
" } } }, @@ -3129,6 +3197,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
" } } }, @@ -3275,6 +3347,18 @@ "type":"list", "member":{"shape":"String"} }, + "SubnetId":{ + "type":"string", + "max":32, + "min":1, + "pattern":"[-0-9a-zA-Z]+" + }, + "Subnets":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "max":16, + "min":1 + }, "SyntaxLanguageCode":{ "type":"string", "enum":[ @@ -3468,6 +3552,10 @@ "VolumeKmsKeyId":{ "shape":"KmsKeyId", "documentation":"ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:
KMS Key ID: \"1234abcd-12ab-34cd-56ef-1234567890ab\"
Amazon Resource Name (ARN) of a KMS Key: \"arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab\"
Configuration parameters for a private Virtual Private Cloud (VPC) containing the resources you are using for your topic detection job. For more information, see Amazon VPC.
" } }, "documentation":"Provides information about a topic detection job.
" @@ -3505,6 +3593,24 @@ "type":"structure", "members":{ } + }, + "VpcConfig":{ + "type":"structure", + "required":[ + "SecurityGroupIds", + "Subnets" + ], + "members":{ + "SecurityGroupIds":{ + "shape":"SecurityGroupIds", + "documentation":"The ID number for a security group on an instance of your private VPC. Security groups on your VPC function serve as a virtual firewall to control inbound and outbound traffic and provides security for the resources that you’ll be accessing on the VPC. This ID number is preceded by \"sg-\", for instance: \"sg-03b388029b0a285ea\". For more information, see Security Groups for your VPC.
" + }, + "Subnets":{ + "shape":"Subnets", + "documentation":"The ID for each subnet being used in your private VPC. This subnet is a subset of the a range of IPv4 addresses used by the VPC and is specific to a given availability zone in the VPC’s region. This ID number is preceded by \"subnet-\", for instance: \"subnet-04ccf456919e69055\". For more information, see VPCs and Subnets.
" + } + }, + "documentation":"Configuration parameters for an optional private Virtual Private Cloud (VPC) containing the resources you are using for the job. For For more information, see Amazon VPC.
" } }, "documentation":"Amazon Comprehend is an AWS service for gaining insight into the content of documents. Use these actions to determine the topics contained in your documents, the topics they discuss, the predominant sentiment expressed in them, the predominant language used, and more.
" diff --git a/botocore/data/ec2/2016-11-15/paginators-1.json b/botocore/data/ec2/2016-11-15/paginators-1.json index 06e55382e4..1706fc0713 100644 --- a/botocore/data/ec2/2016-11-15/paginators-1.json +++ b/botocore/data/ec2/2016-11-15/paginators-1.json @@ -382,6 +382,18 @@ "limit_key": "MaxResults", "output_token": "NextToken", "result_key": "SpotInstanceRequests" + }, + "DescribeDhcpOptions": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "DhcpOptions" + }, + "DescribeSubnets": { + "input_token": "NextToken", + "limit_key": "MaxResults", + "output_token": "NextToken", + "result_key": "Subnets" } } } diff --git a/botocore/data/ec2/2016-11-15/service-2.json b/botocore/data/ec2/2016-11-15/service-2.json index 1f81eb4921..c1b63e3537 100644 --- a/botocore/data/ec2/2016-11-15/service-2.json +++ b/botocore/data/ec2/2016-11-15/service-2.json @@ -50,7 +50,7 @@ }, "input":{"shape":"AcceptVpcPeeringConnectionRequest"}, "output":{"shape":"AcceptVpcPeeringConnectionResult"}, - "documentation":"Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-region VPC peering connection request, you must accept the VPC peering connection in the region of the accepter VPC.
" + "documentation":"Accept a VPC peering connection request. To accept a request, the VPC peering connection must be in the pending-acceptance state, and you must be the owner of the peer VPC. Use DescribeVpcPeeringConnections to view your outstanding VPC peering connection requests.
For an inter-Region VPC peering connection request, you must accept the VPC peering connection in the Region of the accepter VPC.
" }, "AdvertiseByoipCidr":{ "name":"AdvertiseByoipCidr", @@ -70,7 +70,7 @@ }, "input":{"shape":"AllocateAddressRequest"}, "output":{"shape":"AllocateAddressResult"}, - "documentation":"Allocates an Elastic IP address to your AWS account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different AWS account.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per region and 5 Elastic IP addresses for EC2-VPC per region.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Allocates an Elastic IP address to your AWS account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different AWS account.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
[EC2-VPC] If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
" }, "AllocateHosts":{ "name":"AllocateHosts", @@ -373,7 +373,7 @@ }, "input":{"shape":"CopyFpgaImageRequest"}, "output":{"shape":"CopyFpgaImageResult"}, - "documentation":"Copies the specified Amazon FPGA Image (AFI) to the current region.
" + "documentation":"Copies the specified Amazon FPGA Image (AFI) to the current Region.
" }, "CopyImage":{ "name":"CopyImage", @@ -383,7 +383,7 @@ }, "input":{"shape":"CopyImageRequest"}, "output":{"shape":"CopyImageResult"}, - "documentation":"Initiates the copy of an AMI from the specified source region to the current region. You specify the destination region by using its endpoint when making the request.
Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Initiates the copy of an AMI from the specified source Region to the current Region. You specify the destination Region by using its endpoint when making the request.
Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.
" }, "CopySnapshot":{ "name":"CopySnapshot", @@ -433,7 +433,7 @@ }, "input":{"shape":"CreateCustomerGatewayRequest"}, "output":{"shape":"CreateCustomerGatewayResult"}, - "documentation":"Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).
Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 region, and 9059, which is reserved in the eu-west-1 region.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.
Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may be behind a device performing network address translation (NAT).
For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN (in the 64512 - 65534 range).
Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 Region, and 9059, which is reserved in the eu-west-1 Region.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.
Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. ITo have your instance to receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.
domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. ITo have your instance to receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.
domain-name - If you're using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you're using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, MyCompany.com). This value is used to complete unqualified DNS hostnames. Important: Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
netbios-name-servers - The IP addresses of up to four NetBIOS name servers.
netbios-node-type - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2 (broadcast and multicast are not currently supported). For more information about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error.
You can have up to five thousand key pairs per region.
The key pair returned to you is available only in the region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any region using ImportKeyPair.
For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Creates a 2048-bit RSA key pair with the specified name. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS#1 private key. If a key with the specified name already exists, Amazon EC2 returns an error.
You can have up to five thousand key pairs per Region.
The key pair returned to you is available only in the Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using ImportKeyPair.
For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
" }, "CreateLaunchTemplate":{ "name":"CreateLaunchTemplate", @@ -1238,7 +1238,7 @@ }, "input":{"shape":"DescribeAggregateIdFormatRequest"}, "output":{"shape":"DescribeAggregateIdFormatResult"}, - "documentation":"Describes the longer ID format settings for all resource types in a specific region. This request is useful for performing a quick audit to determine whether a specific region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Describes the Availability Zones that are available to you. The results include zones only for the region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.
For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.
" + "documentation":"Describes the Availability Zones that are available to you. The results include zones only for the Region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.
For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.
" }, "DescribeBundleTasks":{ "name":"DescribeBundleTasks", @@ -1508,7 +1508,7 @@ }, "input":{"shape":"DescribeIdFormatRequest"}, "output":{"shape":"DescribeIdFormatResult"}, - "documentation":"Describes the ID format settings for your resources on a per-region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the ModifyIdFormat command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions.
Recently deregistered images might appear in the returned results for a short interval.
" + "documentation":"Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you.
The images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions.
Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image results in an error indicating that the AMI ID cannot be found.
" }, "DescribeImportImageTasks":{ "name":"DescribeImportImageTasks", @@ -1748,7 +1748,7 @@ }, "input":{"shape":"DescribeRegionsRequest"}, "output":{"shape":"DescribeRegionsResult"}, - "documentation":"Describes the regions that are currently available to you.
For a list of the regions supported by Amazon EC2, see Regions and Endpoints.
" + "documentation":"Describes the Regions that are currently available to you. The API returns a list of all the Regions, including Regions that are disabled for your account. For information about enabling Regions for your account, see Enabling and Disabling Regions in the AWS Billing and Cost Management User Guide.
For a list of the Regions supported by Amazon EC2, see Regions and Endpoints.
" }, "DescribeReservedInstances":{ "name":"DescribeReservedInstances", @@ -2599,7 +2599,7 @@ "requestUri":"/" }, "input":{"shape":"ModifyIdFormatRequest"}, - "documentation":"Modifies the ID format for the specified resource on a per-region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created.
This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see Resource IDs in the Amazon Elastic Compute Cloud User Guide.
Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant Describe command for the resource type.
Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.
Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.
Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in the same AWS account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different AWS accounts or different regions. For peered VPCs in different AWS accounts, each AWS account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the region for the requester VPC to modify the requester VPC peering options and the region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
" + "documentation":"Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.
Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.
Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in the same AWS account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different AWS accounts or different Regions. For peered VPCs in different AWS accounts, each AWS account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the DescribeVpcPeeringConnections command.
" }, "ModifyVpcTenancy":{ "name":"ModifyVpcTenancy", @@ -2830,7 +2830,8 @@ "requestUri":"/" }, "input":{"shape":"ModifyVpnConnectionRequest"}, - "output":{"shape":"ModifyVpnConnectionResult"} + "output":{"shape":"ModifyVpnConnectionResult"}, + "documentation":"Modifies the target gateway of a AWS Site-to-Site VPN connection. The following migration options are available:
An existing virtual private gateway to a new virtual private gateway
An existing virtual private gateway to a transit gateway
An existing transit gateway to a new transit gateway
An existing transit gateway to a virtual private gateway
Before you perform the migration to the new gateway, you must configure the new gateway. Use CreateVpnGateway to create a virtual private gateway, or CreateTransitGateway to create a transit gateway.
This step is required when you migrate from a virtual private gateway with static routes to a transit gateway.
You must delete the static routes before you migrate to the new gateway.
Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete.
After you migrate to the new gateway, you might need to modify your VPC route table. Use CreateRoute and DeleteRoute to make the changes described in VPN Gateway Target Modification Required VPC Route Table Updates in the AWS Site-to-Site VPN User Guide.
When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the AWS Site-to-Site VPN connection. Use CreateTransitGatewayRoute to add the routes.
If you deleted VPN static routes, you must add the static routes to the transit gateway route table.
After you perform this operation, the AWS VPN endpoint's IP addresses on the AWS side and the tunnel options remain intact. Your s2slong; connection will be temporarily unavailable for approximately 10 minutes while we provision the new endpoints
" }, "MonitorInstances":{ "name":"MonitorInstances", @@ -4561,7 +4562,7 @@ }, "RegionName":{ "shape":"String", - "documentation":"The name of the region.
", + "documentation":"The name of the Region.
", "locationName":"regionName" }, "ZoneName":{ @@ -6167,7 +6168,7 @@ }, "SourceRegion":{ "shape":"String", - "documentation":"The region that contains the source AFI.
" + "documentation":"The Region that contains the source AFI.
" }, "ClientToken":{ "shape":"String", @@ -6199,7 +6200,7 @@ }, "Description":{ "shape":"String", - "documentation":"A description for the new AMI in the destination region.
" + "documentation":"A description for the new AMI in the destination Region.
" }, "Encrypted":{ "shape":"Boolean", @@ -6208,12 +6209,12 @@ }, "KmsKeyId":{ "shape":"String", - "documentation":"An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the region that the snapshot is being copied to.
", + "documentation":"An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the snapshot is being copied to.
", "locationName":"kmsKeyId" }, "Name":{ "shape":"String", - "documentation":"The name of the new AMI in the destination region.
" + "documentation":"The name of the new AMI in the destination Region.
" }, "SourceImageId":{ "shape":"String", @@ -6221,7 +6222,7 @@ }, "SourceRegion":{ "shape":"String", - "documentation":"The name of the region that contains the AMI to copy.
" + "documentation":"The name of the Region that contains the AMI to copy.
" }, "DryRun":{ "shape":"Boolean", @@ -6265,7 +6266,7 @@ }, "KmsKeyId":{ "shape":"String", - "documentation":"An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.
Indicates whether the network interface is an Elastic Fabric Adapter (EFA). Only specify this parameter to create an EFA. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.
If you are not creating an EFA ENI, omit this parameter.
" + "documentation":"Indicates whether the network interface is an Elastic Fabric Adapter (EFA). Only specify this parameter to create an EFA. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.
If you are not creating an EFA ENI, omit this parameter.
" }, "SubnetId":{ "shape":"String", @@ -7740,7 +7741,7 @@ }, "Blackhole":{ "shape":"Boolean", - "documentation":"Indicates whether to drop traffic if the target isn't available.
" + "documentation":"Indicates whether to drop traffic that matches this route.
" }, "DryRun":{ "shape":"Boolean", @@ -7900,7 +7901,7 @@ }, "KmsKeyId":{ "shape":"String", - "documentation":"An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.
(Interface endpoint) Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the region (for example, kinesis.us-east-1.amazonaws.com) which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.
Default: false
(Interface endpoint) Indicate whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, kinesis.us-east-1.amazonaws.com) which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service.
To use a private hosted zone, you must set the following VPC attributes to true: enableDnsHostnames and enableDnsSupport. Use ModifyVpcAttribute to set the VPC attributes.
Default: false
Contains the parameters for CreateVpcEndpoint.
" @@ -8107,7 +8108,7 @@ }, "PeerRegion":{ "shape":"String", - "documentation":"The region code for the accepter VPC, if the accepter VPC is located in a region other than the region in which you make the request.
Default: The region in which you make the request.
" + "documentation":"The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request.
Default: The Region in which you make the request.
" } } }, @@ -9447,7 +9448,7 @@ "members":{ "UseLongIdsAggregated":{ "shape":"Boolean", - "documentation":"Indicates whether all resource types in the region are configured to use longer IDs. This value is only true if all users are configured to use longer IDs for all resources types in the region.
Indicates whether all resource types in the Region are configured to use longer IDs. This value is only true if all users are configured to use longer IDs for all resources types in the Region.
The filters.
message - Information about the Availability Zone.
region-name - The name of the region for the Availability Zone (for example, us-east-1).
state - The state of the Availability Zone (available | information | impaired | unavailable).
zone-id - The ID of the Availability Zone (for example, use1-az1).
zone-name - The name of the Availability Zone (for example, us-east-1a).
The filters.
message - Information about the Availability Zone.
region-name - The name of the Region for the Availability Zone (for example, us-east-1).
state - The state of the Availability Zone (available | information | impaired | unavailable).
zone-id - The ID of the Availability Zone (for example, use1-az1).
zone-name - The name of the Availability Zone (for example, us-east-1a).
Contains the output of DescribeCustomerGateways.
" }, + "DescribeDhcpOptionsMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, "DescribeDhcpOptionsRequest":{ "type":"structure", "members":{ @@ -9939,6 +9945,14 @@ "shape":"Boolean", "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
" + }, + "MaxResults":{ + "shape":"DescribeDhcpOptionsMaxResults", + "documentation":"The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Information about one or more DHCP options sets.
", "locationName":"dhcpOptionsSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
The filters.
endpoint - The endpoint of the region (for example, ec2.us-east-1.amazonaws.com).
region-name - The name of the region (for example, us-east-1).
The filters.
endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
region-name - The name of the Region (for example, us-east-1).
The names of the regions.
", + "documentation":"The names of the Regions.
", "locationName":"RegionName" }, "DryRun":{ @@ -11539,7 +11558,7 @@ "members":{ "Regions":{ "shape":"RegionList", - "documentation":"Information about the regions.
", + "documentation":"Information about the Regions.
", "locationName":"regionInfo" } } @@ -12395,6 +12414,11 @@ } } }, + "DescribeSubnetsMaxResults":{ + "type":"integer", + "max":1000, + "min":5 + }, "DescribeSubnetsRequest":{ "type":"structure", "members":{ @@ -12412,6 +12436,14 @@ "shape":"Boolean", "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The token for the next page of results.
" + }, + "MaxResults":{ + "shape":"DescribeSubnetsMaxResults", + "documentation":"The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.
Information about one or more subnets.
", "locationName":"subnetSet" + }, + "NextToken":{ + "shape":"String", + "documentation":"The token to use to retrieve the next page of results. This value is null when there are no more results to return.
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the region that the AMI is being copied to.
" + "documentation":"An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the AMI is being copied to.
" }, "LicenseType":{ "shape":"String", @@ -16911,7 +16948,7 @@ }, "KmsKeyId":{ "shape":"String", - "documentation":"An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the region that the snapshot is being copied to.
" + "documentation":"An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the snapshot is being copied to.
" }, "RoleName":{ "shape":"String", @@ -17848,7 +17885,7 @@ }, "DeviceIndex":{ "shape":"Integer", - "documentation":"The index of the device on the instance for the network interface attachment. If you are specifying a network interface in a RunInstances request, you must provide the device index.
", + "documentation":"The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
", "locationName":"deviceIndex" }, "Groups":{ @@ -17874,18 +17911,18 @@ }, "PrivateIpAddress":{ "shape":"String", - "documentation":"The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
", + "documentation":"The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a RunInstances request.
", "locationName":"privateIpAddress" }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", - "documentation":"One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
", + "documentation":"One or more private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.
", "locationName":"privateIpAddressesSet", "queryName":"PrivateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", - "documentation":"The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
", + "documentation":"The number of secondary private IPv4 addresses. You can't specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you're launching more than one instance in a RunInstances request.
", "locationName":"secondaryPrivateIpAddressCount" }, "SubnetId":{ @@ -19523,7 +19560,7 @@ "members":{ "ResourceType":{ "shape":"ResourceType", - "documentation":"The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume. To tag a resource after it has been created, see CreateTags.
The type of resource to tag. Currently, the resource types that support tagging on creation are instance and volume. To tag a resource after it has been created, see CreateTags.
The ID of the VPN connection.
" + }, + "TransitGatewayId":{ + "shape":"String", + "documentation":"The ID of the transit gateway.
" + }, + "VpnGatewayId":{ + "shape":"String", + "documentation":"The ID of the virtual private gateway at the AWS side of the VPN connection.
" + }, + "DryRun":{ + "shape":"Boolean", + "documentation":"Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the region.
", + "documentation":"The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
", "locationName":"availabilityZone" }, "Affinity":{ @@ -21803,7 +21852,7 @@ }, "Tenancy":{ "shape":"Tenancy", - "documentation":"The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
The public IPv4 address range, in CIDR notation. The most specific prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this or another region.
" + "documentation":"The public IPv4 address range, in CIDR notation. The most specific prefix that you can specify is /24. The address range cannot overlap with another address range that you've brought to this or another Region.
" }, "CidrAuthorizationContext":{ "shape":"CidrAuthorizationContext", @@ -22597,16 +22646,16 @@ "members":{ "Endpoint":{ "shape":"String", - "documentation":"The region service endpoint.
", + "documentation":"The Region service endpoint.
", "locationName":"regionEndpoint" }, "RegionName":{ "shape":"String", - "documentation":"The name of the region.
", + "documentation":"The name of the Region.
", "locationName":"regionName" } }, - "documentation":"Describes a region.
" + "documentation":"Describes a Region.
" }, "RegionList":{ "type":"list", @@ -23188,7 +23237,7 @@ }, "NetworkInterfaces":{ "shape":"LaunchTemplateInstanceNetworkInterfaceSpecificationRequestList", - "documentation":"One or more network interfaces.
", + "documentation":"One or more network interfaces. If you specify a network interface, you must specify any security groups as part of the network interface.
", "locationName":"NetworkInterface" }, "ImageId":{ @@ -23229,7 +23278,7 @@ }, "TagSpecifications":{ "shape":"LaunchTemplateTagSpecificationRequestList", - "documentation":"The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
", + "documentation":"The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
", "locationName":"TagSpecification" }, "ElasticGpuSpecifications":{ @@ -23244,7 +23293,7 @@ }, "SecurityGroupIds":{ "shape":"SecurityGroupIdStringList", - "documentation":"One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.
", + "documentation":"One or more security group IDs. You can create a security group using CreateSecurityGroup. You cannot specify both a security group ID and security name in the same request.
", "locationName":"SecurityGroupId" }, "SecurityGroups":{ @@ -23713,7 +23762,7 @@ }, "Scope":{ "shape":"scope", - "documentation":"Whether the Reserved Instance is applied to instances in a region or instances in a specific Availability Zone.
", + "documentation":"Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.
", "locationName":"scope" } }, @@ -23977,7 +24026,7 @@ }, "Scope":{ "shape":"scope", - "documentation":"Whether the Reserved Instance is applied to instances in a region or an Availability Zone.
", + "documentation":"Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
", "locationName":"scope" } }, @@ -24734,7 +24783,7 @@ }, "KeyName":{ "shape":"String", - "documentation":"The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
The IDs of the security groups. You can create a security group using CreateSecurityGroup.
Default: Amazon EC2 uses the default security group.
You cannot specify this option and the network interfaces option in the same request.
", + "documentation":"The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface.
", "locationName":"SecurityGroupId" }, "SecurityGroups":{ "shape":"SecurityGroupStringList", - "documentation":"[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
You cannot specify this option and the network interfaces option in the same request.
Default: Amazon EC2 uses the default security group.
", + "documentation":"[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
", "locationName":"SecurityGroup" }, "SubnetId":{ @@ -24786,7 +24835,7 @@ }, "DisableApiTermination":{ "shape":"Boolean", - "documentation":"If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute to false after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
If you set this parameter to true, you can't terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute to false after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
The network interfaces to associate with the instance.
", + "documentation":"The network interfaces to associate with the instance. If you specify a network interface, you must specify any security groups as part of the network interface.
", "locationName":"networkInterface" }, "PrivateIpAddress":{ @@ -24830,7 +24879,7 @@ }, "TagSpecifications":{ "shape":"TagSpecificationList", - "documentation":"The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
", + "documentation":"The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags.
", "locationName":"TagSpecification" }, "LaunchTemplate":{ @@ -24843,7 +24892,7 @@ }, "CreditSpecification":{ "shape":"CreditSpecificationRequest", - "documentation":"The credit option for CPU usage of the T2 or T3 instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.
Default: standard (T2 instances) or unlimited (T3 instances)
The credit option for CPU usage of the T2 or T3 instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.
Default: standard (T2 instances) or unlimited (T3 instances)
One or more block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
", + "documentation":"One or more block devices that are mapped to the Spot instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.
", "locationName":"blockDeviceMapping" }, "EbsOptimized":{ @@ -26133,7 +26182,7 @@ }, "RamdiskId":{ "shape":"String", - "documentation":"The ID of the RAM disk.
", + "documentation":"The ID of the RAM disk. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, refer to the AWS Resource Center and search for the kernel ID.
", "locationName":"ramdiskId" }, "SpotPrice":{ @@ -26148,12 +26197,12 @@ }, "UserData":{ "shape":"String", - "documentation":"The Base64-encoded user data to make available to the instances.
", + "documentation":"The Base64-encoded user data that instances use when starting up.
", "locationName":"userData" }, "WeightedCapacity":{ "shape":"Double", - "documentation":"The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms (instances or a performance characteristic such as vCPUs, memory, or I/O).
If the target capacity divided by this value is not a whole number, we round the number of instances to the next whole number. If this value is not specified, the default is 1.
", + "documentation":"The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
", "locationName":"weightedCapacity" }, "TagSpecifications":{ @@ -26162,7 +26211,7 @@ "locationName":"tagSpecificationSet" } }, - "documentation":"Describes the launch specification for one or more Spot Instances.
" + "documentation":"Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request, you can't use SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.
Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
", + "documentation":"Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
", "locationName":"excessCapacityTerminationPolicy" }, "FulfilledCapacity":{ @@ -26245,17 +26294,17 @@ }, "IamFleetRole":{ "shape":"String", - "documentation":"Grants the Spot Fleet permission to terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set terminateInstancesWithExpiration.
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet Prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.
The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs.
The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can't specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.
The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications.
The launch template and overrides. If you specify LaunchTemplateConfigs, you can't specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.
The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
Indicates whether running Spot Instances should be terminated when the Spot Fleet request expires.
", + "documentation":"Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
", "locationName":"terminateInstancesWithExpiration" }, "Type":{ @@ -26285,12 +26334,12 @@ }, "ValidFrom":{ "shape":"DateTime", - "documentation":"The start date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). The default is to start fulfilling the request immediately.
", + "documentation":"The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.
", "locationName":"validFrom" }, "ValidUntil":{ "shape":"DateTime", - "documentation":"The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.
", + "documentation":"The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.
", "locationName":"validUntil" }, "ReplaceUnhealthyInstances":{ @@ -29423,7 +29472,7 @@ }, "Region":{ "shape":"String", - "documentation":"The region in which the VPC is located.
", + "documentation":"The Region in which the VPC is located.
", "locationName":"region" } }, diff --git a/botocore/data/storagegateway/2013-06-30/service-2.json b/botocore/data/storagegateway/2013-06-30/service-2.json index 1f78e36bcd..6521d151be 100644 --- a/botocore/data/storagegateway/2013-06-30/service-2.json +++ b/botocore/data/storagegateway/2013-06-30/service-2.json @@ -1565,7 +1565,7 @@ }, "SMBACLEnabled":{ "shape":"Boolean", - "documentation":"Set this value to \"true to enable ACL (access control list) on the SMB file share. Set it to \"false\" to map file and directory permissions to the POSIX permissions.
" + "documentation":"Set this value to \"true to enable ACL (access control list) on the SMB file share. Set it to \"false\" to map file and directory permissions to the POSIX permissions.
For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
" }, "AdminUserList":{ "shape":"FileShareUserList", @@ -1648,6 +1648,10 @@ "SnapshotDescription":{ "shape":"SnapshotDescription", "documentation":"Textual description of the snapshot that appears in the Amazon EC2 console, Elastic Block Store snapshots panel in the Description field, and in the AWS Storage Gateway snapshot Details pane, Description field
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
A JSON object containing one or more of the following fields:
" @@ -3612,7 +3616,7 @@ }, "SMBACLEnabled":{ "shape":"Boolean", - "documentation":"If this value is set to \"true\", indicates that ACL (access control list) is enabled on the SMB file share. If it is set to \"false\", it indicates that file and directory permissions are mapped to the POSIX permission.
" + "documentation":"If this value is set to \"true\", indicates that ACL (access control list) is enabled on the SMB file share. If it is set to \"false\", it indicates that file and directory permissions are mapped to the POSIX permission.
For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.html in the Storage Gateway User Guide.
" }, "AdminUserList":{ "shape":"FileShareUserList", @@ -4309,7 +4313,7 @@ }, "SMBACLEnabled":{ "shape":"Boolean", - "documentation":"Set this value to \"true to enable ACL (access control list) on the SMB file share. Set it to \"false\" to map file and directory permissions to the POSIX permissions.
" + "documentation":"Set this value to \"true to enable ACL (access control list) on the SMB file share. Set it to \"false\" to map file and directory permissions to the POSIX permissions.
For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/smb-acl.htmlin the Storage Gateway User Guide.
" }, "AdminUserList":{ "shape":"FileShareUserList", @@ -4359,6 +4363,10 @@ "Description":{ "shape":"Description", "documentation":"Optional description of the snapshot that overwrites the existing description.
" + }, + "Tags":{ + "shape":"Tags", + "documentation":"A list of up to 50 tags that can be assigned to a snapshot. Each tag is a key-value pair.
Valid characters for key and value are letters, spaces, and numbers representable in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256.
A JSON object containing one or more of the following fields:
" diff --git a/docs/source/conf.py b/docs/source/conf.py index a2962818cd..fea710de44 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -54,7 +54,7 @@ # The short X.Y version. version = '1.12.1' # The full version, including alpha/beta/rc tags. -release = '1.12.147' +release = '1.12.148' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.