diff --git a/.changes/1.25.79.json b/.changes/1.25.79.json new file mode 100644 index 000000000000..2dc43f196011 --- /dev/null +++ b/.changes/1.25.79.json @@ -0,0 +1,22 @@ +[ + { + "category": "Python", + "description": "Add support for Python 3.11", + "type": "enhancement" + }, + { + "category": "``comprehend``", + "description": "Amazon Comprehend now supports synchronous mode for targeted sentiment API operations.", + "type": "api-change" + }, + { + "category": "``s3control``", + "description": "S3 on Outposts launches support for object versioning for Outposts buckets. With S3 Versioning, you can preserve, retrieve, and restore every version of every object stored in your buckets. You can recover from both unintended user actions and application failures.", + "type": "api-change" + }, + { + "category": "``sagemaker``", + "description": "SageMaker now allows customization on Canvas Application settings, including enabling/disabling time-series forecasting and specifying an Amazon Forecast execution role at both the Domain and UserProfile levels.", + "type": "api-change" + } +] \ No newline at end of file diff --git a/.changes/1.25.80.json b/.changes/1.25.80.json new file mode 100644 index 000000000000..673a5080b3b3 --- /dev/null +++ b/.changes/1.25.80.json @@ -0,0 +1,27 @@ +[ + { + "category": "``backup-gateway``", + "description": "Changes include: new GetVirtualMachineApi to fetch a single user's VM, improving ListVirtualMachines to fetch filtered VMs as well as all VMs, and improving GetGatewayApi to now also return the gateway's MaintenanceStartTime.", + "type": "api-change" + }, + { + "category": "``devicefarm``", + "description": "This release adds the support for VPC-ENI based connectivity for private devices on AWS Device Farm.", + "type": "api-change" + }, + { + "category": "``ec2``", + "description": "Documentation updates for Amazon EC2.", + "type": "api-change" + }, + { + "category": "``glue``", + "description": "Added support for S3 Event Notifications for Catalog Target Crawlers.", + "type": "api-change" + }, + { + "category": "``identitystore``", + "description": "Documentation updates for the Identity Store CLI Reference.", + "type": "api-change" + } +] \ No newline at end of file diff --git a/.changes/next-release/apichange-backupgateway-92776.json b/.changes/next-release/apichange-backupgateway-92776.json new file mode 100644 index 000000000000..197e981983e3 --- /dev/null +++ b/.changes/next-release/apichange-backupgateway-92776.json @@ -0,0 +1,5 @@ +{ + "category": "``backup-gateway``", + "description": "Changes include: new GetVirtualMachineApi to fetch a single user's VM, improving ListVirtualMachines to fetch filtered VMs as well as all VMs, and improving GetGatewayApi to now also return the gateway's MaintenanceStartTime.", + "type": "api-change" +} \ No newline at end of file diff --git a/.changes/next-release/apichange-comprehend-74193.json b/.changes/next-release/apichange-comprehend-74193.json new file mode 100644 index 000000000000..e42fc64ef8fc --- /dev/null +++ b/.changes/next-release/apichange-comprehend-74193.json @@ -0,0 +1,5 @@ +{ + "category": "``comprehend``", + "description": "Amazon Comprehend now supports synchronous mode for targeted sentiment API operations.", + "type": "api-change" +} \ No newline at end of file diff --git a/.changes/next-release/apichange-devicefarm-38461.json b/.changes/next-release/apichange-devicefarm-38461.json new file mode 100644 index 000000000000..2839ef0e00a2 --- /dev/null +++ b/.changes/next-release/apichange-devicefarm-38461.json @@ -0,0 +1,5 @@ +{ + "category": "``devicefarm``", + "description": "This release adds the support for VPC-ENI based connectivity for private devices on AWS Device Farm.", + "type": "api-change" +} \ No newline at end of file diff --git a/.changes/next-release/apichange-ec2-87291.json b/.changes/next-release/apichange-ec2-87291.json new file mode 100644 index 000000000000..7dd6ab622576 --- /dev/null +++ b/.changes/next-release/apichange-ec2-87291.json @@ -0,0 +1,5 @@ +{ + "category": "``ec2``", + "description": "Documentation updates for Amazon EC2.", + "type": "api-change" +} \ No newline at end of file diff --git a/.changes/next-release/apichange-glue-98058.json b/.changes/next-release/apichange-glue-98058.json new file mode 100644 index 000000000000..f9526fc843a6 --- /dev/null +++ b/.changes/next-release/apichange-glue-98058.json @@ -0,0 +1,5 @@ +{ + "category": "``glue``", + "description": "Added support for S3 Event Notifications for Catalog Target Crawlers.", + "type": "api-change" +} \ No newline at end of file diff --git a/.changes/next-release/apichange-identitystore-98438.json b/.changes/next-release/apichange-identitystore-98438.json new file mode 100644 index 000000000000..491575addb3e --- /dev/null +++ b/.changes/next-release/apichange-identitystore-98438.json @@ -0,0 +1,5 @@ +{ + "category": "``identitystore``", + "description": "Documentation updates for the Identity Store CLI Reference.", + "type": "api-change" +} \ No newline at end of file diff --git a/.changes/next-release/apichange-s3control-84147.json b/.changes/next-release/apichange-s3control-84147.json new file mode 100644 index 000000000000..80c1bd21c94d --- /dev/null +++ b/.changes/next-release/apichange-s3control-84147.json @@ -0,0 +1,5 @@ +{ + "category": "``s3control``", + "description": "S3 on Outposts launches support for object versioning for Outposts buckets. With S3 Versioning, you can preserve, retrieve, and restore every version of every object stored in your buckets. You can recover from both unintended user actions and application failures.", + "type": "api-change" +} \ No newline at end of file diff --git a/.changes/next-release/apichange-sagemaker-2226.json b/.changes/next-release/apichange-sagemaker-2226.json new file mode 100644 index 000000000000..5a97f61b224d --- /dev/null +++ b/.changes/next-release/apichange-sagemaker-2226.json @@ -0,0 +1,5 @@ +{ + "category": "``sagemaker``", + "description": "SageMaker now allows customization on Canvas Application settings, including enabling/disabling time-series forecasting and specifying an Amazon Forecast execution role at both the Domain and UserProfile levels.", + "type": "api-change" +} \ No newline at end of file diff --git a/CHANGELOG.rst b/CHANGELOG.rst index e1e2b7946b43..410a53a08487 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -4108,6 +4108,25 @@ CHANGELOG * feature:wizard: Added support for AWS CLI Wizards. See `#3752 `__. +1.25.80 +======= + +* api-change:``backup-gateway``: Changes include: new GetVirtualMachineApi to fetch a single user's VM, improving ListVirtualMachines to fetch filtered VMs as well as all VMs, and improving GetGatewayApi to now also return the gateway's MaintenanceStartTime. +* api-change:``devicefarm``: This release adds the support for VPC-ENI based connectivity for private devices on AWS Device Farm. +* api-change:``ec2``: Documentation updates for Amazon EC2. +* api-change:``glue``: Added support for S3 Event Notifications for Catalog Target Crawlers. +* api-change:``identitystore``: Documentation updates for the Identity Store CLI Reference. + + +1.25.79 +======= + +* enhancement:Python: Add support for Python 3.11 +* api-change:``comprehend``: Amazon Comprehend now supports synchronous mode for targeted sentiment API operations. +* api-change:``s3control``: S3 on Outposts launches support for object versioning for Outposts buckets. With S3 Versioning, you can preserve, retrieve, and restore every version of every object stored in your buckets. You can recover from both unintended user actions and application failures. +* api-change:``sagemaker``: SageMaker now allows customization on Canvas Application settings, including enabling/disabling time-series forecasting and specifying an Amazon Forecast execution role at both the Domain and UserProfile levels. + + 1.25.78 ======= diff --git a/awscli/botocore/data/backup-gateway/2021-01-01/service-2.json b/awscli/botocore/data/backup-gateway/2021-01-01/service-2.json index c7b3d86979b8..5170acd9f7db 100644 --- a/awscli/botocore/data/backup-gateway/2021-01-01/service-2.json +++ b/awscli/botocore/data/backup-gateway/2021-01-01/service-2.json @@ -24,7 +24,8 @@ "errors":[ {"shape":"ValidationException"}, {"shape":"ConflictException"}, - {"shape":"InternalServerException"} + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Associates a backup gateway with your server. After you complete the association process, you can back up and restore your VMs through the gateway.

" }, @@ -38,7 +39,8 @@ "output":{"shape":"CreateGatewayOutput"}, "errors":[ {"shape":"ValidationException"}, - {"shape":"InternalServerException"} + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

" }, @@ -53,7 +55,8 @@ "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Deletes a backup gateway.

", "idempotent":true @@ -70,7 +73,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Deletes a hypervisor.

", "idempotent":true @@ -87,7 +91,8 @@ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Disassociates a backup gateway from the specified server. After the disassociation process finishes, the gateway can no longer access the virtual machines on the server.

" }, @@ -102,10 +107,27 @@ "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"

By providing the ARN (Amazon Resource Name), this API returns the gateway.

" }, + "GetVirtualMachine":{ + "name":"GetVirtualMachine", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"GetVirtualMachineInput"}, + "output":{"shape":"GetVirtualMachineOutput"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} + ], + "documentation":"

By providing the ARN (Amazon Resource Name), this API returns the virtual machine.

" + }, "ImportHypervisorConfiguration":{ "name":"ImportHypervisorConfiguration", "http":{ @@ -117,7 +139,8 @@ "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, - {"shape":"AccessDeniedException"} + {"shape":"AccessDeniedException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Connect to a hypervisor by importing its configuration.

" }, @@ -131,7 +154,8 @@ "output":{"shape":"ListGatewaysOutput"}, "errors":[ {"shape":"ValidationException"}, - {"shape":"InternalServerException"} + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region. The returned list is ordered by gateway Amazon Resource Name (ARN).

" }, @@ -145,7 +169,8 @@ "output":{"shape":"ListHypervisorsOutput"}, "errors":[ {"shape":"ValidationException"}, - {"shape":"InternalServerException"} + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Lists your hypervisors.

" }, @@ -160,7 +185,8 @@ "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Lists the tags applied to the resource identified by its Amazon Resource Name (ARN).

" }, @@ -174,7 +200,8 @@ "output":{"shape":"ListVirtualMachinesOutput"}, "errors":[ {"shape":"ValidationException"}, - {"shape":"InternalServerException"} + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Lists your virtual machines.

" }, @@ -190,7 +217,8 @@ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Set the maintenance start time for a gateway.

" }, @@ -205,7 +233,8 @@ "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Tag the resource.

" }, @@ -221,7 +250,8 @@ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources.

" }, @@ -236,7 +266,8 @@ "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Removes tags from the resource.

" }, @@ -252,7 +283,8 @@ {"shape":"ValidationException"}, {"shape":"ConflictException"}, {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Updates a gateway's name. Specify which gateway to update using the Amazon Resource Name (ARN) of the gateway in your request.

" }, @@ -267,7 +299,8 @@ "errors":[ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Updates the gateway virtual machine (VM) software. The request immediately triggers the software update.

When you make this request, you get a 200 OK success response immediately. However, it might take some time for the update to complete.

" }, @@ -283,7 +316,8 @@ {"shape":"ValidationException"}, {"shape":"InternalServerException"}, {"shape":"AccessDeniedException"}, - {"shape":"ResourceNotFoundException"} + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"} ], "documentation":"

Updates a hypervisor metadata, including its host, username, and password. Specify which hypervisor to update using the Amazon Resource Name (ARN) of the hypervisor in your request.

" } @@ -506,6 +540,10 @@ "shape":"Time", "documentation":"

Details showing the last time Backup gateway communicated with the cloud, in Unix format and UTC time.

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

Returns your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.

" + }, "NextUpdateAvailabilityTime":{ "shape":"Time", "documentation":"

Details showing the next update availability time of the gateway.

" @@ -544,6 +582,25 @@ } } }, + "GetVirtualMachineInput":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"ResourceArn", + "documentation":"

The Amazon Resource Name (ARN) of the virtual machine.

" + } + } + }, + "GetVirtualMachineOutput":{ + "type":"structure", + "members":{ + "VirtualMachine":{ + "shape":"VirtualMachineDetails", + "documentation":"

This object contains the basic attributes of VirtualMachine contained by the output of GetVirtualMachine

" + } + } + }, "Host":{ "type":"string", "max":128, @@ -739,6 +796,10 @@ "ListVirtualMachinesInput":{ "type":"structure", "members":{ + "HypervisorArn":{ + "shape":"ServerArn", + "documentation":"

The Amazon Resource Name (ARN) of the hypervisor connected to your virtual machine.

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

The maximum number of virtual machines to list.

" @@ -762,6 +823,32 @@ } } }, + "MaintenanceStartTime":{ + "type":"structure", + "required":[ + "HourOfDay", + "MinuteOfHour" + ], + "members":{ + "DayOfMonth":{ + "shape":"DayOfMonth", + "documentation":"

The day of the month component of the maintenance start time represented as an ordinal number from 1 to 28, where 1 represents the first day of the month and 28 represents the last day of the month.

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

An ordinal number between 0 and 6 that represents the day of the week, where 0 represents Sunday and 6 represents Saturday. The day of week is in the time zone of the gateway.

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

The hour component of the maintenance start time represented as hh, where hh is the hour (0 to 23). The hour of the day is in the time zone of the gateway.

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

The minute component of the maintenance start time represented as mm, where mm is the minute (0 to 59). The minute of the hour is in the time zone of the gateway.

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

This is your gateway's weekly maintenance start time including the day and time of the week. Note that values are in terms of the gateway's time zone. Can be weekly or monthly.

" + }, "MaxResults":{ "type":"integer", "box":true, @@ -955,6 +1042,19 @@ "members":{ } }, + "ThrottlingException":{ + "type":"structure", + "required":["ErrorCode"], + "members":{ + "ErrorCode":{ + "shape":"string", + "documentation":"

Error: TPS has been limited to protect against intentional or unintentional high request volumes.

" + }, + "Message":{"shape":"string"} + }, + "documentation":"

TPS has been limited to protect against intentional or unintentional high request volumes.

", + "exception":true + }, "Time":{"type":"timestamp"}, "UntagResourceInput":{ "type":"structure", @@ -1108,6 +1208,36 @@ }, "documentation":"

A virtual machine that is on a hypervisor.

" }, + "VirtualMachineDetails":{ + "type":"structure", + "members":{ + "HostName":{ + "shape":"Name", + "documentation":"

The host name of the virtual machine.

" + }, + "HypervisorId":{ + "shape":"string", + "documentation":"

The ID of the virtual machine's hypervisor.

" + }, + "LastBackupDate":{ + "shape":"Time", + "documentation":"

The most recent date a virtual machine was backed up, in Unix format and UTC time.

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

The name of the virtual machine.

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

The path of the virtual machine.

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

The Amazon Resource Name (ARN) of the virtual machine. For example, arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL.

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

Your VirtualMachine objects, ordered by their Amazon Resource Names (ARNs).

" + }, "VirtualMachines":{ "type":"list", "member":{"shape":"VirtualMachine"} diff --git a/awscli/botocore/data/comprehend/2017-11-27/service-2.json b/awscli/botocore/data/comprehend/2017-11-27/service-2.json index 2a3207f0ef70..3d178bdf1fed 100644 --- a/awscli/botocore/data/comprehend/2017-11-27/service-2.json +++ b/awscli/botocore/data/comprehend/2017-11-27/service-2.json @@ -44,7 +44,7 @@ {"shape":"BatchSizeLimitExceededException"}, {"shape":"InternalServerException"} ], - "documentation":"

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see how-entities

" + "documentation":"

Inspects the text of a batch of documents for named entities and returns information about them. For more information about named entities, see Entities in the Comprehend Developer Guide.

" }, "BatchDetectKeyPhrases":{ "name":"BatchDetectKeyPhrases", @@ -95,7 +95,24 @@ {"shape":"BatchSizeLimitExceededException"}, {"shape":"InternalServerException"} ], - "documentation":"

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see how-syntax.

" + "documentation":"

Inspects the text of a batch of documents for the syntax and part of speech of the words in the document and returns information about them. For more information, see Syntax in the Comprehend Developer Guide.

" + }, + "BatchDetectTargetedSentiment":{ + "name":"BatchDetectTargetedSentiment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"BatchDetectTargetedSentimentRequest"}, + "output":{"shape":"BatchDetectTargetedSentimentResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"UnsupportedLanguageException"}, + {"shape":"BatchSizeLimitExceededException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Inspects a batch of documents and returns a sentiment analysis for each entity identified in the documents.

For more information about targeted sentiment, see Targeted sentiment.

" }, "ClassifyDocument":{ "name":"ClassifyDocument", @@ -147,7 +164,7 @@ {"shape":"KmsKeyValidationException"}, {"shape":"InternalServerException"} ], - "documentation":"

Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see how-document-classification.

" + "documentation":"

Creates a new document classifier that you can use to categorize documents. To create a classifier, you provide a set of training documents that labeled with the categories that you want to use. After the classifier is trained you can use it to categorize a set of labeled documents into the categories. For more information, see Document Classification in the Comprehend Developer Guide.

" }, "CreateEndpoint":{ "name":"CreateEndpoint", @@ -494,7 +511,7 @@ {"shape":"UnsupportedLanguageException"}, {"shape":"InternalServerException"} ], - "documentation":"

Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.

" + "documentation":"

Inspects text for named entities, and returns information about them. For more information, about named entities, see Entities in the Comprehend Developer Guide.

" }, "DetectKeyPhrases":{ "name":"DetectKeyPhrases", @@ -558,7 +575,23 @@ {"shape":"UnsupportedLanguageException"}, {"shape":"InternalServerException"} ], - "documentation":"

Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.

" + "documentation":"

Inspects text for syntax and the part of speech of words in the document. For more information, see Syntax in the Comprehend Developer Guide.

" + }, + "DetectTargetedSentiment":{ + "name":"DetectTargetedSentiment", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectTargetedSentimentRequest"}, + "output":{"shape":"DetectTargetedSentimentResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"UnsupportedLanguageException"}, + {"shape":"InternalServerException"} + ], + "documentation":"

Inspects the input text and returns a sentiment analysis for each entity identified in the text.

For more information about targeted sentiment, see Targeted sentiment.

" }, "ImportModel":{ "name":"ImportModel", @@ -1253,7 +1286,7 @@ "members":{ "TextList":{ "shape":"CustomerInputStringList", - "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters and must contain fewer than 5,000 bytes of UTF-8 encoded characters.

" + "documentation":"

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. Each document should contain at least 20 characters. The maximum size of each document is 5 KB.

" } } }, @@ -1298,7 +1331,7 @@ "members":{ "TextList":{ "shape":"CustomerInputStringList", - "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.

" + "documentation":"

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

" }, "LanguageCode":{ "shape":"LanguageCode", @@ -1347,7 +1380,7 @@ "members":{ "TextList":{ "shape":"CustomerInputStringList", - "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer than 5,000 bytes of UTF-8 encoded characters.

" + "documentation":"

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

" }, "LanguageCode":{ "shape":"LanguageCode", @@ -1400,7 +1433,7 @@ "members":{ "TextList":{ "shape":"CustomerInputStringList", - "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + "documentation":"

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

Amazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text and ignores any additional text in the input.

" }, "LanguageCode":{ "shape":"LanguageCode", @@ -1449,7 +1482,7 @@ "members":{ "TextList":{ "shape":"CustomerInputStringList", - "documentation":"

A list containing the text of the input documents. The list can contain a maximum of 25 documents. Each document must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + "documentation":"

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size for each document is 5 KB.

" }, "LanguageCode":{ "shape":"SyntaxLanguageCode", @@ -1475,6 +1508,55 @@ }, "sensitive":true }, + "BatchDetectTargetedSentimentItemResult":{ + "type":"structure", + "members":{ + "Index":{ + "shape":"Integer", + "documentation":"

The zero-based index of this result in the input list.

" + }, + "Entities":{ + "shape":"ListOfTargetedSentimentEntities", + "documentation":"

An array of targeted sentiment entities.

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

Analysis results for one of the documents in the batch.

" + }, + "BatchDetectTargetedSentimentRequest":{ + "type":"structure", + "required":[ + "TextList", + "LanguageCode" + ], + "members":{ + "TextList":{ + "shape":"CustomerInputStringList", + "documentation":"

A list containing the UTF-8 encoded text of the input documents. The list can contain a maximum of 25 documents. The maximum size of each document is 5 KB.

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

The language of the input documents. Currently, English is the only supported language.

" + } + } + }, + "BatchDetectTargetedSentimentResponse":{ + "type":"structure", + "required":[ + "ResultList", + "ErrorList" + ], + "members":{ + "ResultList":{ + "shape":"ListOfDetectTargetedSentimentResult", + "documentation":"

A list of objects containing the results of the operation. The results are sorted in ascending order by the Index field and match the order of the documents in the input list. If all of the documents contain an error, the ResultList is empty.

" + }, + "ErrorList":{ + "shape":"BatchItemErrorList", + "documentation":"

List of errors that the operation can return.

" + } + }, + "sensitive":true + }, "BatchItemError":{ "type":"structure", "members":{ @@ -1645,7 +1727,7 @@ "members":{ "Text":{ "shape":"String", - "documentation":"

Creates a new document classification request to analyze a single document in real-time, returning personally identifiable information (PII) entity labels.

" + "documentation":"

A UTF-8 text string. The maximum string size is 100 KB.

" }, "LanguageCode":{ "shape":"LanguageCode", @@ -2181,7 +2263,7 @@ "members":{ "Text":{ "shape":"CustomerInputString", - "documentation":"

A UTF-8 text string. Each string should contain at least 20 characters and must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + "documentation":"

A UTF-8 text string. The string must contain at least 20 characters. The maximum string size is 100 KB.

" } } }, @@ -2201,7 +2283,7 @@ "members":{ "Text":{ "shape":"CustomerInputString", - "documentation":"

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + "documentation":"

A UTF-8 text string. The maximum string size is 100 KB.

" }, "LanguageCode":{ "shape":"LanguageCode", @@ -2218,7 +2300,7 @@ "members":{ "Entities":{ "shape":"ListOfEntities", - "documentation":"

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see how-entities.

" + "documentation":"

A collection of entities identified in the input text. For each entity, the response provides the entity text, entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

If your request uses a custom entity recognition model, Amazon Comprehend detects the entities that the model is trained to recognize. Otherwise, it detects the default entity types. For a list of default entity types, see Entities in the Comprehend Developer Guide.

" } }, "sensitive":true @@ -2232,7 +2314,7 @@ "members":{ "Text":{ "shape":"CustomerInputString", - "documentation":"

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + "documentation":"

A UTF-8 text string. The string must contain less than 100 KB of UTF-8 encoded characters.

" }, "LanguageCode":{ "shape":"LanguageCode", @@ -2259,7 +2341,7 @@ "members":{ "Text":{ "shape":"String", - "documentation":"

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + "documentation":"

A UTF-8 text string. The maximum string size is 100 KB.

" }, "LanguageCode":{ "shape":"LanguageCode", @@ -2285,7 +2367,7 @@ "members":{ "Text":{ "shape":"CustomerInputString", - "documentation":"

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

" + "documentation":"

A UTF-8 text string. The maximum string size is 5 KB.

Amazon Comprehend performs real-time sentiment analysis on the first 500 characters of the input text and ignores any additional text in the input.

" }, "LanguageCode":{ "shape":"LanguageCode", @@ -2316,7 +2398,7 @@ "members":{ "Text":{ "shape":"CustomerInputString", - "documentation":"

A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded characters.

" + "documentation":"

A UTF-8 string. The maximum string size is 5 KB.

" }, "LanguageCode":{ "shape":"SyntaxLanguageCode", @@ -2329,7 +2411,34 @@ "members":{ "SyntaxTokens":{ "shape":"ListOfSyntaxTokens", - "documentation":"

A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see how-syntax.

" + "documentation":"

A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see Syntax in the Comprehend Developer Guide.

" + } + }, + "sensitive":true + }, + "DetectTargetedSentimentRequest":{ + "type":"structure", + "required":[ + "Text", + "LanguageCode" + ], + "members":{ + "Text":{ + "shape":"CustomerInputString", + "documentation":"

A UTF-8 text string. The maximum string length is 5 KB.

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

The language of the input documents. Currently, English is the only supported language.

" + } + } + }, + "DetectTargetedSentimentResponse":{ + "type":"structure", + "members":{ + "Entities":{ + "shape":"ListOfTargetedSentimentEntities", + "documentation":"

Targeted sentiment analysis for each of the entities identified in the input text.

" } }, "sensitive":true @@ -2488,7 +2597,7 @@ }, "TestS3Uri":{ "shape":"S3Uri", - "documentation":"

The Amazon S3 URI for the input data. The Amazon S3 bucket must be in the same AWS Region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of input files.

" + "documentation":"

This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.

" }, "LabelDelimiter":{ "shape":"LabelDelimiter", @@ -2499,7 +2608,7 @@ "documentation":"

A list of augmented manifest files that provide training data for your custom model. An augmented manifest file is a labeled dataset that is produced by Amazon SageMaker Ground Truth.

This parameter is required if you set DataFormat to AUGMENTED_MANIFEST.

" } }, - "documentation":"

The input properties for training a document classifier.

For more information on how the input file is formatted, see prep-classifier-data.

" + "documentation":"

The input properties for training a document classifier.

For more information on how the input file is formatted, see Preparing training data in the Comprehend Developer Guide.

" }, "DocumentClassifierMode":{ "type":"string", @@ -2975,11 +3084,11 @@ }, "BeginOffset":{ "shape":"Integer", - "documentation":"

A character offset in the input text that shows where the entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

" + "documentation":"

The zero-based offset from the beginning of the source text to the first character in the entity.

" }, "EndOffset":{ "shape":"Integer", - "documentation":"

A character offset in the input text that shows where the entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

" + "documentation":"

The zero-based offset from the beginning of the source text to the last character in the entity.

" } }, "documentation":"

Provides information about an entity.

" @@ -3008,7 +3117,7 @@ }, "TestS3Uri":{ "shape":"S3Uri", - "documentation":"

This specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same AWS Region as the API endpoint that you are calling.

" + "documentation":"

Specifies the Amazon S3 location where the test annotations for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

" } }, "documentation":"

Describes the annotations associated with a entity recognizer.

" @@ -3568,11 +3677,11 @@ }, "BeginOffset":{ "shape":"Integer", - "documentation":"

A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

" + "documentation":"

The zero-based offset from the beginning of the source text to the first character in the key phrase.

" }, "EndOffset":{ "shape":"Integer", - "documentation":"

A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

" + "documentation":"

The zero-based offset from the beginning of the source text to the last character in the key phrase.

" } }, "documentation":"

Describes a key noun phrase.

" @@ -3993,6 +4102,10 @@ "type":"list", "member":{"shape":"DocumentClass"} }, + "ListOfDescriptiveMentionIndices":{ + "type":"list", + "member":{"shape":"Integer"} + }, "ListOfDetectDominantLanguageResult":{ "type":"list", "member":{"shape":"BatchDetectDominantLanguageItemResult"} @@ -4013,6 +4126,10 @@ "type":"list", "member":{"shape":"BatchDetectSyntaxItemResult"} }, + "ListOfDetectTargetedSentimentResult":{ + "type":"list", + "member":{"shape":"BatchDetectTargetedSentimentItemResult"} + }, "ListOfDocumentReadFeatureTypes":{ "type":"list", "member":{"shape":"DocumentReadFeatureTypes"}, @@ -4039,6 +4156,10 @@ "type":"list", "member":{"shape":"DocumentLabel"} }, + "ListOfMentions":{ + "type":"list", + "member":{"shape":"TargetedSentimentMention"} + }, "ListOfPiiEntities":{ "type":"list", "member":{"shape":"PiiEntity"} @@ -4051,6 +4172,10 @@ "type":"list", "member":{"shape":"SyntaxToken"} }, + "ListOfTargetedSentimentEntities":{ + "type":"list", + "member":{"shape":"TargetedSentimentEntity"} + }, "ListPiiEntitiesDetectionJobsRequest":{ "type":"structure", "members":{ @@ -4205,6 +4330,17 @@ "max":500, "min":1 }, + "MentionSentiment":{ + "type":"structure", + "members":{ + "Sentiment":{ + "shape":"SentimentType", + "documentation":"

The sentiment of the mention.

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

Contains the sentiment and sentiment score for one mention of an entity.

For more information about targeted sentiment, see Targeted sentiment.

" + }, "ModelStatus":{ "type":"string", "enum":[ @@ -4249,7 +4385,7 @@ "documentation":"

The confidence that Amazon Comprehend has that the part of speech was correctly identified.

" } }, - "documentation":"

Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see how-syntax.

" + "documentation":"

Identifies the part of speech represented by the token and gives the confidence that Amazon Comprehend has that the part of speech was correctly identified. For more information about the parts of speech that Amazon Comprehend can identify, see Syntax in the Comprehend Developer Guide.

" }, "PartOfSpeechTagType":{ "type":"string", @@ -4385,11 +4521,11 @@ }, "BeginOffset":{ "shape":"Integer", - "documentation":"

A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

" + "documentation":"

The zero-based offset from the beginning of the source text to the first character in the entity.

" }, "EndOffset":{ "shape":"Integer", - "documentation":"

A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

" + "documentation":"

The zero-based offset from the beginning of the source text to the last character in the entity.

" } }, "documentation":"

Provides information about a PII entity.

" @@ -5157,7 +5293,7 @@ }, "LanguageCode":{ "shape":"LanguageCode", - "documentation":"

The language of the input documents. Currently, English is the only valid language.

" + "documentation":"

The language of the input documents. Currently, English is the only supported language.

" }, "ClientRequestToken":{ "shape":"ClientRequestTokenString", @@ -5495,7 +5631,7 @@ }, "PartOfSpeech":{ "shape":"PartOfSpeechTag", - "documentation":"

Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see how-syntax.

" + "documentation":"

Provides the part of speech label and the confidence level that Amazon Comprehend has that the part of speech was correctly identified. For more information, see Syntax in the Comprehend Developer Guide.

" } }, "documentation":"

Represents a work in the input text that was recognized and assigned a part of speech. There is one syntax token record for each word in the source text.

" @@ -5635,6 +5771,76 @@ "type":"list", "member":{"shape":"TargetedSentimentDetectionJobProperties"} }, + "TargetedSentimentEntity":{ + "type":"structure", + "members":{ + "DescriptiveMentionIndex":{ + "shape":"ListOfDescriptiveMentionIndices", + "documentation":"

One or more index into the Mentions array that provides the best name for the entity group.

" + }, + "Mentions":{ + "shape":"ListOfMentions", + "documentation":"

An array of mentions of the entity in the document. The array represents a co-reference group. See Co-reference group for an example.

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

Information about one of the entities found by targeted sentiment analysis.

For more information about targeted sentiment, see Targeted sentiment.

" + }, + "TargetedSentimentEntityType":{ + "type":"string", + "enum":[ + "PERSON", + "LOCATION", + "ORGANIZATION", + "FACILITY", + "BRAND", + "COMMERCIAL_ITEM", + "MOVIE", + "MUSIC", + "BOOK", + "SOFTWARE", + "GAME", + "PERSONAL_TITLE", + "EVENT", + "DATE", + "QUANTITY", + "ATTRIBUTE", + "OTHER" + ] + }, + "TargetedSentimentMention":{ + "type":"structure", + "members":{ + "Score":{ + "shape":"Float", + "documentation":"

Model confidence that the entity is relevant. Value range is zero to one, where one is highest confidence.

" + }, + "GroupScore":{ + "shape":"Float", + "documentation":"

The confidence that all the entities mentioned in the group relate to the same entity.

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

The text in the document that identifies the entity.

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

The type of the entity. Amazon Comprehend supports a variety of entity types.

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

Contains the sentiment and sentiment score for the mention.

" + }, + "BeginOffset":{ + "shape":"Integer", + "documentation":"

The offset into the document text where the mention begins.

" + }, + "EndOffset":{ + "shape":"Integer", + "documentation":"

The offset into the document text where the mention ends.

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

Information about one mention of an entity. The mention information includes the location of the mention in the text and the sentiment of the mention.

For more information about targeted sentiment, see Targeted sentiment.

" + }, "TextSizeLimitExceededException":{ "type":"structure", "members":{ @@ -5757,7 +5963,7 @@ "members":{ "Message":{"shape":"String"} }, - "documentation":"

Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, see supported-languages.

", + "documentation":"

Amazon Comprehend can't process the language of the input text. For custom entity recognition APIs, only English, Spanish, French, Italian, German, or Portuguese are accepted. For a list of supported languages, Supported languages in the Comprehend Developer Guide.

", "exception":true }, "UntagResourceRequest":{ diff --git a/awscli/botocore/data/devicefarm/2015-06-23/service-2.json b/awscli/botocore/data/devicefarm/2015-06-23/service-2.json index 030273b50cf5..14a5d1e4cb31 100644 --- a/awscli/botocore/data/devicefarm/2015-06-23/service-2.json +++ b/awscli/botocore/data/devicefarm/2015-06-23/service-2.json @@ -1278,7 +1278,7 @@ }, "skipAppResign":{ "shape":"SkipAppResign", - "documentation":"

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

" + "documentation":"

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

" } }, "documentation":"

A container for account-level settings in AWS Device Farm.

" @@ -1612,6 +1612,10 @@ "defaultJobTimeoutMinutes":{ "shape":"JobTimeoutMinutes", "documentation":"

Sets the execution timeout value (in minutes) for a project. All test runs in this project use the specified execution timeout value unless overridden when scheduling a run.

" + }, + "vpcConfig":{ + "shape":"VpcConfig", + "documentation":"

The VPC security groups and subnets that are attached to a project.

" } }, "documentation":"

Represents a request to the create project operation.

" @@ -1693,7 +1697,7 @@ }, "skipAppResign":{ "shape":"Boolean", - "documentation":"

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information on how Device Farm modifies your uploads during tests, see Do you modify my app?

" + "documentation":"

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information on how Device Farm modifies your uploads during tests, see Do you modify my app?

" } }, "documentation":"

Creates and submits a request to start a remote access session.

" @@ -2372,7 +2376,7 @@ }, "skipAppResign":{ "shape":"SkipAppResign", - "documentation":"

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

" + "documentation":"

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

" } }, "documentation":"

Represents configuration information about a test run, such as the execution timeout (in minutes).

" @@ -4098,6 +4102,10 @@ "created":{ "shape":"DateTime", "documentation":"

When the project was created.

" + }, + "vpcConfig":{ + "shape":"VpcConfig", + "documentation":"

The VPC security groups and subnets that are attached to a project.

" } }, "documentation":"

Represents an operating-system neutral workspace for running and managing tests.

" @@ -4272,7 +4280,11 @@ }, "skipAppResign":{ "shape":"SkipAppResign", - "documentation":"

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

" + "documentation":"

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

" + }, + "vpcConfig":{ + "shape":"VpcConfig", + "documentation":"

The VPC security groups and subnets that are attached to a project.

" } }, "documentation":"

Represents information about the remote access session.

" @@ -4493,7 +4505,7 @@ }, "skipAppResign":{ "shape":"SkipAppResign", - "documentation":"

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

" + "documentation":"

When set to true, for private devices, Device Farm does not sign your app again. For public devices, Device Farm always signs your apps again.

For more information about how Device Farm re-signs your apps, see Do you modify my app? in the AWS Device Farm FAQs.

" }, "testSpecArn":{ "shape":"AmazonResourceName", @@ -4502,6 +4514,10 @@ "deviceSelectionResult":{ "shape":"DeviceSelectionResult", "documentation":"

The results of a device filter used to select the devices for a test run.

" + }, + "vpcConfig":{ + "shape":"VpcConfig", + "documentation":"

The VPC security groups and subnets that are attached to a project.

" } }, "documentation":"

Represents a test run on a set of devices with a given app package, test parameters, and so on.

" @@ -4675,6 +4691,12 @@ }, "documentation":"

Represents test settings. This data structure is passed in as the test parameter to ScheduleRun. For an example of the JSON request syntax, see ScheduleRun.

" }, + "SecurityGroupId":{ + "type":"string", + "max":4096, + "min":1, + "pattern":"^sg-[0-9a-fA-F]{8,}$" + }, "SecurityGroupIds":{ "type":"list", "member":{"shape":"NonEmptyString"}, @@ -4775,6 +4797,12 @@ "documentation":"

Represents the results of your stop run attempt.

" }, "String":{"type":"string"}, + "SubnetId":{ + "type":"string", + "max":4096, + "min":1, + "pattern":"^subnet-[0-9a-fA-F]{8,}$" + }, "SubnetIds":{ "type":"list", "member":{"shape":"NonEmptyString"}, @@ -5427,6 +5455,10 @@ "defaultJobTimeoutMinutes":{ "shape":"JobTimeoutMinutes", "documentation":"

The number of minutes a test run in the project executes before it times out.

" + }, + "vpcConfig":{ + "shape":"VpcConfig", + "documentation":"

The VPC security groups and subnets that are attached to a project.

" } }, "documentation":"

Represents a request to the update project operation.

" @@ -5686,7 +5718,42 @@ "max":2048, "min":0 }, - "VideoCapture":{"type":"boolean"} + "VideoCapture":{"type":"boolean"}, + "VpcConfig":{ + "type":"structure", + "required":[ + "securityGroupIds", + "subnetIds", + "vpcId" + ], + "members":{ + "securityGroupIds":{ + "shape":"VpcSecurityGroupIds", + "documentation":"

An array of one or more security groups IDs in your Amazon VPC.

" + }, + "subnetIds":{ + "shape":"VpcSubnetIds", + "documentation":"

An array of one or more subnet IDs in your Amazon VPC.

" + }, + "vpcId":{ + "shape":"NonEmptyString", + "documentation":"

The ID of the Amazon VPC.

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

Contains the VPC configuration data necessary to interface with AWS Device Farm's services.

" + }, + "VpcSecurityGroupIds":{ + "type":"list", + "member":{"shape":"SecurityGroupId"}, + "max":5, + "min":1 + }, + "VpcSubnetIds":{ + "type":"list", + "member":{"shape":"SubnetId"}, + "max":8, + "min":1 + } }, "documentation":"

Welcome to the AWS Device Farm API documentation, which contains APIs for:

" } diff --git a/awscli/botocore/data/ec2/2016-11-15/service-2.json b/awscli/botocore/data/ec2/2016-11-15/service-2.json index 1abfce1c3985..3d81421f8148 100644 --- a/awscli/botocore/data/ec2/2016-11-15/service-2.json +++ b/awscli/botocore/data/ec2/2016-11-15/service-2.json @@ -90,7 +90,7 @@ }, "input":{"shape":"AllocateAddressRequest"}, "output":{"shape":"AllocateAddressResult"}, - "documentation":"

Allocates an Elastic IP address to your Amazon Web Services 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 Amazon Web Services account.

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own 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 Amazon Web Services 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.

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Allocates an Elastic IP address to your Amazon Web Services 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 Amazon Web Services account.

You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own 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 Amazon Web Services 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.

You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" }, "AllocateHosts":{ "name":"AllocateHosts", @@ -150,7 +150,7 @@ }, "input":{"shape":"AssociateAddressRequest"}, "output":{"shape":"AssociateAddressResult"}, - "documentation":"

Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.

You cannot associate an Elastic IP address with an interface in a different network border group.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

[EC2-Classic, VPC in an EC2-VPC-only account] If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account.

[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.

[Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface.

You cannot associate an Elastic IP address with an interface in a different network border group.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" }, "AssociateClientVpnTargetNetwork":{ "name":"AssociateClientVpnTargetNetwork", @@ -179,7 +179,7 @@ }, "input":{"shape":"AssociateEnclaveCertificateIamRoleRequest"}, "output":{"shape":"AssociateEnclaveCertificateIamRoleResult"}, - "documentation":"

Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.

When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 bucket that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.

To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide.

" + "documentation":"

Associates an Identity and Access Management (IAM) role with an Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see Certificate Manager for Nitro Enclaves in the Amazon Web Services Nitro Enclaves User Guide.

When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate is encrypted with an Amazon Web Services managed key that has an attached attestation-based key policy.

To enable the IAM role to access the Amazon S3 object, you must grant it permission to call s3:GetObject on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call kms:Decrypt on the KMS key returned by the command. For more information, see Grant the role permission to access the certificate and encryption key in the Amazon Web Services Nitro Enclaves User Guide.

" }, "AssociateIamInstanceProfile":{ "name":"AssociateIamInstanceProfile", @@ -348,7 +348,7 @@ }, "input":{"shape":"AuthorizeSecurityGroupIngressRequest"}, "output":{"shape":"AuthorizeSecurityGroupIngressResult"}, - "documentation":"

Adds the specified inbound (ingress) rules to a security group.

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups. When specifying an inbound rule for your security group in a VPC, the IpPermissions must include a source for the traffic.

You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

For more information about VPC security group quotas, see Amazon VPC quotas.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Adds the specified inbound (ingress) rules to a security group.

An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups. When specifying an inbound rule for your security group in a VPC, the IpPermissions must include a source for the traffic.

You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

For more information about VPC security group quotas, see Amazon VPC quotas.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" }, "BundleInstance":{ "name":"BundleInstance", @@ -845,7 +845,7 @@ }, "input":{"shape":"CreateNetworkInterfaceRequest"}, "output":{"shape":"CreateNetworkInterfaceResult"}, - "documentation":"

Creates a network interface in the specified subnet.

For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.

" + "documentation":"

Creates a network interface in the specified subnet.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.

For more information about network interfaces, see Elastic network interfaces in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateNetworkInterfacePermission":{ "name":"CreateNetworkInterfacePermission", @@ -935,7 +935,7 @@ }, "input":{"shape":"CreateSecurityGroupRequest"}, "output":{"shape":"CreateSecurityGroupResult"}, - "documentation":"

Creates a security group.

A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

For more information about VPC security group limits, see Amazon VPC Limits.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Creates a security group.

A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.

When you create a security group, you specify a friendly name of your choice. You can have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.

You have a default security group for use in EC2-Classic and a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other.

You can add or remove rules from your security groups using AuthorizeSecurityGroupIngress, AuthorizeSecurityGroupEgress, RevokeSecurityGroupIngress, and RevokeSecurityGroupEgress.

For more information about VPC security group limits, see Amazon VPC Limits.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" }, "CreateSnapshot":{ "name":"CreateSnapshot", @@ -955,7 +955,7 @@ }, "input":{"shape":"CreateSnapshotsRequest"}, "output":{"shape":"CreateSnapshotsResult"}, - "documentation":"

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance. Boot volumes can be excluded by changing the parameters.

You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.

" + "documentation":"

Creates crash-consistent snapshots of multiple EBS volumes and stores the data in S3. Volumes are chosen by specifying an instance. Any attached volumes will produce one snapshot each that is crash-consistent across the instance.

You can include all of the volumes currently attached to the instance, or you can exclude the root volume or specific data (non-root) volumes from the multi-volume snapshot set.

You can create multi-volume snapshots of instances in a Region and instances on an Outpost. If you create snapshots from an instance in a Region, the snapshots must be stored in the same Region as the instance. If you create snapshots from an instance on an Outpost, the snapshots can be stored on the same Outpost as the instance, or in the Region for that Outpost.

" }, "CreateSpotDatafeedSubscription":{ "name":"CreateSpotDatafeedSubscription", @@ -1622,7 +1622,7 @@ "requestUri":"/" }, "input":{"shape":"DeleteSecurityGroupRequest"}, - "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Deletes a security group.

If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" }, "DeleteSnapshot":{ "name":"DeleteSnapshot", @@ -1992,7 +1992,7 @@ }, "input":{"shape":"DescribeAddressesRequest"}, "output":{"shape":"DescribeAddressesResult"}, - "documentation":"

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Describes the specified Elastic IP addresses or all of your Elastic IP addresses.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeAddressesAttribute":{ "name":"DescribeAddressesAttribute", @@ -2882,7 +2882,7 @@ }, "input":{"shape":"DescribeSecurityGroupsRequest"}, "output":{"shape":"DescribeSecurityGroupsResult"}, - "documentation":"

Describes the specified security groups or all of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Describes the specified security groups or all of your security groups.

A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. For more information, see Amazon EC2 security groups in the Amazon Elastic Compute Cloud User Guide and Security groups for your VPC in the Amazon Virtual Private Cloud User Guide.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" }, "DescribeSnapshotAttribute":{ "name":"DescribeSnapshotAttribute", @@ -3477,7 +3477,7 @@ "requestUri":"/" }, "input":{"shape":"DisassociateAddressRequest"}, - "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" + "documentation":"

Disassociates an Elastic IP address from the instance or network interface it's associated with.

An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.

" }, "DisassociateClientVpnTargetNetwork":{ "name":"DisassociateClientVpnTargetNetwork", @@ -4124,7 +4124,7 @@ }, "input":{"shape":"ImportImageRequest"}, "output":{"shape":"ImportImageResult"}, - "documentation":"

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.

" + "documentation":"

Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI).

Amazon Web Services VM Import/Export strongly recommends specifying a value for either the --license-type or --usage-operation parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized.

For more information, see Importing a VM as an image using VM Import/Export in the VM Import/Export User Guide.

" }, "ImportInstance":{ "name":"ImportInstance", @@ -4755,7 +4755,7 @@ }, "input":{"shape":"MoveAddressToVpcRequest"}, "output":{"shape":"MoveAddressToVpcResult"}, - "documentation":"

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform, unless you move it back using the RestoreAddressToClassic request. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" }, "MoveByoipCidrToIpam":{ "name":"MoveByoipCidrToIpam", @@ -4933,7 +4933,7 @@ "requestUri":"/" }, "input":{"shape":"ReleaseAddressRequest"}, - "documentation":"

Releases the specified Elastic IP address.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Releases the specified Elastic IP address.

[EC2-Classic, default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. To disassociate an Elastic IP address without releasing it, use DisassociateAddress.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

[Nondefault VPC] You must use DisassociateAddress to disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (InvalidIPAddress.InUse).

After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an AuthFailure error if the address is already allocated to another Amazon Web Services account.

[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.

For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.

" }, "ReleaseHosts":{ "name":"ReleaseHosts", @@ -5116,7 +5116,7 @@ }, "input":{"shape":"RestoreAddressToClassicRequest"}, "output":{"shape":"RestoreAddressToClassicResult"}, - "documentation":"

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" }, "RestoreImageFromRecycleBin":{ "name":"RestoreImageFromRecycleBin", @@ -5186,7 +5186,7 @@ }, "input":{"shape":"RevokeSecurityGroupIngressRequest"}, "output":{"shape":"RevokeSecurityGroupIngressResult"}, - "documentation":"

Removes the specified inbound (ingress) rules from a security group.

You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.

[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Removes the specified inbound (ingress) rules from a security group.

You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.

[EC2-Classic, default VPC] If the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.

Amazon Web Services recommends that you describe the security group to verify that the rules were removed.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" }, "RunInstances":{ "name":"RunInstances", @@ -6274,7 +6274,7 @@ }, "DisallowedCidrs":{ "shape":"IpamPoolAllocationDisallowedCidrs", - "documentation":"

Exclude a particular CIDR range from being returned by the pool.

", + "documentation":"

Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation.

", "locationName":"DisallowedCidr" } } @@ -6734,7 +6734,7 @@ }, "Ipv6Addresses":{ "shape":"Ipv6AddressList", - "documentation":"

One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

", + "documentation":"

The IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.

", "locationName":"ipv6Addresses" }, "Ipv6PrefixCount":{ @@ -6789,7 +6789,7 @@ }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressStringList", - "documentation":"

One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", + "documentation":"

The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.

If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.

", "locationName":"privateIpAddress" }, "SecondaryPrivateIpAddressCount":{ @@ -7850,7 +7850,7 @@ }, "GroupName":{ "shape":"SecurityGroupName", - "documentation":"

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

" + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

" }, "IpPermissions":{ "shape":"IpPermissionList", @@ -12385,12 +12385,12 @@ }, "Ipv6AddressCount":{ "shape":"Integer", - "documentation":"

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.

", + "documentation":"

The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range.

You can't specify a count of IPv6 addresses using this parameter if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

If your subnet has the AssignIpv6AddressOnCreation attribute set, you can override that setting by specifying 0 as the IPv6 address count.

", "locationName":"ipv6AddressCount" }, "Ipv6Addresses":{ "shape":"InstanceIpv6AddressList", - "documentation":"

One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.

", + "documentation":"

The IPv6 addresses from the IPv6 CIDR block range of your subnet.

You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes.

", "locationName":"ipv6Addresses" }, "PrivateIpAddress":{ @@ -12400,31 +12400,31 @@ }, "PrivateIpAddresses":{ "shape":"PrivateIpAddressSpecificationList", - "documentation":"

One or more private IPv4 addresses.

", + "documentation":"

The private IPv4 addresses.

You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", "locationName":"privateIpAddresses" }, "SecondaryPrivateIpAddressCount":{ "shape":"Integer", - "documentation":"

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.

", + "documentation":"

The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using privateIpAddresses.

You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes.

", "locationName":"secondaryPrivateIpAddressCount" }, "Ipv4Prefixes":{ "shape":"Ipv4PrefixList", - "documentation":"

One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

", + "documentation":"

The IPv4 prefixes assigned to the network interface.

You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

", "locationName":"Ipv4Prefix" }, "Ipv4PrefixCount":{ "shape":"Integer", - "documentation":"

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv4 Prefixes option.

" + "documentation":"

The number of IPv4 prefixes that Amazon Web Services automatically assigns to the network interface.

You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses.

" }, "Ipv6Prefixes":{ "shape":"Ipv6PrefixList", - "documentation":"

One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

", + "documentation":"

The IPv6 prefixes assigned to the network interface.

You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

", "locationName":"Ipv6Prefix" }, "Ipv6PrefixCount":{ "shape":"Integer", - "documentation":"

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use the Ipv6Prefixes option.

" + "documentation":"

The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface.

You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses.

" }, "InterfaceType":{ "shape":"NetworkInterfaceCreationType", @@ -12445,8 +12445,7 @@ "documentation":"

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.

", "idempotencyToken":true } - }, - "documentation":"

Contains the parameters for CreateNetworkInterface.

" + } }, "CreateNetworkInterfaceResult":{ "type":"structure", @@ -12461,8 +12460,7 @@ "documentation":"

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

", "locationName":"clientToken" } - }, - "documentation":"

Contains the output of CreateNetworkInterface.

" + } }, "CreatePlacementGroupRequest":{ "type":"structure", @@ -15542,7 +15540,7 @@ }, "GroupName":{ "shape":"SecurityGroupName", - "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID.

" + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, you must specify the security group ID.

" }, "DryRun":{ "shape":"Boolean", @@ -18210,7 +18208,7 @@ }, "IncludeDeprecated":{ "shape":"Boolean", - "documentation":"

If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of the value (true or false) that you set for this parameter.

" + "documentation":"

Specifies whether to include deprecated AMIs.

Default: No deprecated AMIs are included in the response.

If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.

" }, "DryRun":{ "shape":"Boolean", @@ -19678,7 +19676,7 @@ "members":{ "NetworkInterfacePermissionIds":{ "shape":"NetworkInterfacePermissionIdList", - "documentation":"

One or more network interface permission IDs.

", + "documentation":"

The network interface permission IDs.

", "locationName":"NetworkInterfacePermissionId" }, "Filters":{ @@ -19733,7 +19731,7 @@ }, "NetworkInterfaceIds":{ "shape":"NetworkInterfaceIdList", - "documentation":"

One or more network interface IDs.

Default: Describes all your network interfaces.

", + "documentation":"

The network interface IDs.

Default: Describes all your network interfaces.

", "locationName":"NetworkInterfaceId" }, "NextToken":{ @@ -23686,7 +23684,8 @@ }, "KmsKeyId":{ "shape":"String", - "documentation":"

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

" + "documentation":"

Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.

This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.

", + "locationName":"kmsKeyId" }, "Throughput":{ "shape":"Integer", @@ -29055,7 +29054,7 @@ }, "LicenseType":{ "shape":"String", - "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing.

By default, we detect the source-system operating system (OS) and apply the appropriate license. Specify AWS to replace the source-system license with an Amazon Web Services license, if appropriate. Specify BYOL to retain the source-system license, if appropriate.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.

" + "documentation":"

The license type to be used for the Amazon Machine Image (AMI) after importing.

Specify AWS to replace the source-system license with an Amazon Web Services license or BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing AWS when importing a Windows Server operating system, and the same as choosing BYOL when importing a Windows client operating system (such as Windows 10) or a Linux operating system.

To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.

" }, "Platform":{ "shape":"String", @@ -30848,12 +30847,12 @@ }, "Groups":{ "shape":"GroupIdentifierList", - "documentation":"

One or more security groups.

", + "documentation":"

The security groups.

", "locationName":"groupSet" }, "Ipv6Addresses":{ "shape":"InstanceIpv6AddressList", - "documentation":"

One or more IPv6 addresses associated with the network interface.

", + "documentation":"

The IPv6 addresses associated with the network interface.

", "locationName":"ipv6AddressesSet" }, "MacAddress":{ @@ -30883,7 +30882,7 @@ }, "PrivateIpAddresses":{ "shape":"InstancePrivateIpAddressList", - "documentation":"

One or more private IPv4 addresses associated with the network interface.

", + "documentation":"

The private IPv4 addresses associated with the network interface.

", "locationName":"privateIpAddressesSet" }, "SourceDestCheck":{ @@ -31033,7 +31032,7 @@ }, "Ipv6Addresses":{ "shape":"InstanceIpv6AddressList", - "documentation":"

One or more IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

", + "documentation":"

The IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.

", "locationName":"ipv6AddressesSet", "queryName":"Ipv6Addresses" }, @@ -31049,7 +31048,7 @@ }, "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":"

The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a RunInstances request.

", "locationName":"privateIpAddressesSet", "queryName":"PrivateIpAddresses" }, @@ -31077,7 +31076,7 @@ }, "Ipv4Prefixes":{ "shape":"Ipv4PrefixList", - "documentation":"

One or more IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

", + "documentation":"

The IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv4PrefixCount option.

", "locationName":"Ipv4Prefix" }, "Ipv4PrefixCount":{ @@ -31086,7 +31085,7 @@ }, "Ipv6Prefixes":{ "shape":"Ipv6PrefixList", - "documentation":"

One or more IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

", + "documentation":"

The IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.

", "locationName":"Ipv6Prefix" }, "Ipv6PrefixCount":{ @@ -31236,7 +31235,7 @@ }, "AcceleratorNames":{ "shape":"AcceleratorNameSet", - "documentation":"

The accelerators that must be on the instance type.

Default: Any accelerator

", + "documentation":"

The accelerators that must be on the instance type.

Default: Any accelerator

", "locationName":"acceleratorNameSet" }, "AcceleratorTotalMemoryMiB":{ @@ -31338,7 +31337,7 @@ }, "AcceleratorNames":{ "shape":"AcceleratorNameSet", - "documentation":"

The accelerators that must be on the instance type.

Default: Any accelerator

", + "documentation":"

The accelerators that must be on the instance type.

Default: Any accelerator

", "locationName":"AcceleratorName" }, "AcceleratorTotalMemoryMiB":{ @@ -31381,6 +31380,7 @@ }, "ExcludeDataVolumeIds":{ "shape":"VolumeIdStringList", + "documentation":"

The IDs of the data (non-root) volumes to exclude from the multi-volume snapshot set. If you specify the ID of the root volume, the request fails. To exclude the root volume, use ExcludeBootVolume.

You can specify up to 40 volume IDs per request.

", "locationName":"ExcludeDataVolumeId" } }, @@ -33388,7 +33388,7 @@ "members":{ "Ipv4Prefix":{ "shape":"String", - "documentation":"

One or more IPv4 delegated prefixes assigned to the network interface.

", + "documentation":"

The IPv4 delegated prefixes assigned to the network interface.

", "locationName":"ipv4Prefix" } }, @@ -33537,7 +33537,7 @@ "members":{ "Ipv6Prefix":{ "shape":"String", - "documentation":"

One or more IPv6 delegated prefixes assigned to the network interface.

", + "documentation":"

The IPv6 delegated prefixes assigned to the network interface.

", "locationName":"ipv6Prefix" } }, @@ -36417,7 +36417,7 @@ }, "Attribute":{ "shape":"InstanceAttributeName", - "documentation":"

The name of the attribute.

", + "documentation":"

The name of the attribute to modify.

You can modify the following attributes only: disableApiTermination | instanceType | kernel | ramdisk | instanceInitiatedShutdownBehavior | blockDeviceMapping | userData | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport | nvmeSupport | disableApiStop | enclaveOptions

", "locationName":"attribute" }, "BlockDeviceMappings":{ @@ -37556,7 +37556,7 @@ }, "AmazonSideAsn":{ "shape":"Long", - "documentation":"

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

" + "documentation":"

A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.

The modify ASN operation is not allowed on a transit gateway with active BGP sessions. You must first delete all transit gateway attachments that have BGP configured prior to modifying the ASN on the transit gateway.

" } }, "documentation":"

The transit gateway options.

" @@ -38437,7 +38437,7 @@ "locationName":"publicIp" } }, - "documentation":"

Describes the status of a moving Elastic IP address.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Describes the status of a moving Elastic IP address.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" }, "MovingAddressStatusSet":{ "type":"list", @@ -40886,7 +40886,7 @@ }, "PrivateIpAddress":{ "shape":"String", - "documentation":"

The private IPv4 addresses.

", + "documentation":"

The private IPv4 address.

", "locationName":"privateIpAddress" } }, @@ -42562,7 +42562,7 @@ }, "InstanceType":{ "shape":"InstanceType", - "documentation":"

The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.

If you specify InstanceTypes, you can't specify InstanceRequirements.

" + "documentation":"

The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.

If you specify InstanceType, you can't specify InstanceRequirements.

" }, "KeyName":{ "shape":"KeyPairName", @@ -44296,7 +44296,7 @@ }, "GroupName":{ "shape":"SecurityGroupName", - "documentation":"

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

" + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

" }, "IpPermissions":{ "shape":"IpPermissionList", @@ -50759,7 +50759,7 @@ }, "Ipv6Prefixes":{ "shape":"IpPrefixList", - "documentation":"

One or more IPv6 prefixes to unassign from the network interface.

", + "documentation":"

The IPv6 prefixes to unassign from the network interface.

", "locationName":"Ipv6Prefix" }, "NetworkInterfaceId":{ @@ -50989,7 +50989,7 @@ }, "GroupName":{ "shape":"SecurityGroupName", - "documentation":"

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.

" + "documentation":"

[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.

" }, "IpPermissions":{ "shape":"IpPermissionList", @@ -51114,7 +51114,7 @@ "locationName":"vpcPeeringConnectionId" } }, - "documentation":"

Describes a security group and Amazon Web Services account ID pair.

We are retiring EC2-Classic on August 15, 2022. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" + "documentation":"

Describes a security group and Amazon Web Services account ID pair.

We are retiring EC2-Classic. We recommend that you migrate from EC2-Classic to a VPC. For more information, see Migrate from EC2-Classic to a VPC in the Amazon Elastic Compute Cloud User Guide.

" }, "UserIdGroupPairList":{ "type":"list", diff --git a/awscli/botocore/data/endpoints.json b/awscli/botocore/data/endpoints.json index 6eb0c9ab10cf..ddf358455b5e 100644 --- a/awscli/botocore/data/endpoints.json +++ b/awscli/botocore/data/endpoints.json @@ -3228,8 +3228,32 @@ "endpoints" : { "ap-southeast-2" : { }, "eu-west-2" : { }, - "us-east-1" : { }, - "us-west-2" : { } + "fips-us-east-1" : { + "credentialScope" : { + "region" : "us-east-1" + }, + "deprecated" : true, + "hostname" : "connect-campaigns-fips.us-east-1.amazonaws.com" + }, + "fips-us-west-2" : { + "credentialScope" : { + "region" : "us-west-2" + }, + "deprecated" : true, + "hostname" : "connect-campaigns-fips.us-west-2.amazonaws.com" + }, + "us-east-1" : { + "variants" : [ { + "hostname" : "connect-campaigns-fips.us-east-1.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, + "us-west-2" : { + "variants" : [ { + "hostname" : "connect-campaigns-fips.us-west-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + } } }, "contact-lens" : { @@ -4151,6 +4175,7 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, @@ -5476,6 +5501,8 @@ "emr-serverless" : { "endpoints" : { "ap-northeast-1" : { }, + "ap-southeast-1" : { }, + "eu-central-1" : { }, "eu-west-1" : { }, "fips-us-east-1" : { "credentialScope" : { @@ -5484,6 +5511,13 @@ "deprecated" : true, "hostname" : "emr-serverless-fips.us-east-1.amazonaws.com" }, + "fips-us-east-2" : { + "credentialScope" : { + "region" : "us-east-2" + }, + "deprecated" : true, + "hostname" : "emr-serverless-fips.us-east-2.amazonaws.com" + }, "fips-us-west-2" : { "credentialScope" : { "region" : "us-west-2" @@ -5497,6 +5531,12 @@ "tags" : [ "fips" ] } ] }, + "us-east-2" : { + "variants" : [ { + "hostname" : "emr-serverless-fips.us-east-2.amazonaws.com", + "tags" : [ "fips" ] + } ] + }, "us-west-2" : { "variants" : [ { "hostname" : "emr-serverless-fips.us-west-2.amazonaws.com", @@ -10247,6 +10287,7 @@ "ap-south-1" : { }, "ap-southeast-1" : { }, "ap-southeast-2" : { }, + "ap-southeast-3" : { }, "ca-central-1" : { "variants" : [ { "hostname" : "rbin-fips.ca-central-1.amazonaws.com", diff --git a/awscli/botocore/data/glue/2017-03-31/service-2.json b/awscli/botocore/data/glue/2017-03-31/service-2.json index b5aa89a7dff9..c223ad2a12be 100644 --- a/awscli/botocore/data/glue/2017-03-31/service-2.json +++ b/awscli/botocore/data/glue/2017-03-31/service-2.json @@ -4409,6 +4409,14 @@ "ConnectionName":{ "shape":"ConnectionName", "documentation":"

The name of the connection for an Amazon S3-backed Data Catalog table to be a target of the crawl when using a Catalog connection type paired with a NETWORK Connection type.

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

A valid Amazon SQS ARN. For example, arn:aws:sqs:region:account:sqs.

" + }, + "DlqEventQueueArn":{ + "shape":"EventQueueArn", + "documentation":"

A valid Amazon dead-letter SQS ARN. For example, arn:aws:sqs:region:account:deadLetterQueue.

" } }, "documentation":"

Specifies an Glue Data Catalog target.

" diff --git a/awscli/botocore/data/identitystore/2020-06-15/service-2.json b/awscli/botocore/data/identitystore/2020-06-15/service-2.json index e748555919c4..b43f35f9da54 100644 --- a/awscli/botocore/data/identitystore/2020-06-15/service-2.json +++ b/awscli/botocore/data/identitystore/2020-06-15/service-2.json @@ -296,7 +296,7 @@ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], - "documentation":"

Lists the attribute name and value of the group that you specified in the search. We only support DisplayName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including GroupId and group DisplayName in the response.

" + "documentation":"

Lists all groups in the identity store. Returns a paginated list of complete Group objects. Filtering for a Group by the DisplayName attribute is deprecated. Instead, use the GetGroupId API action.

" }, "ListUsers":{ "name":"ListUsers", @@ -313,7 +313,7 @@ {"shape":"InternalServerException"}, {"shape":"ValidationException"} ], - "documentation":"

Lists the attribute name and value of the user that you specified in the search. We only support UserName as a valid filter attribute path currently, and filter is required. This API returns minimum attributes, including UserId and UserName in the response.

" + "documentation":"

Lists all users in the identity store. Returns a paginated list of complete User objects. Filtering for a User by the UserName attribute is deprecated. Instead, use the GetUserId API action.

" }, "UpdateGroup":{ "name":"UpdateGroup", @@ -423,7 +423,7 @@ "documentation":"

An entity attribute that's unique to a specific entity.

" } }, - "documentation":"

A unique identifier for a user or group that is not the its primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a unique GroupDisplayName.

", + "documentation":"

A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a unique GroupDisplayName.

", "union":true }, "AttributeOperation":{ @@ -773,7 +773,7 @@ }, "DisplayName":{ "shape":"GroupDisplayName", - "documentation":"

The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. The characters <>;:% are excluded. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.

" + "documentation":"

The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time that the group is created and stored as an attribute of the group object in the identity store.

" }, "ExternalIds":{ "shape":"ExternalIds", @@ -979,7 +979,7 @@ }, "AlternateIdentifier":{ "shape":"AlternateIdentifier", - "documentation":"

A unique identifier for an identity resource that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the group or a unique attribute. For example, a unique GroupDisplayName.

" + "documentation":"

A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a unique GroupDisplayName.

" } } }, @@ -1052,7 +1052,7 @@ }, "AlternateIdentifier":{ "shape":"AlternateIdentifier", - "documentation":"

A unique identifier for an identity resource that is not the primary identifier.

" + "documentation":"

A unique identifier for a user or group that is not the primary identifier. This value can be an identifier from an external identity provider (IdP) that is associated with the user, the group, or a unique attribute. For example, a unique UserDisplayName.

" } } }, @@ -1086,7 +1086,7 @@ }, "DisplayName":{ "shape":"GroupDisplayName", - "documentation":"

The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. The characters <>;:% are excluded. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

" + "documentation":"

The group’s display name value. The length limit is 1,024 characters. This value can consist of letters, accented characters, symbols, numbers, punctuation, tab, new line, carriage return, space, and nonbreaking space in this attribute. This value is specified at the time the group is created and stored as an attribute of the group object in the identity store.

" }, "ExternalIds":{ "shape":"ExternalIds", diff --git a/awscli/botocore/data/s3control/2018-08-20/service-2.json b/awscli/botocore/data/s3control/2018-08-20/service-2.json index d712b5d4ba51..f6a3c71e84a1 100644 --- a/awscli/botocore/data/s3control/2018-08-20/service-2.json +++ b/awscli/botocore/data/s3control/2018-08-20/service-2.json @@ -23,7 +23,7 @@ "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, "output":{"shape":"CreateAccessPointResult"}, - "documentation":"

Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.

S3 on Outposts only supports VPC-style access points.

For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to CreateAccessPoint:

", + "documentation":"

Creates an access point and associates it with the specified bucket. For more information, see Managing Data Access with Amazon S3 Access Points in the Amazon S3 User Guide.

S3 on Outposts only supports VPC-style access points.

For more information, see Accessing Amazon S3 on Outposts using virtual private cloud (VPC) only access points in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to CreateAccessPoint:

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -108,7 +108,7 @@ "requestUri":"/v20180820/accesspoint/{name}" }, "input":{"shape":"DeleteAccessPointRequest"}, - "documentation":"

Deletes the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to DeleteAccessPoint:

", + "documentation":"

Deletes the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to DeleteAccessPoint:

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -132,7 +132,7 @@ "requestUri":"/v20180820/accesspoint/{name}/policy" }, "input":{"shape":"DeleteAccessPointPolicyRequest"}, - "documentation":"

Deletes the access point policy for the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to DeleteAccessPointPolicy:

", + "documentation":"

Deletes the access point policy for the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to DeleteAccessPointPolicy:

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -156,7 +156,7 @@ "requestUri":"/v20180820/bucket/{name}" }, "input":{"shape":"DeleteBucketRequest"}, - "documentation":"

This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.

Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

Related Resources

", + "documentation":"

This action deletes an Amazon S3 on Outposts bucket. To delete an S3 bucket, see DeleteBucket in the Amazon S3 API Reference.

Deletes the Amazon S3 on Outposts bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

Related Resources

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -168,7 +168,7 @@ "requestUri":"/v20180820/bucket/{name}/lifecycleconfiguration" }, "input":{"shape":"DeleteBucketLifecycleConfigurationRequest"}, - "documentation":"

This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.

Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

To use this action, you must have permission to perform the s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

For more information about object expiration, see Elements to Describe Lifecycle Actions.

Related actions include:

", + "documentation":"

This action deletes an Amazon S3 on Outposts bucket's lifecycle configuration. To delete an S3 bucket's lifecycle configuration, see DeleteBucketLifecycle in the Amazon S3 API Reference.

Deletes the lifecycle configuration from the specified Outposts bucket. Amazon S3 on Outposts removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 on Outposts no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

To use this action, you must have permission to perform the s3-outposts:DeleteLifecycleConfiguration action. By default, the bucket owner has this permission and the Outposts bucket owner can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

For more information about object expiration, see Elements to Describe Lifecycle Actions.

Related actions include:

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -180,7 +180,7 @@ "requestUri":"/v20180820/bucket/{name}/policy" }, "input":{"shape":"DeleteBucketPolicyRequest"}, - "documentation":"

This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon S3 API Reference.

This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to DeleteBucketPolicy:

", + "documentation":"

This action deletes an Amazon S3 on Outposts bucket policy. To delete an S3 bucket policy, see DeleteBucketPolicy in the Amazon S3 API Reference.

This implementation of the DELETE action uses the policy subresource to delete the policy of a specified Amazon S3 on Outposts bucket. If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the s3-outposts:DeleteBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account to use this action. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

If you don't have DeleteBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to DeleteBucketPolicy:

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -193,7 +193,7 @@ "responseCode":204 }, "input":{"shape":"DeleteBucketTaggingRequest"}, - "documentation":"

This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon S3 API Reference.

Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

To use this action, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to DeleteBucketTagging:

", + "documentation":"

This action deletes an Amazon S3 on Outposts bucket's tags. To delete an S3 bucket tags, see DeleteBucketTagging in the Amazon S3 API Reference.

Deletes the tags from the Outposts bucket. For more information, see Using Amazon S3 on Outposts in Amazon S3 User Guide.

To use this action, you must have permission to perform the PutBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to DeleteBucketTagging:

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -312,7 +312,7 @@ }, "input":{"shape":"GetAccessPointRequest"}, "output":{"shape":"GetAccessPointResult"}, - "documentation":"

Returns configuration information about the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to GetAccessPoint:

", + "documentation":"

Returns configuration information about the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to GetAccessPoint:

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -403,7 +403,7 @@ }, "input":{"shape":"GetBucketRequest"}, "output":{"shape":"GetBucketResult"}, - "documentation":"

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the s3-outposts:GetBucket permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket.

If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.

The following actions are related to GetBucket for Amazon S3 on Outposts:

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

", + "documentation":"

Gets an Amazon S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the s3-outposts:GetBucket permissions on the specified Outposts bucket and belong to the Outposts bucket owner's account in order to use this action. Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket.

If you don't have s3-outposts:GetBucket permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.

The following actions are related to GetBucket for Amazon S3 on Outposts:

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -416,7 +416,7 @@ }, "input":{"shape":"GetBucketLifecycleConfigurationRequest"}, "output":{"shape":"GetBucketLifecycleConfigurationResult"}, - "documentation":"

This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.

Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon S3 User Guide.

To use this action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

GetBucketLifecycleConfiguration has the following special error:

The following actions are related to GetBucketLifecycleConfiguration:

", + "documentation":"

This action gets an Amazon S3 on Outposts bucket's lifecycle configuration. To get an S3 bucket's lifecycle configuration, see GetBucketLifecycleConfiguration in the Amazon S3 API Reference.

Returns the lifecycle configuration information set on the Outposts bucket. For more information, see Using Amazon S3 on Outposts and for information about lifecycle configuration, see Object Lifecycle Management in Amazon S3 User Guide.

To use this action, you must have permission to perform the s3-outposts:GetLifecycleConfiguration action. The Outposts bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

GetBucketLifecycleConfiguration has the following special error:

The following actions are related to GetBucketLifecycleConfiguration:

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -429,7 +429,7 @@ }, "input":{"shape":"GetBucketPolicyRequest"}, "output":{"shape":"GetBucketPolicyResult"}, - "documentation":"

This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon S3 API Reference.

Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this action.

Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to GetBucketPolicy:

", + "documentation":"

This action gets a bucket policy for an Amazon S3 on Outposts bucket. To get a policy for an S3 bucket, see GetBucketPolicy in the Amazon S3 API Reference.

Returns the policy of a specified Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must have the GetBucketPolicy permissions on the specified bucket and belong to the bucket owner's account in order to use this action.

Only users from Outposts bucket owner account with the right permissions can perform actions on an Outposts bucket. If you don't have s3-outposts:GetBucketPolicy permissions or you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 403 Access Denied error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to GetBucketPolicy:

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -442,7 +442,20 @@ }, "input":{"shape":"GetBucketTaggingRequest"}, "output":{"shape":"GetBucketTaggingResult"}, - "documentation":"

This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon S3 API Reference.

Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

To use this action, you must have permission to perform the GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

GetBucketTagging has the following special error:

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to GetBucketTagging:

", + "documentation":"

This action gets an Amazon S3 on Outposts bucket's tags. To get an S3 bucket tags, see GetBucketTagging in the Amazon S3 API Reference.

Returns the tag set associated with the Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

To use this action, you must have permission to perform the GetBucketTagging action. By default, the bucket owner has this permission and can grant this permission to others.

GetBucketTagging has the following special error:

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to GetBucketTagging:

", + "endpoint":{ + "hostPrefix":"{AccountId}." + } + }, + "GetBucketVersioning":{ + "name":"GetBucketVersioning", + "http":{ + "method":"GET", + "requestUri":"/v20180820/bucket/{name}/versioning" + }, + "input":{"shape":"GetBucketVersioningRequest"}, + "output":{"shape":"GetBucketVersioningResult"}, + "documentation":"

This operation returns the versioning state only for S3 on Outposts buckets. To return the versioning state for an S3 bucket, see GetBucketVersioning in the Amazon S3 API Reference.

Returns the versioning state for an S3 on Outposts bucket. With versioning, you can save multiple distinct copies of your data and recover from unintended user actions and application failures.

If you've never set versioning on your bucket, it has no versioning state. In that case, the GetBucketVersioning request does not return a versioning state value.

For more information about versioning, see Versioning in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following operations are related to GetBucketVersioning for S3 on Outposts.

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -557,7 +570,7 @@ }, "input":{"shape":"ListAccessPointsRequest"}, "output":{"shape":"ListAccessPointsResult"}, - "documentation":"

Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to ListAccessPoints:

", + "documentation":"

Returns a list of the access points currently associated with the specified bucket. You can retrieve up to 1000 access points per call. If the specified bucket has more than 1,000 access points (or the number specified in maxResults, whichever is less), the response will include a continuation token that you can use to list the additional access points.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to ListAccessPoints:

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -660,7 +673,7 @@ "locationName":"PutAccessPointPolicyRequest", "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, - "documentation":"

Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to PutAccessPointPolicy:

", + "documentation":"

Associates an access policy with the specified access point. Each access point can have only one policy, so a request made to this API replaces any existing policy associated with the specified access point.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to PutAccessPointPolicy:

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -688,7 +701,7 @@ "requestUri":"/v20180820/bucket/{name}/lifecycleconfiguration" }, "input":{"shape":"PutBucketLifecycleConfigurationRequest"}, - "documentation":"

This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference.

Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to PutBucketLifecycleConfiguration:

", + "documentation":"

This action puts a lifecycle configuration to an Amazon S3 on Outposts bucket. To put a lifecycle configuration to an S3 bucket, see PutBucketLifecycleConfiguration in the Amazon S3 API Reference.

Creates a new lifecycle configuration for the S3 on Outposts bucket or replaces an existing lifecycle configuration. Outposts buckets only support lifecycle configurations that delete/expire objects after a certain period of time and abort incomplete multipart uploads.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to PutBucketLifecycleConfiguration:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -705,7 +718,7 @@ "locationName":"PutBucketPolicyRequest", "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} }, - "documentation":"

This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon S3 API Reference.

Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this action.

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to PutBucketPolicy:

", + "documentation":"

This action puts a bucket policy to an Amazon S3 on Outposts bucket. To put a policy on an S3 bucket, see PutBucketPolicy in the Amazon S3 API Reference.

Applies an Amazon S3 bucket policy to an Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

If you are using an identity other than the root user of the Amazon Web Services account that owns the Outposts bucket, the calling identity must have the PutBucketPolicy permissions on the specified Outposts bucket and belong to the bucket owner's account in order to use this action.

If you don't have PutBucketPolicy permissions, Amazon S3 returns a 403 Access Denied error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a 405 Method Not Allowed error.

As a security precaution, the root user of the Amazon Web Services account that owns a bucket can always use this action, even if the policy explicitly denies the root user the ability to perform this action.

For more information about bucket policies, see Using Bucket Policies and User Policies.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to PutBucketPolicy:

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -718,7 +731,20 @@ "requestUri":"/v20180820/bucket/{name}/tagging" }, "input":{"shape":"PutBucketTaggingRequest"}, - "documentation":"

This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon S3 API Reference.

Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tagging.

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using cost allocation in Amazon S3 bucket tags.

To use this action, you must have permissions to perform the s3-outposts:PutBucketTagging action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing access permissions to your Amazon S3 resources.

PutBucketTagging has the following special errors:

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request and an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived using the access point ARN, see the Examples section.

The following actions are related to PutBucketTagging:

", + "documentation":"

This action puts tags on an Amazon S3 on Outposts bucket. To put tags on an S3 bucket, see PutBucketTagging in the Amazon S3 API Reference.

Sets the tags for an S3 on Outposts bucket. For more information, see Using Amazon S3 on Outposts in the Amazon S3 User Guide.

Use tags to organize your Amazon Web Services bill to reflect your own cost structure. To do this, sign up to get your Amazon Web Services account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost allocation and tagging.

Within a bucket, if you add a tag that has the same key as an existing tag, the new value overwrites the old value. For more information, see Using cost allocation in Amazon S3 bucket tags.

To use this action, you must have permissions to perform the s3-outposts:PutBucketTagging action. The Outposts bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing access permissions to your Amazon S3 resources.

PutBucketTagging has the following special errors:

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following actions are related to PutBucketTagging:

", + "endpoint":{ + "hostPrefix":"{AccountId}." + }, + "httpChecksumRequired":true + }, + "PutBucketVersioning":{ + "name":"PutBucketVersioning", + "http":{ + "method":"PUT", + "requestUri":"/v20180820/bucket/{name}/versioning" + }, + "input":{"shape":"PutBucketVersioningRequest"}, + "documentation":"

This operation sets the versioning state only for S3 on Outposts buckets. To set the versioning state for an S3 bucket, see PutBucketVersioning in the Amazon S3 API Reference.

Sets the versioning state for an S3 on Outposts bucket. With versioning, you can save multiple distinct copies of your data and recover from unintended user actions and application failures.

You can set the versioning state to one of the following:

If you've never set versioning on your bucket, it has no versioning state. In that case, a GetBucketVersioning request does not return a versioning state value.

When you enable S3 Versioning, for each object in your bucket, you have a current version and zero or more noncurrent versions. You can configure your bucket S3 Lifecycle rules to expire noncurrent versions after a specified time period. For more information, see Creating and managing a lifecycle configuration for your S3 on Outposts bucket in the Amazon S3 User Guide.

If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. For more information, see Versioning in the Amazon S3 User Guide.

All Amazon S3 on Outposts REST API requests for this action require an additional parameter of x-amz-outpost-id to be passed with the request. In addition, you must use an S3 on Outposts endpoint hostname prefix instead of s3-control. For an example of the request syntax for Amazon S3 on Outposts that uses the S3 on Outposts endpoint hostname prefix and the x-amz-outpost-id derived by using the access point ARN, see the Examples section.

The following operations are related to PutBucketVersioning for S3 on Outposts.

", "endpoint":{ "hostPrefix":"{AccountId}." }, @@ -772,7 +798,7 @@ "requestUri":"/v20180820/configuration/publicAccessBlock" }, "input":{"shape":"PutPublicAccessBlockRequest"}, - "documentation":"

Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For this operation, users must have the s3:PutBucketPublicAccessBlock permission. For more information, see Using Amazon S3 block public access.

Related actions include:

", + "documentation":"

Creates or modifies the PublicAccessBlock configuration for an Amazon Web Services account. For this operation, users must have the s3:PutAccountPublicAccessBlock permission. For more information, see Using Amazon S3 block public access.

Related actions include:

", "endpoint":{ "hostPrefix":"{AccountId}." } @@ -953,7 +979,7 @@ }, "Message":{ "shape":"MaxLength1024String", - "documentation":"

A generic descritpion of the error condition in English.

" + "documentation":"

A generic description of the error condition in English.

" }, "Resource":{ "shape":"MaxLength1024String", @@ -1132,6 +1158,13 @@ "max":255, "min":3 }, + "BucketVersioningStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Suspended" + ] + }, "Buckets":{ "type":"list", "member":{ @@ -1313,7 +1346,7 @@ }, "OutpostId":{ "shape":"NonEmptyMaxLength64String", - "documentation":"

The ID of the Outposts where the bucket is being created.

This is required by Amazon S3 on Outposts buckets.

", + "documentation":"

The ID of the Outposts where the bucket is being created.

This ID is required by Amazon S3 on Outposts buckets.

", "location":"header", "locationName":"x-amz-outpost-id" } @@ -2298,6 +2331,42 @@ } } }, + "GetBucketVersioningRequest":{ + "type":"structure", + "required":[ + "AccountId", + "Bucket" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The Amazon Web Services account ID of the S3 on Outposts bucket.

", + "hostLabel":true, + "location":"header", + "locationName":"x-amz-account-id" + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

The S3 on Outposts bucket to return the versioning state for.

", + "location":"uri", + "locationName":"name" + } + } + }, + "GetBucketVersioningResult":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"BucketVersioningStatus", + "documentation":"

The versioning state of the S3 on Outposts bucket.

" + }, + "MFADelete":{ + "shape":"MFADeleteStatus", + "documentation":"

Specifies whether MFA delete is enabled in the bucket versioning configuration. This element is returned only if the bucket has been configured with MFA delete. If MFA delete has never been configured for the bucket, this element is not returned.

", + "locationName":"MfaDelete" + } + } + }, "GetJobTaggingRequest":{ "type":"structure", "required":[ @@ -3347,7 +3416,7 @@ }, "OutpostId":{ "shape":"NonEmptyMaxLength64String", - "documentation":"

The ID of the Outposts.

This is required by Amazon S3 on Outposts buckets.

", + "documentation":"

The ID of the Outposts resource.

This ID is required by Amazon S3 on Outposts buckets.

", "location":"header", "locationName":"x-amz-outpost-id" } @@ -3426,6 +3495,21 @@ } }, "Location":{"type":"string"}, + "MFA":{"type":"string"}, + "MFADelete":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, + "MFADeleteStatus":{ + "type":"string", + "enum":[ + "Enabled", + "Disabled" + ] + }, "ManifestPrefixString":{ "type":"string", "max":512, @@ -3513,7 +3597,7 @@ "PublicAccessBlock":{"shape":"PublicAccessBlockConfiguration"}, "Status":{ "shape":"MultiRegionAccessPointStatus", - "documentation":"

The current status of the Multi-Region Access Point.

CREATING and DELETING are temporary states that exist while the request is propogating and being completed. If a Multi-Region Access Point has a status of PARTIALLY_CREATED, you can retry creation or send a request to delete the Multi-Region Access Point. If a Multi-Region Access Point has a status of PARTIALLY_DELETED, you can retry a delete request to finish the deletion of the Multi-Region Access Point.

" + "documentation":"

The current status of the Multi-Region Access Point.

CREATING and DELETING are temporary states that exist while the request is propagating and being completed. If a Multi-Region Access Point has a status of PARTIALLY_CREATED, you can retry creation or send a request to delete the Multi-Region Access Point. If a Multi-Region Access Point has a status of PARTIALLY_DELETED, you can retry a delete request to finish the deletion of the Multi-Region Access Point.

" }, "Regions":{ "shape":"RegionReportList", @@ -4019,6 +4103,42 @@ }, "payload":"Tagging" }, + "PutBucketVersioningRequest":{ + "type":"structure", + "required":[ + "AccountId", + "Bucket", + "VersioningConfiguration" + ], + "members":{ + "AccountId":{ + "shape":"AccountId", + "documentation":"

The Amazon Web Services account ID of the S3 on Outposts bucket.

", + "hostLabel":true, + "location":"header", + "locationName":"x-amz-account-id" + }, + "Bucket":{ + "shape":"BucketName", + "documentation":"

The S3 on Outposts bucket to set the versioning state for.

", + "location":"uri", + "locationName":"name" + }, + "MFA":{ + "shape":"MFA", + "documentation":"

The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.

", + "location":"header", + "locationName":"x-amz-mfa" + }, + "VersioningConfiguration":{ + "shape":"VersioningConfiguration", + "documentation":"

The root-level tag for the VersioningConfiguration parameters.

", + "locationName":"VersioningConfiguration", + "xmlNamespace":{"uri":"http://awss3control.amazonaws.com/doc/2018-08-20/"} + } + }, + "payload":"VersioningConfiguration" + }, "PutJobTaggingRequest":{ "type":"structure", "required":[ @@ -4903,7 +5023,7 @@ "members":{ "KeyId":{ "shape":"KmsKeyArnString", - "documentation":"

Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key to use for encrypting generated manifest objects.

" + "documentation":"

Specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key to use for encrypting generated manifest objects.

" } }, "documentation":"

Configuration for the use of SSE-KMS to encrypt generated manifest objects.

", @@ -5259,6 +5379,21 @@ } } }, + "VersioningConfiguration":{ + "type":"structure", + "members":{ + "MFADelete":{ + "shape":"MFADelete", + "documentation":"

Specifies whether MFA delete is enabled or disabled in the bucket versioning configuration for the S3 on Outposts bucket.

", + "locationName":"MfaDelete" + }, + "Status":{ + "shape":"BucketVersioningStatus", + "documentation":"

Sets the versioning state of the S3 on Outposts bucket.

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

Describes the versioning state of an Amazon S3 on Outposts bucket. For more information, see PutBucketVersioning.

" + }, "VpcConfiguration":{ "type":"structure", "required":["VpcId"], diff --git a/awscli/botocore/data/sagemaker/2017-07-24/service-2.json b/awscli/botocore/data/sagemaker/2017-07-24/service-2.json index d3955a9b7ff1..0a2cc64ae1ff 100644 --- a/awscli/botocore/data/sagemaker/2017-07-24/service-2.json +++ b/awscli/botocore/data/sagemaker/2017-07-24/service-2.json @@ -675,7 +675,7 @@ {"shape":"ResourceLimitExceeded"}, {"shape":"ResourceInUse"} ], - "documentation":"

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from Amazon Web Services SSO, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.

" + "documentation":"

Creates a user profile. A user profile represents a single user within a domain, and is the main way to reference a \"person\" for the purposes of sharing, reporting, and other user-oriented features. This entity is created when a user onboards to Amazon SageMaker Studio. If an administrator invites a person by email or imports them from IAM Identity Center, a user profile is automatically created. A user profile is the primary holder of settings for an individual user and has a reference to the user's private Amazon Elastic File System (EFS) home directory.

" }, "CreateWorkforce":{ "name":"CreateWorkforce", @@ -831,7 +831,7 @@ {"shape":"ResourceInUse"}, {"shape":"ResourceNotFound"} ], - "documentation":"

Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using Amazon Web Services SSO. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

" + "documentation":"

Used to delete a domain. If you onboarded with IAM mode, you will need to delete your domain to onboard again using IAM Identity Center. Use with caution. All of the members of the domain will lose access to their EFS volume, including data, notebooks, and other artifacts.

" }, "DeleteEdgeDeploymentPlan":{ "name":"DeleteEdgeDeploymentPlan", @@ -4208,7 +4208,7 @@ "members":{ "FeatureSpecificationS3Uri":{ "shape":"S3Uri", - "documentation":"

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job (optional). This file should be in json format as shown below:

{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

The key name FeatureAttributeNames is fixed. The values listed in [\"col1\", \"col2\", ...] is case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

" + "documentation":"

A URL to the Amazon S3 data source containing selected features from the input data source to run an Autopilot job. You can input FeatureAttributeNames (optional) in JSON format as shown below:

{ \"FeatureAttributeNames\":[\"col1\", \"col2\", ...] }.

You can also specify the data type of the feature (optional) in the format shown below:

{ \"FeatureDataTypes\":{\"col1\":\"numeric\", \"col2\":\"categorical\" ... } }

These column keys may not include the target column.

In ensembling mode, Autopilot will only support the following data types: numeric, categorical, text and datetime. In HPO mode, Autopilot can support numeric, categorical, text, datetime and sequence.

If only FeatureDataTypes is provided, the column keys (col1, col2,..) should be a subset of the column names in the input data.

If both FeatureDataTypes and FeatureAttributeNames are provided, then the column keys should be a subset of the column names provided in FeatureAttributeNames.

The key name FeatureAttributeNames is fixed. The values listed in [\"col1\", \"col2\", ...] is case sensitive and should be a list of strings containing unique values that are a subset of the column names in the input data. The list of columns provided must not include the target column.

" } }, "documentation":"

Stores the config information for how a candidate is generated (optional).

" @@ -4935,6 +4935,16 @@ "type":"list", "member":{"shape":"AutoMLCandidateStep"} }, + "CanvasAppSettings":{ + "type":"structure", + "members":{ + "TimeSeriesForecastingSettings":{ + "shape":"TimeSeriesForecastingSettings", + "documentation":"

Time series forecast settings for the Canvas app.

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

The SageMaker Canvas app settings.

" + }, "CapacitySize":{ "type":"structure", "required":[ @@ -7874,11 +7884,11 @@ }, "SingleSignOnUserIdentifier":{ "shape":"SingleSignOnUserIdentifier", - "documentation":"

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\". If the Domain's AuthMode is Amazon Web Services SSO, this field is required. If the Domain's AuthMode is not Amazon Web Services SSO, this field cannot be specified.

" + "documentation":"

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is \"UserName\". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

" }, "SingleSignOnUserValue":{ "shape":"String256", - "documentation":"

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is Amazon Web Services SSO, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not Amazon Web Services SSO, this field cannot be specified.

" + "documentation":"

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

" }, "Tags":{ "shape":"TagList", @@ -9874,7 +9884,7 @@ }, "SingleSignOnManagedApplicationInstanceId":{ "shape":"String256", - "documentation":"

The Amazon Web Services SSO managed application instance ID.

" + "documentation":"

The IAM Identity Center managed application instance ID.

" }, "Status":{ "shape":"DomainStatus", @@ -12345,11 +12355,11 @@ }, "SingleSignOnUserIdentifier":{ "shape":"SingleSignOnUserIdentifier", - "documentation":"

The Amazon Web Services SSO user identifier.

" + "documentation":"

The IAM Identity Center user identifier.

" }, "SingleSignOnUserValue":{ "shape":"String256", - "documentation":"

The Amazon Web Services SSO user value.

" + "documentation":"

The IAM Identity Center user value.

" }, "UserSettings":{ "shape":"UserSettings", @@ -14174,6 +14184,13 @@ "max":25, "min":0 }, + "FeatureStatus":{ + "type":"string", + "enum":[ + "ENABLED", + "DISABLED" + ] + }, "FeatureType":{ "type":"string", "enum":[ @@ -15241,7 +15258,7 @@ "documentation":"

The tags associated with a hyperparameter tuning job. For more information see Tagging Amazon Web Services resources.

" } }, - "documentation":"

An entity having characteristics over which a user can search for a hyperparameter tuning job.

" + "documentation":"

An entity returned by the SearchRecord API containing the properties of a hyperparameter tuning job.

" }, "HyperParameterTuningJobSortByOptions":{ "type":"string", @@ -25962,6 +25979,20 @@ "max":128, "pattern":"[a-zA-Z0-9:_-]+" }, + "TimeSeriesForecastingSettings":{ + "type":"structure", + "members":{ + "Status":{ + "shape":"FeatureStatus", + "documentation":"

Describes whether time series forecasting is enabled or disabled in the Canvas app.

" + }, + "AmazonForecastRoleArn":{ + "shape":"RoleArn", + "documentation":"

The IAM role that Canvas passes to Amazon Forecast for time series forecasting. By default, Canvas uses the execution role specified in the UserProfile that launches the Canvas app. If an execution role is not specified in the UserProfile, Canvas uses the execution role specified in the Domain that owns the UserProfile. To allow time series forecasting, this IAM role should have the AmazonSageMakerCanvasForecastAccess policy attached and forecast.amazonaws.com added in the trust relationship as a service principal.

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

Time series forecast settings for the SageMaker Canvas app.

" + }, "Timestamp":{"type":"timestamp"}, "TrafficDurationInSeconds":{ "type":"integer", @@ -28283,6 +28314,10 @@ "RSessionAppSettings":{ "shape":"RSessionAppSettings", "documentation":"

A collection of settings that configure the RSessionGateway app.

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

The Canvas app settings.

" } }, "documentation":"

A collection of settings that apply to users of Amazon SageMaker Studio. These settings are specified when the CreateUserProfile API is called, and as DefaultUserSettings when the CreateDomain API is called.

SecurityGroups is aggregated when specified in both calls. For all other settings in UserSettings, the values specified in CreateUserProfile take precedence over those specified in CreateDomain.

"