diff --git a/.changes/2.583.0.json b/.changes/2.583.0.json new file mode 100644 index 0000000000..9b3857fd76 --- /dev/null +++ b/.changes/2.583.0.json @@ -0,0 +1,77 @@ +[ + { + "type": "feature", + "category": "AugmentedAIRuntime", + "description": "This release adds support for Amazon Augmented AI, which makes it easy to build workflows for human review of machine learning predictions." + }, + { + "type": "feature", + "category": "Bucket", + "description": "Add support for S3 access point. Access Points provide a customizable way to access the objects in a bucket, with a unique hostname and access policy that enforces the specific permissions and network controls for any request made through the access point." + }, + { + "type": "feature", + "category": "CodeGuruProfiler", + "description": "(New Service) Amazon CodeGuru Profiler analyzes application CPU utilization and latency characteristics to show you where you are spending the most cycles in your application. This analysis is presented in an interactive flame graph that helps you easily understand which paths consume the most resources, verify that your application is performing as expected, and uncover areas that can be optimized further." + }, + { + "type": "feature", + "category": "CodeGuruReviewer", + "description": "This is the preview release of Amazon CodeGuru Reviewer." + }, + { + "type": "feature", + "category": "ComputeOptimizer", + "description": "Initial release of AWS Compute Optimizer. AWS Compute Optimizer recommends optimal AWS Compute resources to reduce costs and improve performance for your workloads." + }, + { + "type": "feature", + "category": "EC2", + "description": "This release adds support for the following features: 1. An option to enable acceleration for Site-to-Site VPN connections, to improve connection performance by leveraging AWS Global Accelerator; 2. Inf1 instances featuring up to 16 AWS Inferentia chips, custom-built for ML inference applications to deliver low latency and high throughput performance. Use Inf1 instances to run high scale ML inference applications such as image recognition, speech recognition, natural language processing, personalization, and fraud detection at the lowest cost in the cloud. Inf1 instances will soon be available for use with Amazon SageMaker, Amazon EKS and Amazon ECS. To get started, see https://aws.amazon.com/ec2/instance-types/Inf1; 3. The ability to associate route tables with internet gateways and virtual private gateways, and define routes to insert network and security virtual appliances in the path of inbound and outbound traffic. For more information on Amazon VPC Ingress Routing, see https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#gateway-route-table; 4. AWS Local Zones that place compute, storage, database, and other select services closer to you for applications that require very low latency to your end-users. AWS Local Zones also allow you to seamlessly connect to the full range of services in the AWS Region through the same APIs and tool sets; 5. Launching and viewing EC2 instances and EBS volumes running locally in Outposts. This release also introduces a new local gateway (LGW) with Outposts to enable connectivity between Outposts and local on-premises networks as well as the internet; 6. Peering Transit Gateways between regions simplifying creation of secure and private global networks on AWS; 7. Transit Gateway Multicast, enabling multicast routing within and between VPCs using Transit Gateway as a multicast router." + }, + { + "type": "feature", + "category": "ECS", + "description": "This release supports ECS Capacity Providers, Fargate Spot, and ECS Cluster Auto Scaling. These features enable new ways for ECS to manage compute capacity used by tasks." + }, + { + "type": "feature", + "category": "EKS", + "description": "Introducing Amazon EKS with Fargate. Customers can now use Amazon EKS to launch pods directly onto AWS Fargate, the serverless compute engine built for containers on AWS. " + }, + { + "type": "feature", + "category": "ES", + "description": "UltraWarm storage provides a cost-effective way to store large amounts of read-only data on Amazon Elasticsearch Service. Rather than attached storage, UltraWarm nodes use Amazon S3 and a sophisticated caching solution to improve performance. For indices that you are not actively writing to and query less frequently, UltraWarm storage offers significantly lower costs per GiB. In Elasticsearch, these warm indices behave just like any other index. You can query them using the same APIs or use them to create dashboards in Kibana." + }, + { + "type": "feature", + "category": "FraudDetector", + "description": "Amazon Fraud Detector is a fully managed service that makes it easy to identify potentially fraudulent online activities such as online payment fraud and the creation of fake accounts. Amazon Fraud Detector uses your data, machine learning (ML), and more than 20 years of fraud detection expertise from Amazon to automatically identify potentially fraudulent online activity so you can catch more fraud faster." + }, + { + "type": "feature", + "category": "Kendra", + "description": "It is a preview launch of Amazon Kendra. Amazon Kendra is a managed, highly accurate and easy to use enterprise search service that is powered by machine learning." + }, + { + "type": "feature", + "category": "NetworkManager", + "description": "This is the initial SDK release for AWS Network Manager." + }, + { + "type": "feature", + "category": "Outposts", + "description": "This is the initial release for AWS Outposts, a fully managed service that extends AWS infrastructure, services, APIs, and tools to customer sites. AWS Outposts enables you to launch and run EC2 instances and EBS volumes locally at your on-premises location. This release introduces new APIs for creating and viewing Outposts. " + }, + { + "type": "feature", + "category": "S3Control", + "description": "Amazon S3 Access Points is a new S3 feature that simplifies managing data access at scale for shared data sets on Amazon S3. Access Points provide a customizable way to access the objects in a bucket, with a unique hostname and access policy that enforces the specific permissions and network controls for any request made through the access point. This represents a new way of provisioning access to shared data sets." + }, + { + "type": "feature", + "category": "Textract", + "description": "This SDK Release introduces Amazon Augmented AI support for Amazon Textract AnalyzeDocument API. Image byte payloads for synchronous operations have increased from 5 MB to 10 MB." + } +] \ No newline at end of file diff --git a/.changes/next-release/feature-Bucket-a1a45ab9.json b/.changes/next-release/feature-Bucket-a1a45ab9.json deleted file mode 100644 index d4e6393930..0000000000 --- a/.changes/next-release/feature-Bucket-a1a45ab9.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "type": "feature", - "category": "Bucket", - "description": "Add support for S3 access point. Access Points provide a customizable way to access the objects in a bucket, with a unique hostname and access policy that enforces the specific permissions and network controls for any request made through the access point." -} \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 5ccbc21da6..ffa3e048c5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,24 @@ # Changelog for AWS SDK for JavaScript - + +## 2.583.0 +* feature: AugmentedAIRuntime: This release adds support for Amazon Augmented AI, which makes it easy to build workflows for human review of machine learning predictions. +* feature: Bucket: Add support for S3 access point. Access Points provide a customizable way to access the objects in a bucket, with a unique hostname and access policy that enforces the specific permissions and network controls for any request made through the access point. +* feature: CodeGuruProfiler: (New Service) Amazon CodeGuru Profiler analyzes application CPU utilization and latency characteristics to show you where you are spending the most cycles in your application. This analysis is presented in an interactive flame graph that helps you easily understand which paths consume the most resources, verify that your application is performing as expected, and uncover areas that can be optimized further. +* feature: CodeGuruReviewer: This is the preview release of Amazon CodeGuru Reviewer. +* feature: ComputeOptimizer: Initial release of AWS Compute Optimizer. AWS Compute Optimizer recommends optimal AWS Compute resources to reduce costs and improve performance for your workloads. +* feature: EC2: This release adds support for the following features: 1. An option to enable acceleration for Site-to-Site VPN connections, to improve connection performance by leveraging AWS Global Accelerator; 2. Inf1 instances featuring up to 16 AWS Inferentia chips, custom-built for ML inference applications to deliver low latency and high throughput performance. Use Inf1 instances to run high scale ML inference applications such as image recognition, speech recognition, natural language processing, personalization, and fraud detection at the lowest cost in the cloud. Inf1 instances will soon be available for use with Amazon SageMaker, Amazon EKS and Amazon ECS. To get started, see https://aws.amazon.com/ec2/instance-types/Inf1; 3. The ability to associate route tables with internet gateways and virtual private gateways, and define routes to insert network and security virtual appliances in the path of inbound and outbound traffic. For more information on Amazon VPC Ingress Routing, see https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#gateway-route-table; 4. AWS Local Zones that place compute, storage, database, and other select services closer to you for applications that require very low latency to your end-users. AWS Local Zones also allow you to seamlessly connect to the full range of services in the AWS Region through the same APIs and tool sets; 5. Launching and viewing EC2 instances and EBS volumes running locally in Outposts. This release also introduces a new local gateway (LGW) with Outposts to enable connectivity between Outposts and local on-premises networks as well as the internet; 6. Peering Transit Gateways between regions simplifying creation of secure and private global networks on AWS; 7. Transit Gateway Multicast, enabling multicast routing within and between VPCs using Transit Gateway as a multicast router. +* feature: ECS: This release supports ECS Capacity Providers, Fargate Spot, and ECS Cluster Auto Scaling. These features enable new ways for ECS to manage compute capacity used by tasks. +* feature: EKS: Introducing Amazon EKS with Fargate. Customers can now use Amazon EKS to launch pods directly onto AWS Fargate, the serverless compute engine built for containers on AWS. +* feature: ES: UltraWarm storage provides a cost-effective way to store large amounts of read-only data on Amazon Elasticsearch Service. Rather than attached storage, UltraWarm nodes use Amazon S3 and a sophisticated caching solution to improve performance. For indices that you are not actively writing to and query less frequently, UltraWarm storage offers significantly lower costs per GiB. In Elasticsearch, these warm indices behave just like any other index. You can query them using the same APIs or use them to create dashboards in Kibana. +* feature: FraudDetector: Amazon Fraud Detector is a fully managed service that makes it easy to identify potentially fraudulent online activities such as online payment fraud and the creation of fake accounts. Amazon Fraud Detector uses your data, machine learning (ML), and more than 20 years of fraud detection expertise from Amazon to automatically identify potentially fraudulent online activity so you can catch more fraud faster. +* feature: Kendra: It is a preview launch of Amazon Kendra. Amazon Kendra is a managed, highly accurate and easy to use enterprise search service that is powered by machine learning. +* feature: NetworkManager: This is the initial SDK release for AWS Network Manager. +* feature: Outposts: This is the initial release for AWS Outposts, a fully managed service that extends AWS infrastructure, services, APIs, and tools to customer sites. AWS Outposts enables you to launch and run EC2 instances and EBS volumes locally at your on-premises location. This release introduces new APIs for creating and viewing Outposts. +* feature: S3Control: Amazon S3 Access Points is a new S3 feature that simplifies managing data access at scale for shared data sets on Amazon S3. Access Points provide a customizable way to access the objects in a bucket, with a unique hostname and access policy that enforces the specific permissions and network controls for any request made through the access point. This represents a new way of provisioning access to shared data sets. +* feature: Textract: This SDK Release introduces Amazon Augmented AI support for Amazon Textract AnalyzeDocument API. Image byte payloads for synchronous operations have increased from 5 MB to 10 MB. + ## 2.582.0 * feature: AccessAnalyzer: Introducing AWS IAM Access Analyzer, an IAM feature that makes it easy for AWS customers to ensure that their resource-based policies provide only the intended access to resources outside their AWS accounts. diff --git a/README.md b/README.md index ec31a79d74..c2a1e06958 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ version. To use the SDK in the browser, simply add the following script tag to your HTML pages: - + You can also build a custom browser SDK with your specified set of AWS services. This can allow you to reduce the SDK's size, specify different API versions of diff --git a/apis/codeguru-reviewer-2019-09-19.examples.json b/apis/codeguru-reviewer-2019-09-19.examples.json new file mode 100644 index 0000000000..0ea7e3b0bb --- /dev/null +++ b/apis/codeguru-reviewer-2019-09-19.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/apis/codeguru-reviewer-2019-09-19.min.json b/apis/codeguru-reviewer-2019-09-19.min.json new file mode 100644 index 0000000000..badf07bd7d --- /dev/null +++ b/apis/codeguru-reviewer-2019-09-19.min.json @@ -0,0 +1,194 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-09-19", + "endpointPrefix": "codeguru-reviewer", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "CodeGuruReviewer", + "serviceFullName": "Amazon CodeGuru Reviewer", + "serviceId": "CodeGuru Reviewer", + "signatureVersion": "v4", + "signingName": "codeguru-reviewer", + "uid": "codeguru-reviewer-2019-09-19" + }, + "operations": { + "AssociateRepository": { + "http": { + "requestUri": "/associations" + }, + "input": { + "type": "structure", + "required": [ + "Repository" + ], + "members": { + "Repository": { + "type": "structure", + "members": { + "CodeCommit": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": {} + } + } + } + }, + "ClientRequestToken": { + "idempotencyToken": true + } + } + }, + "output": { + "type": "structure", + "members": { + "RepositoryAssociation": { + "shape": "S7" + } + } + } + }, + "DescribeRepositoryAssociation": { + "http": { + "method": "GET", + "requestUri": "/associations/{AssociationArn}" + }, + "input": { + "type": "structure", + "required": [ + "AssociationArn" + ], + "members": { + "AssociationArn": { + "location": "uri", + "locationName": "AssociationArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "RepositoryAssociation": { + "shape": "S7" + } + } + } + }, + "DisassociateRepository": { + "http": { + "method": "DELETE", + "requestUri": "/associations/{AssociationArn}" + }, + "input": { + "type": "structure", + "required": [ + "AssociationArn" + ], + "members": { + "AssociationArn": { + "location": "uri", + "locationName": "AssociationArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "RepositoryAssociation": { + "shape": "S7" + } + } + } + }, + "ListRepositoryAssociations": { + "http": { + "method": "GET", + "requestUri": "/associations" + }, + "input": { + "type": "structure", + "members": { + "ProviderTypes": { + "location": "querystring", + "locationName": "ProviderType", + "type": "list", + "member": {} + }, + "States": { + "location": "querystring", + "locationName": "State", + "type": "list", + "member": {} + }, + "Names": { + "location": "querystring", + "locationName": "Name", + "type": "list", + "member": {} + }, + "Owners": { + "location": "querystring", + "locationName": "Owner", + "type": "list", + "member": {} + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "RepositoryAssociationSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "AssociationArn": {}, + "LastUpdatedTimeStamp": { + "type": "timestamp" + }, + "AssociationId": {}, + "Name": {}, + "Owner": {}, + "ProviderType": {}, + "State": {} + } + } + }, + "NextToken": {} + } + } + } + }, + "shapes": { + "S7": { + "type": "structure", + "members": { + "AssociationId": {}, + "AssociationArn": {}, + "Name": {}, + "Owner": {}, + "ProviderType": {}, + "State": {}, + "StateReason": {}, + "LastUpdatedTimeStamp": { + "type": "timestamp" + }, + "CreatedTimeStamp": { + "type": "timestamp" + } + } + } + } +} \ No newline at end of file diff --git a/apis/codeguru-reviewer-2019-09-19.normal.json b/apis/codeguru-reviewer-2019-09-19.normal.json new file mode 100644 index 0000000000..ccd87f5bae --- /dev/null +++ b/apis/codeguru-reviewer-2019-09-19.normal.json @@ -0,0 +1,465 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-09-19", + "endpointPrefix": "codeguru-reviewer", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "CodeGuruReviewer", + "serviceFullName": "Amazon CodeGuru Reviewer", + "serviceId": "CodeGuru Reviewer", + "signatureVersion": "v4", + "signingName": "codeguru-reviewer", + "uid": "codeguru-reviewer-2019-09-19" + }, + "operations": { + "AssociateRepository": { + "name": "AssociateRepository", + "http": { + "method": "POST", + "requestUri": "/associations" + }, + "input": { + "shape": "AssociateRepositoryRequest" + }, + "output": { + "shape": "AssociateRepositoryResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "
Associates an AWS CodeCommit repository with Amazon CodeGuru Reviewer. When you associate an AWS CodeCommit repository with Amazon CodeGuru Reviewer, Amazon CodeGuru Reviewer will provide recommendations for each pull request. You can view recommendations in the AWS CodeCommit repository.
You can associate a GitHub repository using the Amazon CodeGuru Reviewer console.
" + }, + "DescribeRepositoryAssociation": { + "name": "DescribeRepositoryAssociation", + "http": { + "method": "GET", + "requestUri": "/associations/{AssociationArn}" + }, + "input": { + "shape": "DescribeRepositoryAssociationRequest" + }, + "output": { + "shape": "DescribeRepositoryAssociationResponse" + }, + "errors": [ + { + "shape": "NotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Describes a repository association.
" + }, + "DisassociateRepository": { + "name": "DisassociateRepository", + "http": { + "method": "DELETE", + "requestUri": "/associations/{AssociationArn}" + }, + "input": { + "shape": "DisassociateRepositoryRequest" + }, + "output": { + "shape": "DisassociateRepositoryResponse" + }, + "errors": [ + { + "shape": "NotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Removes the association between Amazon CodeGuru Reviewer and a repository.
" + }, + "ListRepositoryAssociations": { + "name": "ListRepositoryAssociations", + "http": { + "method": "GET", + "requestUri": "/associations" + }, + "input": { + "shape": "ListRepositoryAssociationsRequest" + }, + "output": { + "shape": "ListRepositoryAssociationsResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Lists repository associations. You can optionally filter on one or more of the following recommendation properties: provider types, states, names, and owners.
" + } + }, + "shapes": { + "Arn": { + "type": "string", + "max": 1600, + "min": 1, + "pattern": "^arn:aws[^:\\s]*:codeguru-reviewer:[^:\\s]+:[\\d]{12}:[a-z]+:[\\w-]+$" + }, + "AssociateRepositoryRequest": { + "type": "structure", + "required": [ + "Repository" + ], + "members": { + "Repository": { + "shape": "Repository", + "documentation": "The repository to associate.
" + }, + "ClientRequestToken": { + "shape": "ClientRequestToken", + "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
If you want to add a new repository association, this parameter specifies a unique identifier for the new repository association that helps ensure idempotency.
If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.
You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given repository association is not created twice. We recommend that you generate a UUID-type value to ensure uniqueness within the specified repository association.
Amazon CodeGuru Reviewer uses this value to prevent the accidental creation of duplicate repository associations if there are failures and retries.
", + "idempotencyToken": true + } + } + }, + "AssociateRepositoryResponse": { + "type": "structure", + "members": { + "RepositoryAssociation": { + "shape": "RepositoryAssociation", + "documentation": "Information about the repository association.
" + } + } + }, + "AssociationId": { + "type": "string", + "max": 64, + "min": 1 + }, + "ClientRequestToken": { + "type": "string", + "max": 64, + "min": 1, + "pattern": "^[\\w-]+$" + }, + "CodeCommitRepository": { + "type": "structure", + "required": [ + "Name" + ], + "members": { + "Name": { + "shape": "Name", + "documentation": "The name of the AWS CodeCommit repository.
" + } + }, + "documentation": "Information about an AWS CodeCommit repository.
" + }, + "DescribeRepositoryAssociationRequest": { + "type": "structure", + "required": [ + "AssociationArn" + ], + "members": { + "AssociationArn": { + "shape": "Arn", + "documentation": "The Amazon Resource Name (ARN) identifying the association.
", + "location": "uri", + "locationName": "AssociationArn" + } + } + }, + "DescribeRepositoryAssociationResponse": { + "type": "structure", + "members": { + "RepositoryAssociation": { + "shape": "RepositoryAssociation", + "documentation": "Information about the repository association.
" + } + } + }, + "DisassociateRepositoryRequest": { + "type": "structure", + "required": [ + "AssociationArn" + ], + "members": { + "AssociationArn": { + "shape": "Arn", + "documentation": "The Amazon Resource Name (ARN) identifying the association.
", + "location": "uri", + "locationName": "AssociationArn" + } + } + }, + "DisassociateRepositoryResponse": { + "type": "structure", + "members": { + "RepositoryAssociation": { + "shape": "RepositoryAssociation", + "documentation": "Information about the disassociated repository.
" + } + } + }, + "ListRepositoryAssociationsRequest": { + "type": "structure", + "members": { + "ProviderTypes": { + "shape": "ProviderTypes", + "documentation": "List of provider types to use as a filter.
", + "location": "querystring", + "locationName": "ProviderType" + }, + "States": { + "shape": "RepositoryAssociationStates", + "documentation": "List of states to use as a filter.
", + "location": "querystring", + "locationName": "State" + }, + "Names": { + "shape": "Names", + "documentation": "List of names to use as a filter.
", + "location": "querystring", + "locationName": "Name" + }, + "Owners": { + "shape": "Owners", + "documentation": "List of owners to use as a filter. For AWS CodeCommit, the owner is the AWS account id. For GitHub, it is the GitHub account name.
", + "location": "querystring", + "locationName": "Owner" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of repository association results returned by ListRepositoryAssociations
in paginated output. When this parameter is used, ListRepositoryAssociations
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another ListRepositoryAssociations
request with the returned nextToken
value. This value can be between 1 and 100. If this parameter is not used, then ListRepositoryAssociations
returns up to 100 results and a nextToken
value if applicable.
The nextToken
value returned from a previous paginated ListRepositoryAssociations
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
A list of repository associations that meet the criteria of the request.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The nextToken
value to include in a future ListRecommendations
request. When the results of a ListRecommendations
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
Information about an AWS CodeCommit repository.
" + } + }, + "documentation": "Information about a repository.
" + }, + "RepositoryAssociation": { + "type": "structure", + "members": { + "AssociationId": { + "shape": "AssociationId", + "documentation": "The id of the repository association.
" + }, + "AssociationArn": { + "shape": "Arn", + "documentation": "The Amazon Resource Name (ARN) identifying the repository association.
" + }, + "Name": { + "shape": "Name", + "documentation": "The name of the repository.
" + }, + "Owner": { + "shape": "Owner", + "documentation": "The owner of the repository.
" + }, + "ProviderType": { + "shape": "ProviderType", + "documentation": "The provider type of the repository association.
" + }, + "State": { + "shape": "RepositoryAssociationState", + "documentation": "The state of the repository association.
" + }, + "StateReason": { + "shape": "StateReason", + "documentation": "A description of why the repository association is in the current state.
" + }, + "LastUpdatedTimeStamp": { + "shape": "TimeStamp", + "documentation": "The time, in milliseconds since the epoch, when the repository association was last updated.
" + }, + "CreatedTimeStamp": { + "shape": "TimeStamp", + "documentation": "The time, in milliseconds since the epoch, when the repository association was created.
" + } + }, + "documentation": "Information about a repository association.
" + }, + "RepositoryAssociationState": { + "type": "string", + "enum": [ + "Associated", + "Associating", + "Failed", + "Disassociating" + ] + }, + "RepositoryAssociationStates": { + "type": "list", + "member": { + "shape": "RepositoryAssociationState" + }, + "max": 3, + "min": 1 + }, + "RepositoryAssociationSummaries": { + "type": "list", + "member": { + "shape": "RepositoryAssociationSummary" + } + }, + "RepositoryAssociationSummary": { + "type": "structure", + "members": { + "AssociationArn": { + "shape": "Arn", + "documentation": "The Amazon Resource Name (ARN) identifying the repository association.
" + }, + "LastUpdatedTimeStamp": { + "shape": "TimeStamp", + "documentation": "The time, in milliseconds since the epoch, since the repository association was last updated.
" + }, + "AssociationId": { + "shape": "AssociationId", + "documentation": "The repository association ID.
" + }, + "Name": { + "shape": "Name", + "documentation": "The name of the repository association.
" + }, + "Owner": { + "shape": "Owner", + "documentation": "The owner of the repository association.
" + }, + "ProviderType": { + "shape": "ProviderType", + "documentation": "The provider type of the repository association.
" + }, + "State": { + "shape": "RepositoryAssociationState", + "documentation": "The state of the repository association.
Amazon CodeGuru Reviewer is associated with the repository.
The association is in progress.
The association failed. For more information about troubleshooting (or why it failed), see [troubleshooting topic].
Amazon CodeGuru Reviewer is in the process of disassociating with the repository.
Information about a repository association.
" + }, + "StateReason": { + "type": "string", + "max": 256, + "min": 0 + }, + "TimeStamp": { + "type": "timestamp" + } + }, + "documentation": "This section provides documentation for the Amazon CodeGuru Reviewer API operations.
" +} \ No newline at end of file diff --git a/apis/codeguru-reviewer-2019-09-19.paginators.json b/apis/codeguru-reviewer-2019-09-19.paginators.json new file mode 100644 index 0000000000..bbc1f584fd --- /dev/null +++ b/apis/codeguru-reviewer-2019-09-19.paginators.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListRepositoryAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "RepositoryAssociationSummaries" + } + } +} diff --git a/apis/codeguruprofiler-2019-07-18.examples.json b/apis/codeguruprofiler-2019-07-18.examples.json new file mode 100644 index 0000000000..0ea7e3b0bb --- /dev/null +++ b/apis/codeguruprofiler-2019-07-18.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/apis/codeguruprofiler-2019-07-18.min.json b/apis/codeguruprofiler-2019-07-18.min.json new file mode 100644 index 0000000000..cbec32ca0c --- /dev/null +++ b/apis/codeguruprofiler-2019-07-18.min.json @@ -0,0 +1,454 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-07-18", + "endpointPrefix": "codeguru-profiler", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "Amazon CodeGuru Profiler", + "serviceId": "CodeGuruProfiler", + "signatureVersion": "v4", + "signingName": "codeguru-profiler", + "uid": "codeguruprofiler-2019-07-18" + }, + "operations": { + "ConfigureAgent": { + "http": { + "requestUri": "/profilingGroups/{profilingGroupName}/configureAgent", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "profilingGroupName" + ], + "members": { + "fleetInstanceId": {}, + "profilingGroupName": { + "location": "uri", + "locationName": "profilingGroupName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "configuration" + ], + "members": { + "configuration": { + "type": "structure", + "required": [ + "periodInSeconds", + "shouldProfile" + ], + "members": { + "periodInSeconds": { + "type": "integer" + }, + "shouldProfile": { + "type": "boolean" + } + } + } + }, + "payload": "configuration" + } + }, + "CreateProfilingGroup": { + "http": { + "requestUri": "/profilingGroups", + "responseCode": 201 + }, + "input": { + "type": "structure", + "required": [ + "clientToken", + "profilingGroupName" + ], + "members": { + "agentOrchestrationConfig": { + "shape": "S9" + }, + "clientToken": { + "idempotencyToken": true, + "location": "querystring", + "locationName": "clientToken" + }, + "profilingGroupName": {} + } + }, + "output": { + "type": "structure", + "required": [ + "profilingGroup" + ], + "members": { + "profilingGroup": { + "shape": "Sc" + } + }, + "payload": "profilingGroup" + }, + "idempotent": true + }, + "DeleteProfilingGroup": { + "http": { + "method": "DELETE", + "requestUri": "/profilingGroups/{profilingGroupName}", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "profilingGroupName" + ], + "members": { + "profilingGroupName": { + "location": "uri", + "locationName": "profilingGroupName" + } + } + }, + "output": { + "type": "structure", + "members": {} + }, + "idempotent": true + }, + "DescribeProfilingGroup": { + "http": { + "method": "GET", + "requestUri": "/profilingGroups/{profilingGroupName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "profilingGroupName" + ], + "members": { + "profilingGroupName": { + "location": "uri", + "locationName": "profilingGroupName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "profilingGroup" + ], + "members": { + "profilingGroup": { + "shape": "Sc" + } + }, + "payload": "profilingGroup" + } + }, + "GetProfile": { + "http": { + "method": "GET", + "requestUri": "/profilingGroups/{profilingGroupName}/profile", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "profilingGroupName" + ], + "members": { + "accept": { + "location": "header", + "locationName": "Accept" + }, + "endTime": { + "shape": "Se", + "location": "querystring", + "locationName": "endTime" + }, + "maxDepth": { + "location": "querystring", + "locationName": "maxDepth", + "type": "integer" + }, + "period": { + "location": "querystring", + "locationName": "period" + }, + "profilingGroupName": { + "location": "uri", + "locationName": "profilingGroupName" + }, + "startTime": { + "shape": "Se", + "location": "querystring", + "locationName": "startTime" + } + } + }, + "output": { + "type": "structure", + "required": [ + "contentType", + "profile" + ], + "members": { + "contentEncoding": { + "location": "header", + "locationName": "Content-Encoding" + }, + "contentType": { + "location": "header", + "locationName": "Content-Type" + }, + "profile": { + "type": "blob" + } + }, + "payload": "profile" + } + }, + "ListProfileTimes": { + "http": { + "method": "GET", + "requestUri": "/profilingGroups/{profilingGroupName}/profileTimes", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "endTime", + "period", + "profilingGroupName", + "startTime" + ], + "members": { + "endTime": { + "shape": "Se", + "location": "querystring", + "locationName": "endTime" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "orderBy": { + "location": "querystring", + "locationName": "orderBy" + }, + "period": { + "location": "querystring", + "locationName": "period" + }, + "profilingGroupName": { + "location": "uri", + "locationName": "profilingGroupName" + }, + "startTime": { + "shape": "Se", + "location": "querystring", + "locationName": "startTime" + } + } + }, + "output": { + "type": "structure", + "required": [ + "profileTimes" + ], + "members": { + "nextToken": {}, + "profileTimes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "start": { + "shape": "Se" + } + } + } + } + } + } + }, + "ListProfilingGroups": { + "http": { + "method": "GET", + "requestUri": "/profilingGroups", + "responseCode": 200 + }, + "input": { + "type": "structure", + "members": { + "includeDescription": { + "location": "querystring", + "locationName": "includeDescription", + "type": "boolean" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "required": [ + "profilingGroupNames" + ], + "members": { + "nextToken": {}, + "profilingGroupNames": { + "type": "list", + "member": {} + }, + "profilingGroups": { + "type": "list", + "member": { + "shape": "Sc" + } + } + } + } + }, + "PostAgentProfile": { + "http": { + "requestUri": "/profilingGroups/{profilingGroupName}/agentProfile", + "responseCode": 204 + }, + "input": { + "type": "structure", + "required": [ + "agentProfile", + "contentType", + "profilingGroupName" + ], + "members": { + "agentProfile": { + "type": "blob" + }, + "contentType": { + "location": "header", + "locationName": "Content-Type" + }, + "profileToken": { + "idempotencyToken": true, + "location": "querystring", + "locationName": "profileToken" + }, + "profilingGroupName": { + "location": "uri", + "locationName": "profilingGroupName" + } + }, + "payload": "agentProfile" + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateProfilingGroup": { + "http": { + "method": "PUT", + "requestUri": "/profilingGroups/{profilingGroupName}", + "responseCode": 200 + }, + "input": { + "type": "structure", + "required": [ + "agentOrchestrationConfig", + "profilingGroupName" + ], + "members": { + "agentOrchestrationConfig": { + "shape": "S9" + }, + "profilingGroupName": { + "location": "uri", + "locationName": "profilingGroupName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "profilingGroup" + ], + "members": { + "profilingGroup": { + "shape": "Sc" + } + }, + "payload": "profilingGroup" + }, + "idempotent": true + } + }, + "shapes": { + "S9": { + "type": "structure", + "required": [ + "profilingEnabled" + ], + "members": { + "profilingEnabled": { + "type": "boolean" + } + } + }, + "Sc": { + "type": "structure", + "members": { + "agentOrchestrationConfig": { + "shape": "S9" + }, + "arn": {}, + "createdAt": { + "shape": "Se" + }, + "name": {}, + "profilingStatus": { + "type": "structure", + "members": { + "latestAgentOrchestratedAt": { + "shape": "Se" + }, + "latestAgentProfileReportedAt": { + "shape": "Se" + }, + "latestAggregatedProfile": { + "type": "structure", + "members": { + "period": {}, + "start": { + "shape": "Se" + } + } + } + } + }, + "updatedAt": { + "shape": "Se" + } + } + }, + "Se": { + "type": "timestamp", + "timestampFormat": "iso8601" + } + } +} \ No newline at end of file diff --git a/apis/codeguruprofiler-2019-07-18.normal.json b/apis/codeguruprofiler-2019-07-18.normal.json new file mode 100644 index 0000000000..d228ce7db1 --- /dev/null +++ b/apis/codeguruprofiler-2019-07-18.normal.json @@ -0,0 +1,852 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-07-18", + "endpointPrefix": "codeguru-profiler", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "Amazon CodeGuru Profiler", + "serviceId": "CodeGuruProfiler", + "signatureVersion": "v4", + "signingName": "codeguru-profiler", + "uid": "codeguruprofiler-2019-07-18" + }, + "operations": { + "ConfigureAgent": { + "name": "ConfigureAgent", + "http": { + "method": "POST", + "requestUri": "/profilingGroups/{profilingGroupName}/configureAgent", + "responseCode": 200 + }, + "input": { + "shape": "ConfigureAgentRequest" + }, + "output": { + "shape": "ConfigureAgentResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Provides the configuration to use for an agent of the profiling group.
" + }, + "CreateProfilingGroup": { + "name": "CreateProfilingGroup", + "http": { + "method": "POST", + "requestUri": "/profilingGroups", + "responseCode": 201 + }, + "input": { + "shape": "CreateProfilingGroupRequest" + }, + "output": { + "shape": "CreateProfilingGroupResponse" + }, + "errors": [ + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Create a profiling group.
", + "idempotent": true + }, + "DeleteProfilingGroup": { + "name": "DeleteProfilingGroup", + "http": { + "method": "DELETE", + "requestUri": "/profilingGroups/{profilingGroupName}", + "responseCode": 204 + }, + "input": { + "shape": "DeleteProfilingGroupRequest" + }, + "output": { + "shape": "DeleteProfilingGroupResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Delete a profiling group.
", + "idempotent": true + }, + "DescribeProfilingGroup": { + "name": "DescribeProfilingGroup", + "http": { + "method": "GET", + "requestUri": "/profilingGroups/{profilingGroupName}", + "responseCode": 200 + }, + "input": { + "shape": "DescribeProfilingGroupRequest" + }, + "output": { + "shape": "DescribeProfilingGroupResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Describe a profiling group.
" + }, + "GetProfile": { + "name": "GetProfile", + "http": { + "method": "GET", + "requestUri": "/profilingGroups/{profilingGroupName}/profile", + "responseCode": 200 + }, + "input": { + "shape": "GetProfileRequest" + }, + "output": { + "shape": "GetProfileResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Get the aggregated profile of a profiling group for the specified time range. If the requested time range does not align with the available aggregated profiles, it will be expanded to attain alignment. If aggregated profiles are available only for part of the period requested, the profile is returned from the earliest available to the latest within the requested time range. For instance, if the requested time range is from 00:00 to 00:20 and the available profiles are from 00:15 to 00:25, then the returned profile will be from 00:15 to 00:20.
" + }, + "ListProfileTimes": { + "name": "ListProfileTimes", + "http": { + "method": "GET", + "requestUri": "/profilingGroups/{profilingGroupName}/profileTimes", + "responseCode": 200 + }, + "input": { + "shape": "ListProfileTimesRequest" + }, + "output": { + "shape": "ListProfileTimesResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "List the start times of the available aggregated profiles of a profiling group for an aggregation period within the specified time range.
" + }, + "ListProfilingGroups": { + "name": "ListProfilingGroups", + "http": { + "method": "GET", + "requestUri": "/profilingGroups", + "responseCode": 200 + }, + "input": { + "shape": "ListProfilingGroupsRequest" + }, + "output": { + "shape": "ListProfilingGroupsResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "List profiling groups in the account.
" + }, + "PostAgentProfile": { + "name": "PostAgentProfile", + "http": { + "method": "POST", + "requestUri": "/profilingGroups/{profilingGroupName}/agentProfile", + "responseCode": 204 + }, + "input": { + "shape": "PostAgentProfileRequest" + }, + "output": { + "shape": "PostAgentProfileResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Submit profile collected by an agent belonging to a profiling group for aggregation.
" + }, + "UpdateProfilingGroup": { + "name": "UpdateProfilingGroup", + "http": { + "method": "PUT", + "requestUri": "/profilingGroups/{profilingGroupName}", + "responseCode": 200 + }, + "input": { + "shape": "UpdateProfilingGroupRequest" + }, + "output": { + "shape": "UpdateProfilingGroupResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Update a profiling group.
", + "idempotent": true + } + }, + "shapes": { + "AgentConfiguration": { + "type": "structure", + "required": [ + "periodInSeconds", + "shouldProfile" + ], + "members": { + "periodInSeconds": { + "shape": "Integer", + "documentation": "Specifies the period to follow the configuration (to profile or not) and call back to get a new configuration.
" + }, + "shouldProfile": { + "shape": "Boolean", + "documentation": "Specifies if the profiling should be enabled by the agent.
" + } + }, + "documentation": "The configuration for the agent to use.
" + }, + "AgentOrchestrationConfig": { + "type": "structure", + "required": [ + "profilingEnabled" + ], + "members": { + "profilingEnabled": { + "shape": "Boolean", + "documentation": "If the agents should be enabled to create and report profiles.
" + } + }, + "documentation": "Configuration to orchestrate agents to create and report agent profiles of the profiling group. Agents are orchestrated if they follow the agent orchestration protocol.
" + }, + "AgentProfile": { + "type": "blob", + "documentation": "The profile collected by an agent for a time range.
" + }, + "AggregatedProfile": { + "type": "blob", + "documentation": "The profile representing the aggregation of agent profiles of the profiling group for a time range.
" + }, + "AggregatedProfileTime": { + "type": "structure", + "members": { + "period": { + "shape": "AggregationPeriod", + "documentation": "The aggregation period of the aggregated profile.
" + }, + "start": { + "shape": "Timestamp", + "documentation": "The start time of the aggregated profile.
" + } + }, + "documentation": "The time range of an aggregated profile.
" + }, + "AggregationPeriod": { + "type": "string", + "documentation": "Periods of time used for aggregation of profiles, represented using ISO 8601 format.
", + "enum": [ + "P1D", + "PT1H", + "PT5M" + ] + }, + "Boolean": { + "type": "boolean", + "box": true + }, + "ClientToken": { + "type": "string", + "documentation": "Client token for the request.
", + "max": 64, + "min": 1, + "pattern": "^[\\w-]+$" + }, + "ConfigureAgentRequest": { + "type": "structure", + "required": [ + "profilingGroupName" + ], + "members": { + "fleetInstanceId": { + "shape": "FleetInstanceId" + }, + "profilingGroupName": { + "shape": "ProfilingGroupName", + "location": "uri", + "locationName": "profilingGroupName" + } + }, + "documentation": "Request for ConfigureAgent operation.
" + }, + "ConfigureAgentResponse": { + "type": "structure", + "required": [ + "configuration" + ], + "members": { + "configuration": { + "shape": "AgentConfiguration", + "documentation": "The configuration for the agent to use.
" + } + }, + "documentation": "Response for ConfigureAgent operation.
", + "payload": "configuration" + }, + "CreateProfilingGroupRequest": { + "type": "structure", + "required": [ + "clientToken", + "profilingGroupName" + ], + "members": { + "agentOrchestrationConfig": { + "shape": "AgentOrchestrationConfig" + }, + "clientToken": { + "shape": "ClientToken", + "idempotencyToken": true, + "location": "querystring", + "locationName": "clientToken" + }, + "profilingGroupName": { + "shape": "ProfilingGroupName" + } + }, + "documentation": "Request for CreateProfilingGroup operation.
" + }, + "CreateProfilingGroupResponse": { + "type": "structure", + "required": [ + "profilingGroup" + ], + "members": { + "profilingGroup": { + "shape": "ProfilingGroupDescription" + } + }, + "documentation": "Response for CreateProfilingGroup operation.
", + "payload": "profilingGroup" + }, + "DeleteProfilingGroupRequest": { + "type": "structure", + "required": [ + "profilingGroupName" + ], + "members": { + "profilingGroupName": { + "shape": "ProfilingGroupName", + "location": "uri", + "locationName": "profilingGroupName" + } + }, + "documentation": "Request for DeleteProfilingGroup operation.
" + }, + "DeleteProfilingGroupResponse": { + "type": "structure", + "members": {}, + "documentation": "Response for DeleteProfilingGroup operation.
" + }, + "DescribeProfilingGroupRequest": { + "type": "structure", + "required": [ + "profilingGroupName" + ], + "members": { + "profilingGroupName": { + "shape": "ProfilingGroupName", + "location": "uri", + "locationName": "profilingGroupName" + } + }, + "documentation": "Request for DescribeProfilingGroup operation.
" + }, + "DescribeProfilingGroupResponse": { + "type": "structure", + "required": [ + "profilingGroup" + ], + "members": { + "profilingGroup": { + "shape": "ProfilingGroupDescription" + } + }, + "documentation": "Response for DescribeProfilingGroup operation.
", + "payload": "profilingGroup" + }, + "FleetInstanceId": { + "type": "string", + "documentation": "Identifier of the instance of compute fleet being profiled by the agent. For instance, host name in EC2, task id for ECS, function name for AWS Lambda
", + "max": 255, + "min": 1, + "pattern": "^[\\w-.:/]+$" + }, + "GetProfileRequest": { + "type": "structure", + "required": [ + "profilingGroupName" + ], + "members": { + "accept": { + "shape": "String", + "documentation": "The format of the profile to return. Supports application/json or application/x-amzn-ion. Defaults to application/x-amzn-ion.
", + "location": "header", + "locationName": "Accept" + }, + "endTime": { + "shape": "Timestamp", + "documentation": "The end time of the profile to get. Either period or endTime must be specified. Must be greater than start and the overall time range to be in the past and not larger than a week.
", + "location": "querystring", + "locationName": "endTime" + }, + "maxDepth": { + "shape": "MaxDepth", + "location": "querystring", + "locationName": "maxDepth" + }, + "period": { + "shape": "Period", + "documentation": "The period of the profile to get. Exactly two of startTime
, period
and endTime
must be specified. Must be positive and the overall time range to be in the past and not larger than a week.
The start time of the profile to get.
", + "location": "querystring", + "locationName": "startTime" + } + }, + "documentation": "Request for GetProfile operation.
" + }, + "GetProfileResponse": { + "type": "structure", + "required": [ + "contentType", + "profile" + ], + "members": { + "contentEncoding": { + "shape": "String", + "documentation": "The content encoding of the profile in the payload.
", + "location": "header", + "locationName": "Content-Encoding" + }, + "contentType": { + "shape": "String", + "documentation": "The content type of the profile in the payload. Will be application/json or application/x-amzn-ion based on Accept header in the request.
", + "location": "header", + "locationName": "Content-Type" + }, + "profile": { + "shape": "AggregatedProfile" + } + }, + "documentation": "Response for GetProfile operation.
", + "payload": "profile" + }, + "Integer": { + "type": "integer", + "box": true + }, + "ListProfileTimesRequest": { + "type": "structure", + "required": [ + "endTime", + "period", + "profilingGroupName", + "startTime" + ], + "members": { + "endTime": { + "shape": "Timestamp", + "documentation": "The end time of the time range to list profiles until.
", + "location": "querystring", + "locationName": "endTime" + }, + "maxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "PaginationToken", + "location": "querystring", + "locationName": "nextToken" + }, + "orderBy": { + "shape": "OrderBy", + "documentation": "The order (ascending or descending by start time of the profile) to list the profiles by. Defaults to TIMESTAMP_DESCENDING.
", + "location": "querystring", + "locationName": "orderBy" + }, + "period": { + "shape": "AggregationPeriod", + "documentation": "The aggregation period to list the profiles for.
", + "location": "querystring", + "locationName": "period" + }, + "profilingGroupName": { + "shape": "ProfilingGroupName", + "location": "uri", + "locationName": "profilingGroupName" + }, + "startTime": { + "shape": "Timestamp", + "documentation": "The start time of the time range to list the profiles from.
", + "location": "querystring", + "locationName": "startTime" + } + }, + "documentation": "Request for ListProfileTimes operation.
" + }, + "ListProfileTimesResponse": { + "type": "structure", + "required": [ + "profileTimes" + ], + "members": { + "nextToken": { + "shape": "PaginationToken" + }, + "profileTimes": { + "shape": "ProfileTimes", + "documentation": "List of start times of the available profiles for the aggregation period in the specified time range.
" + } + }, + "documentation": "Response for ListProfileTimes operation.
" + }, + "ListProfilingGroupsRequest": { + "type": "structure", + "members": { + "includeDescription": { + "shape": "Boolean", + "documentation": "If set to true, returns the full description of the profiling groups instead of the names. Defaults to false.
", + "location": "querystring", + "locationName": "includeDescription" + }, + "maxResults": { + "shape": "MaxResults", + "location": "querystring", + "locationName": "maxResults" + }, + "nextToken": { + "shape": "PaginationToken", + "location": "querystring", + "locationName": "nextToken" + } + }, + "documentation": "Request for ListProfilingGroups operation.
" + }, + "ListProfilingGroupsResponse": { + "type": "structure", + "required": [ + "profilingGroupNames" + ], + "members": { + "nextToken": { + "shape": "PaginationToken" + }, + "profilingGroupNames": { + "shape": "ProfilingGroupNames" + }, + "profilingGroups": { + "shape": "ProfilingGroupDescriptions" + } + }, + "documentation": "Response for ListProfilingGroups operation.
" + }, + "MaxDepth": { + "type": "integer", + "documentation": "Limit the max depth of the profile.
", + "box": true, + "max": 10000, + "min": 1 + }, + "MaxResults": { + "type": "integer", + "documentation": "Upper bound on the number of results to list in a single call.
", + "box": true, + "max": 1000, + "min": 1 + }, + "OrderBy": { + "type": "string", + "enum": [ + "TimestampAscending", + "TimestampDescending" + ] + }, + "PaginationToken": { + "type": "string", + "documentation": "Token for paginating results.
", + "max": 64, + "min": 1, + "pattern": "^[\\w-]+$" + }, + "Period": { + "type": "string", + "documentation": "Periods of time represented using ISO 8601 format.
", + "max": 64, + "min": 1 + }, + "PostAgentProfileRequest": { + "type": "structure", + "required": [ + "agentProfile", + "contentType", + "profilingGroupName" + ], + "members": { + "agentProfile": { + "shape": "AgentProfile" + }, + "contentType": { + "shape": "String", + "documentation": "The content type of the agent profile in the payload. Recommended to send the profile gzipped with content-type application/octet-stream. Other accepted values are application/x-amzn-ion and application/json for unzipped Ion and JSON respectively.
", + "location": "header", + "locationName": "Content-Type" + }, + "profileToken": { + "shape": "ClientToken", + "documentation": "Client generated token to deduplicate the agent profile during aggregation.
", + "idempotencyToken": true, + "location": "querystring", + "locationName": "profileToken" + }, + "profilingGroupName": { + "shape": "ProfilingGroupName", + "location": "uri", + "locationName": "profilingGroupName" + } + }, + "documentation": "Request for PostAgentProfile operation.
", + "payload": "agentProfile" + }, + "PostAgentProfileResponse": { + "type": "structure", + "members": {}, + "documentation": "Response for PostAgentProfile operation.
" + }, + "ProfileTime": { + "type": "structure", + "members": { + "start": { + "shape": "Timestamp", + "documentation": "The start time of the profile.
" + } + }, + "documentation": "Periods of time used for aggregation of profiles, represented using ISO 8601 format.
" + }, + "ProfileTimes": { + "type": "list", + "member": { + "shape": "ProfileTime" + }, + "documentation": "List of profile times.
" + }, + "ProfilingGroupArn": { + "type": "string", + "documentation": "The ARN of the profiling group.
" + }, + "ProfilingGroupDescription": { + "type": "structure", + "members": { + "agentOrchestrationConfig": { + "shape": "AgentOrchestrationConfig" + }, + "arn": { + "shape": "ProfilingGroupArn" + }, + "createdAt": { + "shape": "Timestamp", + "documentation": "The timestamp of when the profiling group was created.
" + }, + "name": { + "shape": "ProfilingGroupName" + }, + "profilingStatus": { + "shape": "ProfilingStatus" + }, + "updatedAt": { + "shape": "Timestamp", + "documentation": "The timestamp of when the profiling group was last updated.
" + } + }, + "documentation": "The description of a profiling group.
" + }, + "ProfilingGroupDescriptions": { + "type": "list", + "member": { + "shape": "ProfilingGroupDescription" + }, + "documentation": "List of profiling group descriptions.
" + }, + "ProfilingGroupName": { + "type": "string", + "documentation": "The name of the profiling group.
", + "max": 255, + "min": 1, + "pattern": "^[\\w-]+$" + }, + "ProfilingGroupNames": { + "type": "list", + "member": { + "shape": "ProfilingGroupName" + }, + "documentation": "List of profiling group names.
" + }, + "ProfilingStatus": { + "type": "structure", + "members": { + "latestAgentOrchestratedAt": { + "shape": "Timestamp", + "documentation": "Timestamp of when the last interaction of the agent with configureAgent API for orchestration.
" + }, + "latestAgentProfileReportedAt": { + "shape": "Timestamp", + "documentation": "Timestamp of when the latest agent profile was successfully reported.
" + }, + "latestAggregatedProfile": { + "shape": "AggregatedProfileTime", + "documentation": "The time range of latest aggregated profile available.
" + } + }, + "documentation": "The status of profiling of a profiling group.
" + }, + "String": { + "type": "string" + }, + "Timestamp": { + "type": "timestamp", + "timestampFormat": "iso8601" + }, + "UpdateProfilingGroupRequest": { + "type": "structure", + "required": [ + "agentOrchestrationConfig", + "profilingGroupName" + ], + "members": { + "agentOrchestrationConfig": { + "shape": "AgentOrchestrationConfig", + "documentation": "Remote configuration to configure the agents of the profiling group.
" + }, + "profilingGroupName": { + "shape": "ProfilingGroupName", + "location": "uri", + "locationName": "profilingGroupName" + } + }, + "documentation": "Request for UpdateProfilingGroup operation.
" + }, + "UpdateProfilingGroupResponse": { + "type": "structure", + "required": [ + "profilingGroup" + ], + "members": { + "profilingGroup": { + "shape": "ProfilingGroupDescription" + } + }, + "documentation": "Response for UpdateProfilingGroup operation.
", + "payload": "profilingGroup" + } + }, + "documentation": "Example service documentation.
" +} \ No newline at end of file diff --git a/apis/codeguruprofiler-2019-07-18.paginators.json b/apis/codeguruprofiler-2019-07-18.paginators.json new file mode 100644 index 0000000000..afbbca8aab --- /dev/null +++ b/apis/codeguruprofiler-2019-07-18.paginators.json @@ -0,0 +1,14 @@ +{ + "pagination": { + "ListProfileTimes": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "ListProfilingGroups": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/apis/compute-optimizer-2019-11-01.examples.json b/apis/compute-optimizer-2019-11-01.examples.json new file mode 100644 index 0000000000..0ea7e3b0bb --- /dev/null +++ b/apis/compute-optimizer-2019-11-01.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/apis/compute-optimizer-2019-11-01.min.json b/apis/compute-optimizer-2019-11-01.min.json new file mode 100644 index 0000000000..5d8c302de1 --- /dev/null +++ b/apis/compute-optimizer-2019-11-01.min.json @@ -0,0 +1,380 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-11-01", + "endpointPrefix": "compute-optimizer", + "jsonVersion": "1.0", + "protocol": "json", + "serviceFullName": "AWS Compute Optimizer", + "serviceId": "Compute Optimizer", + "signatureVersion": "v4", + "signingName": "compute-optimizer", + "targetPrefix": "ComputeOptimizerService", + "uid": "compute-optimizer-2019-11-01" + }, + "operations": { + "GetAutoScalingGroupRecommendations": { + "input": { + "type": "structure", + "members": { + "accountIds": { + "shape": "S2" + }, + "autoScalingGroupArns": { + "type": "list", + "member": {} + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "filters": { + "shape": "S8" + } + } + }, + "output": { + "type": "structure", + "members": { + "nextToken": {}, + "autoScalingGroupRecommendations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "accountId": {}, + "autoScalingGroupArn": {}, + "autoScalingGroupName": {}, + "finding": {}, + "utilizationMetrics": { + "shape": "Si" + }, + "lookBackPeriodInDays": { + "type": "double" + }, + "currentConfiguration": { + "shape": "So" + }, + "recommendationOptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "configuration": { + "shape": "So" + }, + "projectedUtilizationMetrics": { + "shape": "Sv" + }, + "performanceRisk": { + "type": "double" + }, + "rank": { + "type": "integer" + } + } + } + }, + "lastRefreshTimestamp": { + "type": "timestamp" + } + } + } + }, + "errors": { + "shape": "Sz" + } + } + } + }, + "GetEC2InstanceRecommendations": { + "input": { + "type": "structure", + "members": { + "instanceArns": { + "type": "list", + "member": {} + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + }, + "filters": { + "shape": "S8" + }, + "accountIds": { + "shape": "S2" + } + } + }, + "output": { + "type": "structure", + "members": { + "nextToken": {}, + "instanceRecommendations": { + "type": "list", + "member": { + "type": "structure", + "members": { + "instanceArn": {}, + "accountId": {}, + "instanceName": {}, + "currentInstanceType": {}, + "finding": {}, + "utilizationMetrics": { + "shape": "Si" + }, + "lookBackPeriodInDays": { + "type": "double" + }, + "recommendationOptions": { + "type": "list", + "member": { + "type": "structure", + "members": { + "instanceType": {}, + "projectedUtilizationMetrics": { + "shape": "Sv" + }, + "performanceRisk": { + "type": "double" + }, + "rank": { + "type": "integer" + } + } + } + }, + "recommendationSources": { + "type": "list", + "member": { + "type": "structure", + "members": { + "recommendationSourceArn": {}, + "recommendationSourceType": {} + } + } + }, + "lastRefreshTimestamp": { + "type": "timestamp" + } + } + } + }, + "errors": { + "shape": "Sz" + } + } + } + }, + "GetEC2RecommendationProjectedMetrics": { + "input": { + "type": "structure", + "required": [ + "instanceArn", + "stat", + "period", + "startTime", + "endTime" + ], + "members": { + "instanceArn": {}, + "stat": {}, + "period": { + "type": "integer" + }, + "startTime": { + "type": "timestamp" + }, + "endTime": { + "type": "timestamp" + } + } + }, + "output": { + "type": "structure", + "members": { + "recommendedOptionProjectedMetrics": { + "type": "list", + "member": { + "type": "structure", + "members": { + "recommendedInstanceType": {}, + "rank": { + "type": "integer" + }, + "projectedMetrics": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "timestamps": { + "type": "list", + "member": { + "type": "timestamp" + } + }, + "values": { + "type": "list", + "member": { + "type": "double" + } + } + } + } + } + } + } + } + } + } + }, + "GetEnrollmentStatus": { + "input": { + "type": "structure", + "members": {} + }, + "output": { + "type": "structure", + "members": { + "status": {}, + "statusReason": {}, + "memberAccountsEnrolled": { + "type": "boolean" + } + } + } + }, + "GetRecommendationSummaries": { + "input": { + "type": "structure", + "members": { + "accountIds": { + "shape": "S2" + }, + "nextToken": {}, + "maxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "nextToken": {}, + "recommendationSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "summaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "value": { + "type": "double" + } + } + } + }, + "recommendationResourceType": {}, + "accountId": {} + } + } + } + } + } + }, + "UpdateEnrollmentStatus": { + "input": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": {}, + "includeMemberAccounts": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "status": {}, + "statusReason": {} + } + } + } + }, + "shapes": { + "S2": { + "type": "list", + "member": {} + }, + "S8": { + "type": "list", + "member": { + "type": "structure", + "members": { + "name": {}, + "values": { + "type": "list", + "member": {} + } + } + } + }, + "Si": { + "type": "list", + "member": { + "shape": "Sj" + } + }, + "Sj": { + "type": "structure", + "members": { + "name": {}, + "statistic": {}, + "value": { + "type": "double" + } + } + }, + "So": { + "type": "structure", + "members": { + "desiredCapacity": { + "type": "integer" + }, + "minSize": { + "type": "integer" + }, + "maxSize": { + "type": "integer" + }, + "instanceType": {} + } + }, + "Sv": { + "type": "list", + "member": { + "shape": "Sj" + } + }, + "Sz": { + "type": "list", + "member": { + "type": "structure", + "members": { + "identifier": {}, + "code": {}, + "message": {} + } + } + } + } +} \ No newline at end of file diff --git a/apis/compute-optimizer-2019-11-01.normal.json b/apis/compute-optimizer-2019-11-01.normal.json new file mode 100644 index 0000000000..b851429951 --- /dev/null +++ b/apis/compute-optimizer-2019-11-01.normal.json @@ -0,0 +1,986 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-11-01", + "endpointPrefix": "compute-optimizer", + "jsonVersion": "1.0", + "protocol": "json", + "serviceFullName": "AWS Compute Optimizer", + "serviceId": "Compute Optimizer", + "signatureVersion": "v4", + "signingName": "compute-optimizer", + "targetPrefix": "ComputeOptimizerService", + "uid": "compute-optimizer-2019-11-01" + }, + "operations": { + "GetAutoScalingGroupRecommendations": { + "name": "GetAutoScalingGroupRecommendations", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetAutoScalingGroupRecommendationsRequest" + }, + "output": { + "shape": "GetAutoScalingGroupRecommendationsResponse" + }, + "errors": [ + { + "shape": "OptInRequiredException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InvalidParameterValueException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "MissingAuthenticationToken" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Returns Auto Scaling group recommendations.
AWS Compute Optimizer currently generates recommendations for Auto Scaling groups that are configured to run instances of the M, C, R, T, and X instance families. The service does not generate recommendations for Auto Scaling groups that have a scaling policy attached to them, or that do not have the same values for desired, minimum, and maximum capacity. In order for Compute Optimizer to analyze your Auto Scaling groups, they must be of a fixed size. For more information, see the AWS Compute Optimizer User Guide.
" + }, + "GetEC2InstanceRecommendations": { + "name": "GetEC2InstanceRecommendations", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetEC2InstanceRecommendationsRequest" + }, + "output": { + "shape": "GetEC2InstanceRecommendationsResponse" + }, + "errors": [ + { + "shape": "OptInRequiredException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InvalidParameterValueException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "MissingAuthenticationToken" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Returns Amazon EC2 instance recommendations.
AWS Compute Optimizer currently generates recommendations for Amazon Elastic Compute Cloud (Amazon EC2) and Amazon EC2 Auto Scaling. It generates recommendations for M, C, R, T, and X instance families. For more information, see the AWS Compute Optimizer User Guide.
" + }, + "GetEC2RecommendationProjectedMetrics": { + "name": "GetEC2RecommendationProjectedMetrics", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetEC2RecommendationProjectedMetricsRequest" + }, + "output": { + "shape": "GetEC2RecommendationProjectedMetricsResponse" + }, + "errors": [ + { + "shape": "OptInRequiredException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InvalidParameterValueException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "MissingAuthenticationToken" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Returns the projected utilization metrics of Amazon EC2 instance recommendations.
" + }, + "GetEnrollmentStatus": { + "name": "GetEnrollmentStatus", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetEnrollmentStatusRequest" + }, + "output": { + "shape": "GetEnrollmentStatusResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InvalidParameterValueException" + }, + { + "shape": "MissingAuthenticationToken" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Returns the enrollment (opt in) status of an account to the AWS Compute Optimizer service.
If the account is a master account of an organization, this operation also confirms the enrollment status of member accounts within the organization.
" + }, + "GetRecommendationSummaries": { + "name": "GetRecommendationSummaries", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetRecommendationSummariesRequest" + }, + "output": { + "shape": "GetRecommendationSummariesResponse" + }, + "errors": [ + { + "shape": "OptInRequiredException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InvalidParameterValueException" + }, + { + "shape": "MissingAuthenticationToken" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Returns the optimization findings for an account.
For example, it returns the number of Amazon EC2 instances in an account that are under-provisioned, over-provisioned, or optimized. It also returns the number of Auto Scaling groups in an account that are not optimized, or optimized.
" + }, + "UpdateEnrollmentStatus": { + "name": "UpdateEnrollmentStatus", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdateEnrollmentStatusRequest" + }, + "output": { + "shape": "UpdateEnrollmentStatusResponse" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceUnavailableException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InvalidParameterValueException" + }, + { + "shape": "MissingAuthenticationToken" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Updates the enrollment (opt in) status of an account to the AWS Compute Optimizer service.
If the account is a master account of an organization, this operation can also enroll member accounts within the organization.
" + } + }, + "shapes": { + "AccountId": { + "type": "string" + }, + "AccountIds": { + "type": "list", + "member": { + "shape": "AccountId" + } + }, + "AutoScalingGroupArn": { + "type": "string" + }, + "AutoScalingGroupArns": { + "type": "list", + "member": { + "shape": "AutoScalingGroupArn" + } + }, + "AutoScalingGroupConfiguration": { + "type": "structure", + "members": { + "desiredCapacity": { + "shape": "DesiredCapacity", + "documentation": "The desired capacity, or number of instances, for the Auto Scaling group.
" + }, + "minSize": { + "shape": "MinSize", + "documentation": "The minimum size, or minimum number of instances, for the Auto Scaling group.
" + }, + "maxSize": { + "shape": "MaxSize", + "documentation": "The maximum size, or maximum number of instances, for the Auto Scaling group.
" + }, + "instanceType": { + "shape": "InstanceType", + "documentation": "The instance type for the Auto Scaling group.
" + } + }, + "documentation": "Describes the configuration of an Auto Scaling group.
" + }, + "AutoScalingGroupName": { + "type": "string" + }, + "AutoScalingGroupRecommendation": { + "type": "structure", + "members": { + "accountId": { + "shape": "AccountId", + "documentation": "The AWS account ID of the Auto Scaling group.
" + }, + "autoScalingGroupArn": { + "shape": "AutoScalingGroupArn", + "documentation": "The Amazon Resource Name (ARN) of the Auto Scaling group.
" + }, + "autoScalingGroupName": { + "shape": "AutoScalingGroupName", + "documentation": "The name of the Auto Scaling group.
" + }, + "finding": { + "shape": "Finding", + "documentation": "The finding classification for the Auto Scaling group.
Findings for Auto Scaling groups include:
NotOptimized
—An Auto Scaling group is considered not optimized when AWS Compute Optimizer identifies a recommendation that can provide better performance for your workload.
Optimized
—An Auto Scaling group is considered optimized when Compute Optimizer determines that the group is correctly provisioned to run your workload based on the chosen instance type. For optimized resources, Compute Optimizer might recommend a new generation instance type.
The values that are returned might be NOT_OPTIMIZED
or OPTIMIZED
.
An array of objects that describe the utilization metrics of the Auto Scaling group.
" + }, + "lookBackPeriodInDays": { + "shape": "LookBackPeriodInDays", + "documentation": "The number of days for which utilization metrics were analyzed for the Auto Scaling group.
" + }, + "currentConfiguration": { + "shape": "AutoScalingGroupConfiguration", + "documentation": "An array of objects that describe the current configuration of the Auto Scaling group.
" + }, + "recommendationOptions": { + "shape": "AutoScalingGroupRecommendationOptions", + "documentation": "An array of objects that describe the recommendation options for the Auto Scaling group.
" + }, + "lastRefreshTimestamp": { + "shape": "LastRefreshTimestamp", + "documentation": "The time stamp of when the Auto Scaling group recommendation was last refreshed.
" + } + }, + "documentation": "Describes an Auto Scaling group recommendation.
" + }, + "AutoScalingGroupRecommendationOption": { + "type": "structure", + "members": { + "configuration": { + "shape": "AutoScalingGroupConfiguration", + "documentation": "An array of objects that describe an Auto Scaling group configuration.
" + }, + "projectedUtilizationMetrics": { + "shape": "ProjectedUtilizationMetrics", + "documentation": "An array of objects that describe the projected utilization metrics of the Auto Scaling group recommendation option.
" + }, + "performanceRisk": { + "shape": "PerformanceRisk", + "documentation": "The performance risk of the Auto Scaling group configuration recommendation.
Performance risk is the likelihood of the recommended instance type not meeting the performance requirement of your workload.
The lowest performance risk is categorized as 0
, and the highest as 5
.
The rank of the Auto Scaling group recommendation option.
The top recommendation option is ranked as 1
.
Describes a recommendation option for an Auto Scaling group.
" + }, + "AutoScalingGroupRecommendationOptions": { + "type": "list", + "member": { + "shape": "AutoScalingGroupRecommendationOption" + } + }, + "AutoScalingGroupRecommendations": { + "type": "list", + "member": { + "shape": "AutoScalingGroupRecommendation" + } + }, + "Code": { + "type": "string" + }, + "CurrentInstanceType": { + "type": "string" + }, + "DesiredCapacity": { + "type": "integer" + }, + "Filter": { + "type": "structure", + "members": { + "name": { + "shape": "FilterName", + "documentation": "The name of the filter.
Specify Finding
to filter the results to a specific findings classification.
Specify RecommendationSourceType
to filter the results to a specific resource type.
The value of the filter.
If you specify the name
parameter as Finding
, and you're recommendations for an instance, then the valid values are Underprovisioned
, Overprovisioned
, NotOptimized
, or Optimized
.
If you specify the name
parameter as Finding
, and you're recommendations for an Auto Scaling group, then the valid values are Optimized
, or NotOptimized
.
If you specify the name
parameter as RecommendationSourceType
, then the valid values are EC2Instance
, or AutoScalingGroup
.
Describes a filter that returns a more specific list of recommendations.
" + }, + "FilterName": { + "type": "string", + "enum": [ + "Finding", + "RecommendationSourceType" + ] + }, + "FilterValue": { + "type": "string" + }, + "FilterValues": { + "type": "list", + "member": { + "shape": "FilterValue" + } + }, + "Filters": { + "type": "list", + "member": { + "shape": "Filter" + } + }, + "Finding": { + "type": "string", + "enum": [ + "Underprovisioned", + "Overprovisioned", + "Optimized", + "NotOptimized" + ] + }, + "GetAutoScalingGroupRecommendationsRequest": { + "type": "structure", + "members": { + "accountIds": { + "shape": "AccountIds", + "documentation": "The AWS account IDs for which to return Auto Scaling group recommendations.
Only one account ID can be specified per request.
" + }, + "autoScalingGroupArns": { + "shape": "AutoScalingGroupArns", + "documentation": "The Amazon Resource Name (ARN) of the Auto Scaling groups for which to return recommendations.
" + }, + "nextToken": { + "shape": "NextToken", + "documentation": "The token to advance to the next page of Auto Scaling group recommendations.
" + }, + "maxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of Auto Scaling group recommendations to return with a single call.
To retrieve the remaining results, make another call with the returned NextToken
value.
An array of objects that describe a filter that returns a more specific list of Auto Scaling group recommendations.
" + } + } + }, + "GetAutoScalingGroupRecommendationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "shape": "NextToken", + "documentation": "The token to use to advance to the next page of Auto Scaling group recommendations.
This value is null when there are no more pages of Auto Scaling group recommendations to return.
" + }, + "autoScalingGroupRecommendations": { + "shape": "AutoScalingGroupRecommendations", + "documentation": "An array of objects that describe Auto Scaling group recommendations.
" + }, + "errors": { + "shape": "GetRecommendationErrors", + "documentation": "An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an unsupported Auto Scaling group.
" + } + } + }, + "GetEC2InstanceRecommendationsRequest": { + "type": "structure", + "members": { + "instanceArns": { + "shape": "InstanceArns", + "documentation": "The Amazon Resource Name (ARN) of the instances for which to return recommendations.
" + }, + "nextToken": { + "shape": "NextToken", + "documentation": "The token to advance to the next page of instance recommendations.
" + }, + "maxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of instance recommendations to return with a single call.
To retrieve the remaining results, make another call with the returned NextToken
value.
An array of objects that describe a filter that returns a more specific list of instance recommendations.
" + }, + "accountIds": { + "shape": "AccountIds", + "documentation": "The AWS account IDs for which to return instance recommendations.
Only one account ID can be specified per request.
" + } + } + }, + "GetEC2InstanceRecommendationsResponse": { + "type": "structure", + "members": { + "nextToken": { + "shape": "NextToken", + "documentation": "The token to use to advance to the next page of instance recommendations.
This value is null when there are no more pages of instance recommendations to return.
" + }, + "instanceRecommendations": { + "shape": "InstanceRecommendations", + "documentation": "An array of objects that describe instance recommendations.
" + }, + "errors": { + "shape": "GetRecommendationErrors", + "documentation": "An array of objects that describe errors of the request.
For example, an error is returned if you request recommendations for an instance of an unsupported instance family.
" + } + } + }, + "GetEC2RecommendationProjectedMetricsRequest": { + "type": "structure", + "required": [ + "instanceArn", + "stat", + "period", + "startTime", + "endTime" + ], + "members": { + "instanceArn": { + "shape": "InstanceArn", + "documentation": "The Amazon Resource Name (ARN) of the instances for which to return recommendation projected metrics.
" + }, + "stat": { + "shape": "MetricStatistic", + "documentation": "The statistic of the projected metrics.
" + }, + "period": { + "shape": "Period", + "documentation": "The granularity, in seconds, of the projected metrics data points.
" + }, + "startTime": { + "shape": "Timestamp", + "documentation": "The time stamp of the first projected metrics data point to return.
" + }, + "endTime": { + "shape": "Timestamp", + "documentation": "The time stamp of the last projected metrics data point to return.
" + } + } + }, + "GetEC2RecommendationProjectedMetricsResponse": { + "type": "structure", + "members": { + "recommendedOptionProjectedMetrics": { + "shape": "RecommendedOptionProjectedMetrics", + "documentation": "An array of objects that describe a projected metrics.
" + } + } + }, + "GetEnrollmentStatusRequest": { + "type": "structure", + "members": {} + }, + "GetEnrollmentStatusResponse": { + "type": "structure", + "members": { + "status": { + "shape": "Status", + "documentation": "The enrollment status of the account.
" + }, + "statusReason": { + "shape": "StatusReason", + "documentation": "The reason for the enrollment status of the account.
For example, an account might show a status of Pending
because member accounts of an organization require more time to be enrolled in the service.
Confirms the enrollment status of member accounts within the organization, if the account is a master account of an organization.
" + } + } + }, + "GetRecommendationError": { + "type": "structure", + "members": { + "identifier": { + "shape": "Identifier", + "documentation": "The ID of the error.
" + }, + "code": { + "shape": "Code", + "documentation": "The error code.
" + }, + "message": { + "shape": "Message", + "documentation": "The message, or reason, for the error.
" + } + }, + "documentation": "Describes an error experienced when getting recommendations.
For example, an error is returned if you request recommendations for an unsupported Auto Scaling group, or if you request recommendations for an instance of an unsupported instance family.
" + }, + "GetRecommendationErrors": { + "type": "list", + "member": { + "shape": "GetRecommendationError" + } + }, + "GetRecommendationSummariesRequest": { + "type": "structure", + "members": { + "accountIds": { + "shape": "AccountIds", + "documentation": "The AWS account IDs for which to return recommendation summaries.
Only one account ID can be specified per request.
" + }, + "nextToken": { + "shape": "NextToken", + "documentation": "The token to advance to the next page of recommendation summaries.
" + }, + "maxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of recommendation summaries to return with a single call.
To retrieve the remaining results, make another call with the returned NextToken
value.
The token to use to advance to the next page of recommendation summaries.
This value is null when there are no more pages of recommendation summaries to return.
" + }, + "recommendationSummaries": { + "shape": "RecommendationSummaries", + "documentation": "An array of objects that summarize a recommendation.
" + } + } + }, + "Identifier": { + "type": "string" + }, + "IncludeMemberAccounts": { + "type": "boolean" + }, + "InstanceArn": { + "type": "string" + }, + "InstanceArns": { + "type": "list", + "member": { + "shape": "InstanceArn" + } + }, + "InstanceName": { + "type": "string" + }, + "InstanceRecommendation": { + "type": "structure", + "members": { + "instanceArn": { + "shape": "InstanceArn", + "documentation": "The Amazon Resource Name (ARN) of the current instance.
" + }, + "accountId": { + "shape": "AccountId", + "documentation": "The AWS account ID of the instance recommendation.
" + }, + "instanceName": { + "shape": "InstanceName", + "documentation": "The name of the current instance.
" + }, + "currentInstanceType": { + "shape": "CurrentInstanceType", + "documentation": "The instance type of the current instance.
" + }, + "finding": { + "shape": "Finding", + "documentation": "The finding classification for the instance.
Findings for instances include:
Underprovisioned
—An instance is considered under-provisioned when at least one specification of your instance, such as CPU, memory, or network, does not meet the performance requirements of your workload. Under-provisioned instances may lead to poor application performance.
Overprovisioned
—An instance is considered over-provisioned when at least one specification of your instance, such as CPU, memory, or network, can be sized down while still meeting the performance requirements of your workload, and no specification is under-provisioned. Over-provisioned instances may lead to unnecessary infrastructure cost.
Optimized
—An instance is considered optimized when all specifications of your instance, such as CPU, memory, and network, meet the performance requirements of your workload and is not over provisioned. An optimized instance runs your workloads with optimal performance and infrastructure cost. For optimized resources, AWS Compute Optimizer might recommend a new generation instance type.
The values that are returned might be UNDER_PROVISIONED
, OVER_PROVISIONED
, or OPTIMIZED
.
An array of objects that describe the utilization metrics of the instance.
" + }, + "lookBackPeriodInDays": { + "shape": "LookBackPeriodInDays", + "documentation": "The number of days for which utilization metrics were analyzed for the instance.
" + }, + "recommendationOptions": { + "shape": "RecommendationOptions", + "documentation": "An array of objects that describe the recommendation options for the instance.
" + }, + "recommendationSources": { + "shape": "RecommendationSources", + "documentation": "An array of objects that describe the source resource of the recommendation.
" + }, + "lastRefreshTimestamp": { + "shape": "LastRefreshTimestamp", + "documentation": "The time stamp of when the instance recommendation was last refreshed.
" + } + }, + "documentation": "Describes an Amazon EC2 instance recommendation.
" + }, + "InstanceRecommendationOption": { + "type": "structure", + "members": { + "instanceType": { + "shape": "InstanceType", + "documentation": "The instance type of the instance recommendation.
" + }, + "projectedUtilizationMetrics": { + "shape": "ProjectedUtilizationMetrics", + "documentation": "An array of objects that describe the projected utilization metrics of the instance recommendation option.
" + }, + "performanceRisk": { + "shape": "PerformanceRisk", + "documentation": "The performance risk of the instance recommendation option.
Performance risk is the likelihood of the recommended instance type not meeting the performance requirement of your workload.
The lowest performance risk is categorized as 0
, and the highest as 5
.
The rank of the instance recommendation option.
The top recommendation option is ranked as 1
.
Describes a recommendation option for an Amazon EC2 instance.
" + }, + "InstanceRecommendations": { + "type": "list", + "member": { + "shape": "InstanceRecommendation" + } + }, + "InstanceType": { + "type": "string" + }, + "LastRefreshTimestamp": { + "type": "timestamp" + }, + "LookBackPeriodInDays": { + "type": "double" + }, + "MaxResults": { + "type": "integer", + "box": true + }, + "MaxSize": { + "type": "integer" + }, + "MemberAccountsEnrolled": { + "type": "boolean" + }, + "Message": { + "type": "string" + }, + "MetricName": { + "type": "string", + "enum": [ + "Cpu", + "Memory" + ] + }, + "MetricStatistic": { + "type": "string", + "enum": [ + "Maximum", + "Average" + ] + }, + "MetricValue": { + "type": "double" + }, + "MetricValues": { + "type": "list", + "member": { + "shape": "MetricValue" + } + }, + "MinSize": { + "type": "integer" + }, + "NextToken": { + "type": "string" + }, + "PerformanceRisk": { + "type": "double", + "max": 5, + "min": 0 + }, + "Period": { + "type": "integer" + }, + "ProjectedMetric": { + "type": "structure", + "members": { + "name": { + "shape": "MetricName", + "documentation": "The name of the projected utilization metric.
Memory metrics are only returned for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
The time stamps of the projected utilization metric.
" + }, + "values": { + "shape": "MetricValues", + "documentation": "The values of the projected utilization metrics.
" + } + }, + "documentation": "Describes a projected utilization metric of a recommendation option, such as an Amazon EC2 instance.
" + }, + "ProjectedMetrics": { + "type": "list", + "member": { + "shape": "ProjectedMetric" + } + }, + "ProjectedUtilizationMetrics": { + "type": "list", + "member": { + "shape": "UtilizationMetric" + } + }, + "Rank": { + "type": "integer" + }, + "RecommendationOptions": { + "type": "list", + "member": { + "shape": "InstanceRecommendationOption" + } + }, + "RecommendationSource": { + "type": "structure", + "members": { + "recommendationSourceArn": { + "shape": "RecommendationSourceArn", + "documentation": "The Amazon Resource Name (ARN) of the recommendation source.
" + }, + "recommendationSourceType": { + "shape": "RecommendationSourceType", + "documentation": "The resource type of the recommendation source.
" + } + }, + "documentation": "Describes the source of a recommendation, such as an Amazon EC2 instance or Auto Scaling group.
" + }, + "RecommendationSourceArn": { + "type": "string" + }, + "RecommendationSourceType": { + "type": "string", + "enum": [ + "Ec2Instance", + "AutoScalingGroup" + ] + }, + "RecommendationSources": { + "type": "list", + "member": { + "shape": "RecommendationSource" + } + }, + "RecommendationSummaries": { + "type": "list", + "member": { + "shape": "RecommendationSummary" + } + }, + "RecommendationSummary": { + "type": "structure", + "members": { + "summaries": { + "shape": "Summaries", + "documentation": "An array of objects that describe a recommendation summary.
" + }, + "recommendationResourceType": { + "shape": "RecommendationSourceType", + "documentation": "The resource type of the recommendation.
" + }, + "accountId": { + "shape": "AccountId", + "documentation": "The AWS account ID of the recommendation summary.
" + } + }, + "documentation": "A summary of a recommendation.
" + }, + "RecommendedInstanceType": { + "type": "string" + }, + "RecommendedOptionProjectedMetric": { + "type": "structure", + "members": { + "recommendedInstanceType": { + "shape": "RecommendedInstanceType", + "documentation": "The recommended instance type.
" + }, + "rank": { + "shape": "Rank", + "documentation": "The rank of the recommendation option projected metric.
The top recommendation option is ranked as 1
.
The projected metric rank correlates to the recommendation option rank. For example, the projected metric ranked as 1
is related to the recommendation option that is also ranked as 1
in the same response.
An array of objects that describe a projected utilization metric.
" + } + }, + "documentation": "Describes a projected utilization metric of a recommendation option.
" + }, + "RecommendedOptionProjectedMetrics": { + "type": "list", + "member": { + "shape": "RecommendedOptionProjectedMetric" + } + }, + "Status": { + "type": "string", + "enum": [ + "Active", + "Inactive", + "Pending", + "Failed" + ] + }, + "StatusReason": { + "type": "string" + }, + "Summaries": { + "type": "list", + "member": { + "shape": "Summary" + } + }, + "Summary": { + "type": "structure", + "members": { + "name": { + "shape": "Finding", + "documentation": "The finding classification of the recommendation.
" + }, + "value": { + "shape": "SummaryValue", + "documentation": "The value of the recommendation summary.
" + } + }, + "documentation": "The summary of a recommendation.
" + }, + "SummaryValue": { + "type": "double" + }, + "Timestamp": { + "type": "timestamp" + }, + "Timestamps": { + "type": "list", + "member": { + "shape": "Timestamp" + } + }, + "UpdateEnrollmentStatusRequest": { + "type": "structure", + "required": [ + "status" + ], + "members": { + "status": { + "shape": "Status", + "documentation": "The new enrollment status of the account.
Accepted options are Active
or Inactive
. You will get an error if Pending
or Failed
are specified.
Indicates whether to enroll member accounts within the organization, if the account is a master account of an organization.
" + } + } + }, + "UpdateEnrollmentStatusResponse": { + "type": "structure", + "members": { + "status": { + "shape": "Status", + "documentation": "The enrollment status of the account.
" + }, + "statusReason": { + "shape": "StatusReason", + "documentation": "The reason for the enrollment status of the account. For example, an account might show a status of Pending
because member accounts of an organization require more time to be enrolled in the service.
The name of the utilization metric.
Memory metrics are only returned for resources that have the unified CloudWatch agent installed on them. For more information, see Enabling Memory Utilization with the CloudWatch Agent.
The statistic of the utilization metric.
" + }, + "value": { + "shape": "MetricValue", + "documentation": "The value of the utilization metric.
" + } + }, + "documentation": "Describes a utilization metric of a resource, such as an Amazon EC2 instance.
" + }, + "UtilizationMetrics": { + "type": "list", + "member": { + "shape": "UtilizationMetric" + } + } + }, + "documentation": "AWS Compute Optimizer is a service that analyzes the configuration and utilization metrics of your AWS resources, such as EC2 instances and Auto Scaling groups. It reports whether your resources are optimal, and generates optimization recommendations to reduce the cost and improve the performance of your workloads. Compute Optimizer also provides recent utilization metric data, as well as projected utilization metric data for the recommendations, which you can use to evaluate which recommendation provides the best price-performance trade-off. The analysis of your usage patterns can help you decide when to move or resize your running resources, and still meet your performance and capacity requirements. For more information about Compute Optimizer, see the AWS Compute Optimizer User Guide.
" +} \ No newline at end of file diff --git a/apis/compute-optimizer-2019-11-01.paginators.json b/apis/compute-optimizer-2019-11-01.paginators.json new file mode 100644 index 0000000000..5677bd8e4a --- /dev/null +++ b/apis/compute-optimizer-2019-11-01.paginators.json @@ -0,0 +1,4 @@ +{ + "pagination": { + } +} diff --git a/apis/ec2-2016-11-15.min.json b/apis/ec2-2016-11-15.min.json index 46d07fb90a..099f33bc1d 100644 --- a/apis/ec2-2016-11-15.min.json +++ b/apis/ec2-2016-11-15.min.json @@ -41,6 +41,29 @@ } } }, + "AcceptTransitGatewayPeeringAttachment": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayAttachmentId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachment": { + "shape": "Sb", + "locationName": "transitGatewayPeeringAttachment" + } + } + } + }, "AcceptTransitGatewayVpcAttachment": { "input": { "type": "structure", @@ -58,7 +81,7 @@ "type": "structure", "members": { "TransitGatewayVpcAttachment": { - "shape": "Sc", + "shape": "Sk", "locationName": "transitGatewayVpcAttachment" } } @@ -77,7 +100,7 @@ }, "ServiceId": {}, "VpcEndpointIds": { - "shape": "Se", + "shape": "Sl", "locationName": "VpcEndpointId" } } @@ -86,7 +109,7 @@ "type": "structure", "members": { "Unsuccessful": { - "shape": "So", + "shape": "Ss", "locationName": "unsuccessful" } } @@ -109,7 +132,7 @@ "type": "structure", "members": { "VpcPeeringConnection": { - "shape": "Su", + "shape": "Sy", "locationName": "vpcPeeringConnection" } } @@ -132,7 +155,7 @@ "type": "structure", "members": { "ByoipCidr": { - "shape": "S15", + "shape": "S19", "locationName": "byoipCidr" } } @@ -145,6 +168,8 @@ "Domain": {}, "Address": {}, "PublicIpv4Pool": {}, + "NetworkBorderGroup": {}, + "CustomerOwnedIpv4Pool": {}, "DryRun": { "locationName": "dryRun", "type": "boolean" @@ -163,8 +188,17 @@ "PublicIpv4Pool": { "locationName": "publicIpv4Pool" }, + "NetworkBorderGroup": { + "locationName": "networkBorderGroup" + }, "Domain": { "locationName": "domain" + }, + "CustomerOwnedIp": { + "locationName": "customerOwnedIp" + }, + "CustomerOwnedIpv4Pool": { + "locationName": "customerOwnedIpv4Pool" } } } @@ -195,7 +229,7 @@ "type": "integer" }, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" }, "HostRecovery": {} @@ -205,7 +239,7 @@ "type": "structure", "members": { "HostIds": { - "shape": "S1h", + "shape": "S1l", "locationName": "hostIdSet" } } @@ -223,7 +257,7 @@ "ClientVpnEndpointId": {}, "VpcId": {}, "SecurityGroupIds": { - "shape": "S1l", + "shape": "S1p", "locationName": "SecurityGroupId" }, "DryRun": { @@ -235,7 +269,7 @@ "type": "structure", "members": { "SecurityGroupIds": { - "shape": "S1l", + "shape": "S1p", "locationName": "securityGroupIds" } } @@ -253,7 +287,7 @@ "type": "integer" }, "Ipv6Addresses": { - "shape": "S1o", + "shape": "S1s", "locationName": "ipv6Addresses" }, "NetworkInterfaceId": { @@ -265,7 +299,7 @@ "type": "structure", "members": { "AssignedIpv6Addresses": { - "shape": "S1o", + "shape": "S1s", "locationName": "assignedIpv6Addresses" }, "NetworkInterfaceId": { @@ -289,7 +323,7 @@ "locationName": "networkInterfaceId" }, "PrivateIpAddresses": { - "shape": "S1s", + "shape": "S1w", "locationName": "privateIpAddress" }, "SecondaryPrivateIpAddressCount": { @@ -377,7 +411,7 @@ "locationName": "associationId" }, "Status": { - "shape": "S23", + "shape": "S27", "locationName": "status" } } @@ -409,7 +443,7 @@ ], "members": { "IamInstanceProfile": { - "shape": "S28" + "shape": "S2c" }, "InstanceId": {} } @@ -418,7 +452,7 @@ "type": "structure", "members": { "IamInstanceProfileAssociation": { - "shape": "S2a", + "shape": "S2e", "locationName": "iamInstanceProfileAssociation" } } @@ -428,8 +462,7 @@ "input": { "type": "structure", "required": [ - "RouteTableId", - "SubnetId" + "RouteTableId" ], "members": { "DryRun": { @@ -441,7 +474,8 @@ }, "SubnetId": { "locationName": "subnetId" - } + }, + "GatewayId": {} } }, "output": { @@ -449,6 +483,10 @@ "members": { "AssociationId": { "locationName": "associationId" + }, + "AssociationState": { + "shape": "S2j", + "locationName": "associationState" } } } @@ -473,7 +511,7 @@ "type": "structure", "members": { "Ipv6CidrBlockAssociation": { - "shape": "S2i", + "shape": "S2n", "locationName": "ipv6CidrBlockAssociation" }, "SubnetId": { @@ -482,6 +520,30 @@ } } }, + "AssociateTransitGatewayMulticastDomain": { + "input": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": {}, + "TransitGatewayAttachmentId": {}, + "SubnetIds": { + "shape": "Sl" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Associations": { + "shape": "S2s", + "locationName": "associations" + } + } + } + }, "AssociateTransitGatewayRouteTable": { "input": { "type": "structure", @@ -501,7 +563,7 @@ "type": "structure", "members": { "Association": { - "shape": "S2o", + "shape": "S2z", "locationName": "association" } } @@ -521,18 +583,19 @@ "CidrBlock": {}, "VpcId": { "locationName": "vpcId" - } + }, + "Ipv6CidrBlockNetworkBorderGroup": {} } }, "output": { "type": "structure", "members": { "Ipv6CidrBlockAssociation": { - "shape": "S2t", + "shape": "S33", "locationName": "ipv6CidrBlockAssociation" }, "CidrBlockAssociation": { - "shape": "S2w", + "shape": "S36", "locationName": "cidrBlockAssociation" }, "VpcId": { @@ -555,7 +618,7 @@ "type": "boolean" }, "Groups": { - "shape": "S2y", + "shape": "S38", "locationName": "SecurityGroupId" }, "InstanceId": { @@ -650,7 +713,7 @@ } }, "output": { - "shape": "S36" + "shape": "S3g" } }, "AttachVpnGateway": { @@ -673,7 +736,7 @@ "type": "structure", "members": { "VpcAttachment": { - "shape": "S3b", + "shape": "S3l", "locationName": "attachment" } } @@ -706,7 +769,7 @@ "type": "structure", "members": { "Status": { - "shape": "S3f", + "shape": "S3p", "locationName": "status" } } @@ -727,7 +790,7 @@ "locationName": "groupId" }, "IpPermissions": { - "shape": "S3i", + "shape": "S3s", "locationName": "ipPermissions" }, "CidrIp": { @@ -764,7 +827,7 @@ "GroupId": {}, "GroupName": {}, "IpPermissions": { - "shape": "S3i" + "shape": "S3s" }, "IpProtocol": {}, "SourceSecurityGroupName": {}, @@ -789,7 +852,7 @@ "members": { "InstanceId": {}, "Storage": { - "shape": "S3u" + "shape": "S44" }, "DryRun": { "locationName": "dryRun", @@ -801,7 +864,7 @@ "type": "structure", "members": { "BundleTask": { - "shape": "S3y", + "shape": "S48", "locationName": "bundleInstanceTask" } } @@ -825,7 +888,7 @@ "type": "structure", "members": { "BundleTask": { - "shape": "S3y", + "shape": "S48", "locationName": "bundleInstanceTask" } } @@ -929,7 +992,7 @@ "type": "structure", "members": { "ReservedInstancesListings": { - "shape": "S4g", + "shape": "S4q", "locationName": "reservedInstancesListingsSet" } } @@ -948,7 +1011,7 @@ "type": "boolean" }, "SpotFleetRequestIds": { - "shape": "Se", + "shape": "Sl", "locationName": "spotFleetRequestId" }, "TerminateInstances": { @@ -1019,7 +1082,7 @@ "type": "boolean" }, "SpotInstanceRequestIds": { - "shape": "S51", + "shape": "S5b", "locationName": "SpotInstanceRequestId" } } @@ -1163,7 +1226,7 @@ "SourceRegion": {}, "SourceSnapshotId": {}, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" }, "DryRun": { @@ -1179,7 +1242,7 @@ "locationName": "snapshotId" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } @@ -1215,7 +1278,7 @@ "EndDateType": {}, "InstanceMatchCriteria": {}, "TagSpecifications": { - "shape": "S1c" + "shape": "S1g" }, "DryRun": { "type": "boolean" @@ -1226,7 +1289,7 @@ "type": "structure", "members": { "CapacityReservation": { - "shape": "S5k", + "shape": "S5u", "locationName": "capacityReservation" } } @@ -1267,10 +1330,10 @@ } }, "ConnectionLogOptions": { - "shape": "S5s" + "shape": "S62" }, "DnsServers": { - "shape": "Se" + "shape": "Sl" }, "TransportProtocol": {}, "Description": {}, @@ -1284,7 +1347,7 @@ "idempotencyToken": true }, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" } } @@ -1296,7 +1359,7 @@ "locationName": "clientVpnEndpointId" }, "Status": { - "shape": "S5v", + "shape": "S65", "locationName": "status" }, "DnsName": { @@ -1330,7 +1393,7 @@ "type": "structure", "members": { "Status": { - "shape": "S5z", + "shape": "S69", "locationName": "status" } } @@ -1363,7 +1426,7 @@ "type": "structure", "members": { "CustomerGateway": { - "shape": "S64", + "shape": "S6e", "locationName": "customerGateway" } } @@ -1386,7 +1449,7 @@ "type": "structure", "members": { "Subnet": { - "shape": "S67", + "shape": "S6h", "locationName": "subnet" } } @@ -1405,7 +1468,7 @@ "type": "structure", "members": { "Vpc": { - "shape": "S6c", + "shape": "S6m", "locationName": "vpc" } } @@ -1429,7 +1492,7 @@ "locationName": "key" }, "Values": { - "shape": "Se", + "shape": "Sl", "locationName": "Value" } } @@ -1445,7 +1508,7 @@ "type": "structure", "members": { "DhcpOptions": { - "shape": "S6l", + "shape": "S6v", "locationName": "dhcpOptions" } } @@ -1472,7 +1535,7 @@ "locationName": "clientToken" }, "EgressOnlyInternetGateway": { - "shape": "S6s", + "shape": "S72", "locationName": "egressOnlyInternetGateway" } } @@ -1558,7 +1621,7 @@ "type": "double" }, "Placement": { - "shape": "S7a" + "shape": "S7k" } } } @@ -1567,7 +1630,7 @@ } }, "TargetCapacitySpecification": { - "shape": "S7b" + "shape": "S7l" }, "TerminateInstancesWithExpiration": { "type": "boolean" @@ -1583,7 +1646,7 @@ "type": "boolean" }, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" } } @@ -1602,7 +1665,7 @@ "type": "structure", "members": { "LaunchTemplateAndOverrides": { - "shape": "S7i", + "shape": "S7s", "locationName": "launchTemplateAndOverrides" }, "Lifecycle": { @@ -1625,14 +1688,14 @@ "type": "structure", "members": { "LaunchTemplateAndOverrides": { - "shape": "S7i", + "shape": "S7s", "locationName": "launchTemplateAndOverrides" }, "Lifecycle": { "locationName": "lifecycle" }, "InstanceIds": { - "shape": "S7p", + "shape": "S7z", "locationName": "instanceIds" }, "InstanceType": { @@ -1663,7 +1726,7 @@ "DeliverLogsPermissionArn": {}, "LogGroupName": {}, "ResourceIds": { - "shape": "Se", + "shape": "Sl", "locationName": "ResourceId" }, "ResourceType": {}, @@ -1680,11 +1743,11 @@ "locationName": "clientToken" }, "FlowLogIds": { - "shape": "Se", + "shape": "Sl", "locationName": "flowLogIdSet" }, "Unsuccessful": { - "shape": "So", + "shape": "Ss", "locationName": "unsuccessful" } } @@ -1701,16 +1764,16 @@ "type": "boolean" }, "InputStorageLocation": { - "shape": "S7x" + "shape": "S87" }, "LogsStorageLocation": { - "shape": "S7x" + "shape": "S87" }, "Description": {}, "Name": {}, "ClientToken": {}, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" } } @@ -1736,7 +1799,7 @@ ], "members": { "BlockDeviceMappings": { - "shape": "S80", + "shape": "S8a", "locationName": "blockDeviceMapping" }, "Description": { @@ -1807,7 +1870,7 @@ "type": "structure", "members": { "ExportTask": { - "shape": "S8b", + "shape": "S8l", "locationName": "exportTask" } } @@ -1827,7 +1890,7 @@ "type": "structure", "members": { "InternetGateway": { - "shape": "S8h", + "shape": "S8r", "locationName": "internetGateway" } } @@ -1879,10 +1942,10 @@ "LaunchTemplateName": {}, "VersionDescription": {}, "LaunchTemplateData": { - "shape": "S8o" + "shape": "S8y" }, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" } } @@ -1891,7 +1954,7 @@ "type": "structure", "members": { "LaunchTemplate": { - "shape": "S9o", + "shape": "S9y", "locationName": "launchTemplate" } } @@ -1913,7 +1976,7 @@ "SourceVersion": {}, "VersionDescription": {}, "LaunchTemplateData": { - "shape": "S8o" + "shape": "S8y" } } }, @@ -1921,12 +1984,64 @@ "type": "structure", "members": { "LaunchTemplateVersion": { - "shape": "S9s", + "shape": "Sa2", "locationName": "launchTemplateVersion" } } } }, + "CreateLocalGatewayRoute": { + "input": { + "type": "structure", + "required": [ + "DestinationCidrBlock", + "LocalGatewayRouteTableId", + "LocalGatewayVirtualInterfaceGroupId" + ], + "members": { + "DestinationCidrBlock": {}, + "LocalGatewayRouteTableId": {}, + "LocalGatewayVirtualInterfaceGroupId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Route": { + "shape": "Sav", + "locationName": "route" + } + } + } + }, + "CreateLocalGatewayRouteTableVpcAssociation": { + "input": { + "type": "structure", + "required": [ + "LocalGatewayRouteTableId", + "VpcId" + ], + "members": { + "LocalGatewayRouteTableId": {}, + "VpcId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociation": { + "shape": "Sb0", + "locationName": "localGatewayRouteTableVpcAssociation" + } + } + } + }, "CreateNatGateway": { "input": { "type": "structure", @@ -1947,7 +2062,7 @@ "locationName": "clientToken" }, "NatGateway": { - "shape": "Sal", + "shape": "Sb3", "locationName": "natGateway" } } @@ -1973,7 +2088,7 @@ "type": "structure", "members": { "NetworkAcl": { - "shape": "Sas", + "shape": "Sba", "locationName": "networkAcl" } } @@ -2002,7 +2117,7 @@ "type": "boolean" }, "IcmpTypeCode": { - "shape": "Sax", + "shape": "Sbf", "locationName": "Icmp" }, "Ipv6CidrBlock": { @@ -2012,7 +2127,7 @@ "locationName": "networkAclId" }, "PortRange": { - "shape": "Say", + "shape": "Sbg", "locationName": "portRange" }, "Protocol": { @@ -2043,7 +2158,7 @@ "type": "boolean" }, "Groups": { - "shape": "S8v", + "shape": "S95", "locationName": "SecurityGroupId" }, "Ipv6AddressCount": { @@ -2051,14 +2166,14 @@ "type": "integer" }, "Ipv6Addresses": { - "shape": "Sa0", + "shape": "Saa", "locationName": "ipv6Addresses" }, "PrivateIpAddress": { "locationName": "privateIpAddress" }, "PrivateIpAddresses": { - "shape": "S8y", + "shape": "S98", "locationName": "privateIpAddresses" }, "SecondaryPrivateIpAddressCount": { @@ -2075,7 +2190,7 @@ "type": "structure", "members": { "NetworkInterface": { - "shape": "Sb5", + "shape": "Sbn", "locationName": "networkInterface" } } @@ -2102,7 +2217,7 @@ "type": "structure", "members": { "InterfacePermission": { - "shape": "Sbj", + "shape": "Sc1", "locationName": "interfacePermission" } } @@ -2175,7 +2290,7 @@ "type": "structure", "members": { "ReservedInstancesListings": { - "shape": "S4g", + "shape": "S4q", "locationName": "reservedInstancesListingsSet" } } @@ -2211,6 +2326,7 @@ "locationName": "natGatewayId" }, "TransitGatewayId": {}, + "LocalGatewayId": {}, "NetworkInterfaceId": { "locationName": "networkInterfaceId" }, @@ -2252,7 +2368,7 @@ "type": "structure", "members": { "RouteTable": { - "shape": "Sbz", + "shape": "Sci", "locationName": "routeTable" } } @@ -2296,7 +2412,7 @@ "Description": {}, "VolumeId": {}, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" }, "DryRun": { @@ -2306,7 +2422,7 @@ } }, "output": { - "shape": "Scb" + "shape": "Scu" } }, "CreateSnapshots": { @@ -2327,7 +2443,7 @@ } }, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" }, "DryRun": { @@ -2350,7 +2466,7 @@ "locationName": "description" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "Encrypted": { @@ -2409,7 +2525,7 @@ "type": "structure", "members": { "SpotDatafeedSubscription": { - "shape": "Scm", + "shape": "Sd5", "locationName": "spotDatafeedSubscription" } } @@ -2427,6 +2543,7 @@ "AvailabilityZoneId": {}, "CidrBlock": {}, "Ipv6CidrBlock": {}, + "OutpostArn": {}, "VpcId": {}, "DryRun": { "locationName": "dryRun", @@ -2438,7 +2555,7 @@ "type": "structure", "members": { "Subnet": { - "shape": "S67", + "shape": "S6h", "locationName": "subnet" } } @@ -2457,11 +2574,11 @@ "type": "boolean" }, "Resources": { - "shape": "Scs", + "shape": "Sdb", "locationName": "ResourceId" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "Tag" } } @@ -2473,7 +2590,7 @@ "members": { "Description": {}, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" }, "DryRun": { @@ -2488,7 +2605,7 @@ "type": "structure", "members": { "TrafficMirrorFilter": { - "shape": "Scv", + "shape": "Sde", "locationName": "trafficMirrorFilter" }, "ClientToken": { @@ -2516,10 +2633,10 @@ }, "RuleAction": {}, "DestinationPortRange": { - "shape": "Sd5" + "shape": "Sdo" }, "SourcePortRange": { - "shape": "Sd5" + "shape": "Sdo" }, "Protocol": { "type": "integer" @@ -2539,7 +2656,7 @@ "type": "structure", "members": { "TrafficMirrorFilterRule": { - "shape": "Scx", + "shape": "Sdg", "locationName": "trafficMirrorFilterRule" }, "ClientToken": { @@ -2572,7 +2689,7 @@ }, "Description": {}, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" }, "DryRun": { @@ -2587,7 +2704,7 @@ "type": "structure", "members": { "TrafficMirrorSession": { - "shape": "Sda", + "shape": "Sdt", "locationName": "trafficMirrorSession" }, "ClientToken": { @@ -2604,7 +2721,7 @@ "NetworkLoadBalancerArn": {}, "Description": {}, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" }, "DryRun": { @@ -2619,7 +2736,7 @@ "type": "structure", "members": { "TrafficMirrorTarget": { - "shape": "Sdd", + "shape": "Sdw", "locationName": "trafficMirrorTarget" }, "ClientToken": { @@ -2643,11 +2760,12 @@ "DefaultRouteTableAssociation": {}, "DefaultRouteTablePropagation": {}, "VpnEcmpSupport": {}, - "DnsSupport": {} + "DnsSupport": {}, + "MulticastSupport": {} } }, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" }, "DryRun": { @@ -2659,12 +2777,72 @@ "type": "structure", "members": { "TransitGateway": { - "shape": "Sdm", + "shape": "Se6", "locationName": "transitGateway" } } } }, + "CreateTransitGatewayMulticastDomain": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayId" + ], + "members": { + "TransitGatewayId": {}, + "TagSpecifications": { + "shape": "S1g", + "locationName": "TagSpecification" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomain": { + "shape": "Seb", + "locationName": "transitGatewayMulticastDomain" + } + } + } + }, + "CreateTransitGatewayPeeringAttachment": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayId", + "PeerTransitGatewayId", + "PeerAccountId", + "PeerRegion" + ], + "members": { + "TransitGatewayId": {}, + "PeerTransitGatewayId": {}, + "PeerAccountId": {}, + "PeerRegion": {}, + "TagSpecifications": { + "shape": "S1g", + "locationName": "TagSpecification" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachment": { + "shape": "Sb", + "locationName": "transitGatewayPeeringAttachment" + } + } + } + }, "CreateTransitGatewayRoute": { "input": { "type": "structure", @@ -2688,7 +2866,7 @@ "type": "structure", "members": { "Route": { - "shape": "Sdr", + "shape": "Seh", "locationName": "route" } } @@ -2703,7 +2881,7 @@ "members": { "TransitGatewayId": {}, "TagSpecifications": { - "shape": "S1c" + "shape": "S1g" }, "DryRun": { "type": "boolean" @@ -2714,7 +2892,7 @@ "type": "structure", "members": { "TransitGatewayRouteTable": { - "shape": "Sdy", + "shape": "Seo", "locationName": "transitGatewayRouteTable" } } @@ -2732,7 +2910,7 @@ "TransitGatewayId": {}, "VpcId": {}, "SubnetIds": { - "shape": "Se" + "shape": "Sl" }, "Options": { "type": "structure", @@ -2742,7 +2920,7 @@ } }, "TagSpecifications": { - "shape": "S1c" + "shape": "S1g" }, "DryRun": { "type": "boolean" @@ -2753,7 +2931,7 @@ "type": "structure", "members": { "TransitGatewayVpcAttachment": { - "shape": "Sc", + "shape": "Sk", "locationName": "transitGatewayVpcAttachment" } } @@ -2775,6 +2953,7 @@ "type": "integer" }, "KmsKeyId": {}, + "OutpostArn": {}, "Size": { "type": "integer" }, @@ -2785,13 +2964,13 @@ "type": "boolean" }, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" } } }, "output": { - "shape": "Se6" + "shape": "Sew" } }, "CreateVpc": { @@ -2812,14 +2991,15 @@ }, "InstanceTenancy": { "locationName": "instanceTenancy" - } + }, + "Ipv6CidrBlockNetworkBorderGroup": {} } }, "output": { "type": "structure", "members": { "Vpc": { - "shape": "S6c", + "shape": "S6m", "locationName": "vpc" } } @@ -2841,15 +3021,15 @@ "ServiceName": {}, "PolicyDocument": {}, "RouteTableIds": { - "shape": "Se", + "shape": "Sl", "locationName": "RouteTableId" }, "SubnetIds": { - "shape": "Se", + "shape": "Sl", "locationName": "SubnetId" }, "SecurityGroupIds": { - "shape": "Se", + "shape": "Sl", "locationName": "SecurityGroupId" }, "ClientToken": {}, @@ -2862,7 +3042,7 @@ "type": "structure", "members": { "VpcEndpoint": { - "shape": "See", + "shape": "Sf4", "locationName": "vpcEndpoint" }, "ClientToken": { @@ -2886,7 +3066,7 @@ "VpcEndpointId": {}, "ConnectionNotificationArn": {}, "ConnectionEvents": { - "shape": "Se" + "shape": "Sl" }, "ClientToken": {} } @@ -2895,7 +3075,7 @@ "type": "structure", "members": { "ConnectionNotification": { - "shape": "Sen", + "shape": "Sfd", "locationName": "connectionNotification" }, "ClientToken": { @@ -2918,7 +3098,7 @@ "type": "boolean" }, "NetworkLoadBalancerArns": { - "shape": "Se", + "shape": "Sl", "locationName": "NetworkLoadBalancerArn" }, "ClientToken": {} @@ -2928,7 +3108,7 @@ "type": "structure", "members": { "ServiceConfiguration": { - "shape": "Ses", + "shape": "Sfi", "locationName": "serviceConfiguration" }, "ClientToken": { @@ -2961,7 +3141,7 @@ "type": "structure", "members": { "VpcPeeringConnection": { - "shape": "Su", + "shape": "Sy", "locationName": "vpcPeeringConnection" } } @@ -2987,6 +3167,9 @@ "locationName": "options", "type": "structure", "members": { + "EnableAcceleration": { + "type": "boolean" + }, "StaticRoutesOnly": { "locationName": "staticRoutesOnly", "type": "boolean" @@ -3017,31 +3200,31 @@ "type": "integer" }, "Phase1EncryptionAlgorithms": { - "shape": "Sf4", + "shape": "Sfu", "locationName": "Phase1EncryptionAlgorithm" }, "Phase2EncryptionAlgorithms": { - "shape": "Sf6", + "shape": "Sfw", "locationName": "Phase2EncryptionAlgorithm" }, "Phase1IntegrityAlgorithms": { - "shape": "Sf8", + "shape": "Sfy", "locationName": "Phase1IntegrityAlgorithm" }, "Phase2IntegrityAlgorithms": { - "shape": "Sfa", + "shape": "Sg0", "locationName": "Phase2IntegrityAlgorithm" }, "Phase1DHGroupNumbers": { - "shape": "Sfc", + "shape": "Sg2", "locationName": "Phase1DHGroupNumber" }, "Phase2DHGroupNumbers": { - "shape": "Sfe", + "shape": "Sg4", "locationName": "Phase2DHGroupNumber" }, "IKEVersions": { - "shape": "Sfg", + "shape": "Sg6", "locationName": "IKEVersion" } } @@ -3055,7 +3238,7 @@ "type": "structure", "members": { "VpnConnection": { - "shape": "Sfj", + "shape": "Sg9", "locationName": "vpnConnection" } } @@ -3096,7 +3279,7 @@ "type": "structure", "members": { "VpnGateway": { - "shape": "Sgc", + "shape": "Sh2", "locationName": "vpnGateway" } } @@ -3119,7 +3302,7 @@ "type": "structure", "members": { "Status": { - "shape": "S5v", + "shape": "S65", "locationName": "status" } } @@ -3145,7 +3328,7 @@ "type": "structure", "members": { "Status": { - "shape": "S5z", + "shape": "S69", "locationName": "status" } } @@ -3216,7 +3399,7 @@ "type": "boolean" }, "FleetIds": { - "shape": "Sgn", + "shape": "Shd", "locationName": "FleetId" }, "TerminateInstances": { @@ -3285,7 +3468,7 @@ "type": "boolean" }, "FlowLogIds": { - "shape": "Se", + "shape": "Sl", "locationName": "FlowLogId" } } @@ -3294,7 +3477,7 @@ "type": "structure", "members": { "Unsuccessful": { - "shape": "So", + "shape": "Ss", "locationName": "unsuccessful" } } @@ -3370,7 +3553,7 @@ "type": "structure", "members": { "LaunchTemplate": { - "shape": "S9o", + "shape": "S9y", "locationName": "launchTemplate" } } @@ -3389,7 +3572,7 @@ "LaunchTemplateId": {}, "LaunchTemplateName": {}, "Versions": { - "shape": "Sh6", + "shape": "Shw", "locationName": "LaunchTemplateVersion" } } @@ -3452,6 +3635,54 @@ } } }, + "DeleteLocalGatewayRoute": { + "input": { + "type": "structure", + "required": [ + "DestinationCidrBlock", + "LocalGatewayRouteTableId" + ], + "members": { + "DestinationCidrBlock": {}, + "LocalGatewayRouteTableId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Route": { + "shape": "Sav", + "locationName": "route" + } + } + } + }, + "DeleteLocalGatewayRouteTableVpcAssociation": { + "input": { + "type": "structure", + "required": [ + "LocalGatewayRouteTableVpcAssociationId" + ], + "members": { + "LocalGatewayRouteTableVpcAssociationId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociation": { + "shape": "Sb0", + "locationName": "localGatewayRouteTableVpcAssociation" + } + } + } + }, "DeleteNatGateway": { "input": { "type": "structure", @@ -3744,11 +3975,11 @@ "type": "boolean" }, "Resources": { - "shape": "Scs", + "shape": "Sdb", "locationName": "resourceId" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tag" } } @@ -3859,12 +4090,58 @@ "type": "structure", "members": { "TransitGateway": { - "shape": "Sdm", + "shape": "Se6", "locationName": "transitGateway" } } } }, + "DeleteTransitGatewayMulticastDomain": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayMulticastDomainId" + ], + "members": { + "TransitGatewayMulticastDomainId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomain": { + "shape": "Seb", + "locationName": "transitGatewayMulticastDomain" + } + } + } + }, + "DeleteTransitGatewayPeeringAttachment": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayAttachmentId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachment": { + "shape": "Sb", + "locationName": "transitGatewayPeeringAttachment" + } + } + } + }, "DeleteTransitGatewayRoute": { "input": { "type": "structure", @@ -3884,7 +4161,7 @@ "type": "structure", "members": { "Route": { - "shape": "Sdr", + "shape": "Seh", "locationName": "route" } } @@ -3907,7 +4184,7 @@ "type": "structure", "members": { "TransitGatewayRouteTable": { - "shape": "Sdy", + "shape": "Seo", "locationName": "transitGatewayRouteTable" } } @@ -3930,7 +4207,7 @@ "type": "structure", "members": { "TransitGatewayVpcAttachment": { - "shape": "Sc", + "shape": "Sk", "locationName": "transitGatewayVpcAttachment" } } @@ -3977,7 +4254,7 @@ "type": "boolean" }, "ConnectionNotificationIds": { - "shape": "Se", + "shape": "Sl", "locationName": "ConnectionNotificationId" } } @@ -3986,7 +4263,7 @@ "type": "structure", "members": { "Unsuccessful": { - "shape": "So", + "shape": "Ss", "locationName": "unsuccessful" } } @@ -4003,7 +4280,7 @@ "type": "boolean" }, "ServiceIds": { - "shape": "Se", + "shape": "Sl", "locationName": "ServiceId" } } @@ -4012,7 +4289,7 @@ "type": "structure", "members": { "Unsuccessful": { - "shape": "So", + "shape": "Ss", "locationName": "unsuccessful" } } @@ -4029,7 +4306,7 @@ "type": "boolean" }, "VpcEndpointIds": { - "shape": "Se", + "shape": "Sl", "locationName": "VpcEndpointId" } } @@ -4038,7 +4315,7 @@ "type": "structure", "members": { "Unsuccessful": { - "shape": "So", + "shape": "Ss", "locationName": "unsuccessful" } } @@ -4130,7 +4407,7 @@ "type": "structure", "members": { "ByoipCidr": { - "shape": "S15", + "shape": "S19", "locationName": "byoipCidr" } } @@ -4151,19 +4428,16 @@ } } }, - "DescribeAccountAttributes": { + "DeregisterTransitGatewayMulticastGroupMembers": { "input": { "type": "structure", "members": { - "AttributeNames": { - "locationName": "attributeName", - "type": "list", - "member": { - "locationName": "attributeName" - } + "TransitGatewayMulticastDomainId": {}, + "GroupIpAddress": {}, + "NetworkInterfaceIds": { + "shape": "Sl" }, "DryRun": { - "locationName": "dryRun", "type": "boolean" } } @@ -4171,41 +4445,116 @@ "output": { "type": "structure", "members": { - "AccountAttributes": { - "locationName": "accountAttributeSet", - "type": "list", - "member": { - "locationName": "item", - "type": "structure", - "members": { - "AttributeName": { - "locationName": "attributeName" - }, - "AttributeValues": { - "locationName": "attributeValueSet", - "type": "list", - "member": { - "locationName": "item", - "type": "structure", - "members": { - "AttributeValue": { - "locationName": "attributeValue" - } - } - } - } + "DeregisteredMulticastGroupMembers": { + "locationName": "deregisteredMulticastGroupMembers", + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "locationName": "transitGatewayMulticastDomainId" + }, + "DeregisteredNetworkInterfaceIds": { + "shape": "Sl", + "locationName": "deregisteredNetworkInterfaceIds" + }, + "GroupIpAddress": { + "locationName": "groupIpAddress" } } } } } }, - "DescribeAddresses": { + "DeregisterTransitGatewayMulticastGroupSources": { "input": { "type": "structure", "members": { - "Filters": { - "shape": "Sj9", + "TransitGatewayMulticastDomainId": {}, + "GroupIpAddress": {}, + "NetworkInterfaceIds": { + "shape": "Sl" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "DeregisteredMulticastGroupSources": { + "locationName": "deregisteredMulticastGroupSources", + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "locationName": "transitGatewayMulticastDomainId" + }, + "DeregisteredNetworkInterfaceIds": { + "shape": "Sl", + "locationName": "deregisteredNetworkInterfaceIds" + }, + "GroupIpAddress": { + "locationName": "groupIpAddress" + } + } + } + } + } + }, + "DescribeAccountAttributes": { + "input": { + "type": "structure", + "members": { + "AttributeNames": { + "locationName": "attributeName", + "type": "list", + "member": { + "locationName": "attributeName" + } + }, + "DryRun": { + "locationName": "dryRun", + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "AccountAttributes": { + "locationName": "accountAttributeSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AttributeName": { + "locationName": "attributeName" + }, + "AttributeValues": { + "locationName": "attributeValueSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AttributeValue": { + "locationName": "attributeValue" + } + } + } + } + } + } + } + } + } + }, + "DescribeAddresses": { + "input": { + "type": "structure", + "members": { + "Filters": { + "shape": "Skd", "locationName": "Filter" }, "PublicIps": { @@ -4263,11 +4612,20 @@ "locationName": "privateIpAddress" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "PublicIpv4Pool": { "locationName": "publicIpv4Pool" + }, + "NetworkBorderGroup": { + "locationName": "networkBorderGroup" + }, + "CustomerOwnedIp": { + "locationName": "customerOwnedIp" + }, + "CustomerOwnedIpv4Pool": { + "locationName": "customerOwnedIpv4Pool" } } } @@ -4292,7 +4650,7 @@ "type": "boolean" }, "Statuses": { - "shape": "Sji", + "shape": "Skm", "locationName": "statusSet" } } @@ -4303,7 +4661,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "ZoneNames": { @@ -4320,6 +4678,9 @@ "locationName": "ZoneId" } }, + "AllAvailabilityZones": { + "type": "boolean" + }, "DryRun": { "locationName": "dryRun", "type": "boolean" @@ -4339,6 +4700,9 @@ "State": { "locationName": "zoneState" }, + "OptInStatus": { + "locationName": "optInStatus" + }, "Messages": { "locationName": "messageSet", "type": "list", @@ -4360,6 +4724,12 @@ }, "ZoneId": { "locationName": "zoneId" + }, + "GroupName": { + "locationName": "groupName" + }, + "NetworkBorderGroup": { + "locationName": "networkBorderGroup" } } } @@ -4379,7 +4749,7 @@ } }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -4395,7 +4765,7 @@ "locationName": "bundleInstanceTasksSet", "type": "list", "member": { - "shape": "S3y", + "shape": "S48", "locationName": "item" } } @@ -4425,7 +4795,7 @@ "locationName": "byoipCidrSet", "type": "list", "member": { - "shape": "S15", + "shape": "S19", "locationName": "item" } }, @@ -4451,7 +4821,7 @@ "type": "integer" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -4469,7 +4839,7 @@ "locationName": "capacityReservationSet", "type": "list", "member": { - "shape": "S5k", + "shape": "S5u", "locationName": "item" } } @@ -4481,7 +4851,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -4489,7 +4859,7 @@ "type": "boolean" }, "InstanceIds": { - "shape": "Sk8", + "shape": "Sld", "locationName": "InstanceId" }, "MaxResults": { @@ -4512,14 +4882,14 @@ "type": "structure", "members": { "Groups": { - "shape": "Sb8", + "shape": "Sbq", "locationName": "groupSet" }, "InstanceId": { "locationName": "instanceId" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "VpcId": { @@ -4547,7 +4917,7 @@ }, "NextToken": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -4582,7 +4952,7 @@ "locationName": "destinationCidr" }, "Status": { - "shape": "S3f", + "shape": "S3p", "locationName": "status" } } @@ -4603,7 +4973,7 @@ "members": { "ClientVpnEndpointId": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "NextToken": {}, @@ -4659,7 +5029,7 @@ "locationName": "commonName" }, "Status": { - "shape": "Skn", + "shape": "Sls", "locationName": "status" }, "ConnectionEndTime": { @@ -4679,7 +5049,7 @@ "type": "structure", "members": { "ClientVpnEndpointIds": { - "shape": "Se", + "shape": "Sl", "locationName": "ClientVpnEndpointId" }, "MaxResults": { @@ -4687,7 +5057,7 @@ }, "NextToken": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -4712,7 +5082,7 @@ "locationName": "description" }, "Status": { - "shape": "S5v", + "shape": "S65", "locationName": "status" }, "CreationTime": { @@ -4728,7 +5098,7 @@ "locationName": "clientCidrBlock" }, "DnsServers": { - "shape": "Se", + "shape": "Sl", "locationName": "dnsServer" }, "SplitTunnel": { @@ -4805,7 +5175,7 @@ } }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } @@ -4826,7 +5196,7 @@ "members": { "ClientVpnEndpointId": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -4864,7 +5234,7 @@ "locationName": "origin" }, "Status": { - "shape": "S5z", + "shape": "S69", "locationName": "status" }, "Description": { @@ -4888,14 +5258,14 @@ "members": { "ClientVpnEndpointId": {}, "AssociationIds": { - "shape": "Se" + "shape": "Sl" }, "MaxResults": { "type": "integer" }, "NextToken": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -4926,11 +5296,11 @@ "locationName": "clientVpnEndpointId" }, "Status": { - "shape": "S23", + "shape": "S27", "locationName": "status" }, "SecurityGroups": { - "shape": "Se", + "shape": "Sl", "locationName": "securityGroups" } } @@ -4942,6 +5312,63 @@ } } }, + "DescribeCoipPools": { + "input": { + "type": "structure", + "members": { + "PoolIds": { + "locationName": "PoolId", + "type": "list", + "member": { + "locationName": "item" + } + }, + "Filters": { + "shape": "Skd", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "CoipPools": { + "locationName": "coipPoolSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "PoolId": { + "locationName": "poolId" + }, + "PoolCidrs": { + "shape": "Sl", + "locationName": "poolCidrSet" + }, + "LocalGatewayRouteTableId": { + "locationName": "localGatewayRouteTableId" + }, + "Tags": { + "shape": "Sg", + "locationName": "tagSet" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, "DescribeConversionTasks": { "input": { "type": "structure", @@ -4966,7 +5393,7 @@ "locationName": "conversionTasks", "type": "list", "member": { - "shape": "Slh", + "shape": "Sms", "locationName": "item" } } @@ -4985,7 +5412,7 @@ } }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -5001,7 +5428,7 @@ "locationName": "customerGatewaySet", "type": "list", "member": { - "shape": "S64", + "shape": "S6e", "locationName": "item" } } @@ -5020,7 +5447,7 @@ } }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -5040,7 +5467,7 @@ "locationName": "dhcpOptionsSet", "type": "list", "member": { - "shape": "S6l", + "shape": "S6v", "locationName": "item" } }, @@ -5077,7 +5504,7 @@ "locationName": "egressOnlyInternetGatewaySet", "type": "list", "member": { - "shape": "S6s", + "shape": "S72", "locationName": "item" } }, @@ -5102,7 +5529,7 @@ "type": "boolean" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -5166,7 +5593,7 @@ "type": "boolean" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "ExportImageTaskIds": { @@ -5205,7 +5632,7 @@ "locationName": "progress" }, "S3ExportLocation": { - "shape": "Smi", + "shape": "Snt", "locationName": "s3ExportLocation" }, "Status": { @@ -5243,7 +5670,7 @@ "locationName": "exportTaskSet", "type": "list", "member": { - "shape": "S8b", + "shape": "S8l", "locationName": "item" } } @@ -5255,7 +5682,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -5357,7 +5784,7 @@ "type": "structure", "members": { "EventInformation": { - "shape": "Smy", + "shape": "So9", "locationName": "eventInformation" }, "EventType": { @@ -5403,7 +5830,7 @@ "NextToken": {}, "FleetId": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" } } @@ -5412,7 +5839,7 @@ "type": "structure", "members": { "ActiveInstances": { - "shape": "Sn1", + "shape": "Soc", "locationName": "activeInstanceSet" }, "NextToken": { @@ -5436,11 +5863,11 @@ }, "NextToken": {}, "FleetIds": { - "shape": "Sgn", + "shape": "Shd", "locationName": "FleetId" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" } } @@ -5493,14 +5920,14 @@ "type": "structure", "members": { "LaunchTemplateSpecification": { - "shape": "S7j", + "shape": "S7t", "locationName": "launchTemplateSpecification" }, "Overrides": { "locationName": "overrides", "type": "list", "member": { - "shape": "S7k", + "shape": "S7u", "locationName": "item" } } @@ -5603,7 +6030,7 @@ } }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "Errors": { @@ -5614,7 +6041,7 @@ "type": "structure", "members": { "LaunchTemplateAndOverrides": { - "shape": "S7i", + "shape": "S7s", "locationName": "launchTemplateAndOverrides" }, "Lifecycle": { @@ -5637,14 +6064,14 @@ "type": "structure", "members": { "LaunchTemplateAndOverrides": { - "shape": "S7i", + "shape": "S7s", "locationName": "launchTemplateAndOverrides" }, "Lifecycle": { "locationName": "lifecycle" }, "InstanceIds": { - "shape": "S7p", + "shape": "S7z", "locationName": "instanceIds" }, "InstanceType": { @@ -5670,10 +6097,10 @@ "type": "boolean" }, "Filter": { - "shape": "Sj9" + "shape": "Skd" }, "FlowLogIds": { - "shape": "Se", + "shape": "Sl", "locationName": "FlowLogId" }, "MaxResults": { @@ -5757,7 +6184,7 @@ "type": "structure", "members": { "FpgaImageAttribute": { - "shape": "Snq", + "shape": "Sp1", "locationName": "fpgaImageAttribute" } } @@ -5778,11 +6205,11 @@ } }, "Owners": { - "shape": "Snz", + "shape": "Spa", "locationName": "Owner" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "NextToken": {}, @@ -5853,11 +6280,11 @@ "locationName": "ownerAlias" }, "ProductCodes": { - "shape": "Snu", + "shape": "Sp5", "locationName": "productCodes" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tags" }, "Public": { @@ -5882,7 +6309,7 @@ "type": "structure", "members": { "Filter": { - "shape": "Sj9" + "shape": "Skd" }, "MaxDuration": { "type": "integer" @@ -5943,7 +6370,7 @@ "type": "structure", "members": { "Filter": { - "shape": "Sj9" + "shape": "Skd" }, "HostReservationIdSet": { "type": "list", @@ -5983,7 +6410,7 @@ "type": "timestamp" }, "HostIdSet": { - "shape": "Soi", + "shape": "Spt", "locationName": "hostIdSet" }, "HostReservationId": { @@ -6012,7 +6439,7 @@ "locationName": "upfrontPrice" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } @@ -6029,11 +6456,11 @@ "type": "structure", "members": { "Filter": { - "shape": "Sj9", + "shape": "Skd", "locationName": "filter" }, "HostIds": { - "shape": "Sol", + "shape": "Spw", "locationName": "hostId" }, "MaxResults": { @@ -6156,7 +6583,7 @@ "type": "timestamp" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "HostRecovery": { @@ -6196,7 +6623,7 @@ } }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -6212,7 +6639,7 @@ "locationName": "iamInstanceProfileAssociationSet", "type": "list", "member": { - "shape": "S2a", + "shape": "S2e", "locationName": "item" } }, @@ -6233,7 +6660,7 @@ "type": "structure", "members": { "Statuses": { - "shape": "Sji", + "shape": "Skm", "locationName": "statusSet" } } @@ -6258,7 +6685,7 @@ "type": "structure", "members": { "Statuses": { - "shape": "Sji", + "shape": "Skm", "locationName": "statusSet" } } @@ -6284,34 +6711,34 @@ "type": "structure", "members": { "BlockDeviceMappings": { - "shape": "Sp9", + "shape": "Sqk", "locationName": "blockDeviceMapping" }, "ImageId": { "locationName": "imageId" }, "LaunchPermissions": { - "shape": "Spa", + "shape": "Sql", "locationName": "launchPermission" }, "ProductCodes": { - "shape": "Snu", + "shape": "Sp5", "locationName": "productCodes" }, "Description": { - "shape": "S6p", + "shape": "S6z", "locationName": "description" }, "KernelId": { - "shape": "S6p", + "shape": "S6z", "locationName": "kernel" }, "RamdiskId": { - "shape": "S6p", + "shape": "S6z", "locationName": "ramdisk" }, "SriovNetSupport": { - "shape": "S6p", + "shape": "S6z", "locationName": "sriovNetSupport" } } @@ -6329,7 +6756,7 @@ } }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "ImageIds": { @@ -6340,7 +6767,7 @@ } }, "Owners": { - "shape": "Snz", + "shape": "Spa", "locationName": "Owner" }, "DryRun": { @@ -6388,7 +6815,7 @@ "locationName": "platform" }, "ProductCodes": { - "shape": "Snu", + "shape": "Sp5", "locationName": "productCodes" }, "RamdiskId": { @@ -6398,7 +6825,7 @@ "locationName": "imageState" }, "BlockDeviceMappings": { - "shape": "Sp9", + "shape": "Sqk", "locationName": "blockDeviceMapping" }, "Description": { @@ -6427,11 +6854,11 @@ "locationName": "sriovNetSupport" }, "StateReason": { - "shape": "Spn", + "shape": "Sqy", "locationName": "stateReason" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "VirtualizationType": { @@ -6451,10 +6878,10 @@ "type": "boolean" }, "Filters": { - "shape": "Sj9" + "shape": "Skd" }, "ImportTaskIds": { - "shape": "Spq", + "shape": "Sr1", "locationName": "ImportTaskId" }, "MaxResults": { @@ -6505,7 +6932,7 @@ "locationName": "progress" }, "SnapshotDetails": { - "shape": "Spu", + "shape": "Sr5", "locationName": "snapshotDetailSet" }, "Status": { @@ -6515,7 +6942,7 @@ "locationName": "statusMessage" }, "LicenseSpecifications": { - "shape": "Spx", + "shape": "Sr8", "locationName": "licenseSpecifications" } } @@ -6535,10 +6962,10 @@ "type": "boolean" }, "Filters": { - "shape": "Sj9" + "shape": "Skd" }, "ImportTaskIds": { - "shape": "Spq", + "shape": "Sr1", "locationName": "ImportTaskId" }, "MaxResults": { @@ -6564,7 +6991,7 @@ "locationName": "importTaskId" }, "SnapshotTaskDetail": { - "shape": "Sq3", + "shape": "Sre", "locationName": "snapshotTaskDetail" } } @@ -6600,62 +7027,62 @@ "type": "structure", "members": { "Groups": { - "shape": "Sb8", + "shape": "Sbq", "locationName": "groupSet" }, "BlockDeviceMappings": { - "shape": "Sq7", + "shape": "Sri", "locationName": "blockDeviceMapping" }, "DisableApiTermination": { - "shape": "Sqa", + "shape": "Srl", "locationName": "disableApiTermination" }, "EnaSupport": { - "shape": "Sqa", + "shape": "Srl", "locationName": "enaSupport" }, "EbsOptimized": { - "shape": "Sqa", + "shape": "Srl", "locationName": "ebsOptimized" }, "InstanceId": { "locationName": "instanceId" }, "InstanceInitiatedShutdownBehavior": { - "shape": "S6p", + "shape": "S6z", "locationName": "instanceInitiatedShutdownBehavior" }, "InstanceType": { - "shape": "S6p", + "shape": "S6z", "locationName": "instanceType" }, "KernelId": { - "shape": "S6p", + "shape": "S6z", "locationName": "kernel" }, "ProductCodes": { - "shape": "Snu", + "shape": "Sp5", "locationName": "productCodes" }, "RamdiskId": { - "shape": "S6p", + "shape": "S6z", "locationName": "ramdisk" }, "RootDeviceName": { - "shape": "S6p", + "shape": "S6z", "locationName": "rootDeviceName" }, "SourceDestCheck": { - "shape": "Sqa", + "shape": "Srl", "locationName": "sourceDestCheck" }, "SriovNetSupport": { - "shape": "S6p", + "shape": "S6z", "locationName": "sriovNetSupport" }, "UserData": { - "shape": "S6p", + "shape": "S6z", "locationName": "userData" } } @@ -6669,11 +7096,11 @@ "type": "boolean" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "InstanceIds": { - "shape": "Sk8", + "shape": "Sld", "locationName": "InstanceId" }, "MaxResults": { @@ -6712,11 +7139,11 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "InstanceIds": { - "shape": "Sk8", + "shape": "Sld", "locationName": "InstanceId" }, "MaxResults": { @@ -6746,11 +7173,14 @@ "AvailabilityZone": { "locationName": "availabilityZone" }, + "OutpostArn": { + "locationName": "outpostArn" + }, "Events": { "locationName": "eventsSet", "type": "list", "member": { - "shape": "Sql", + "shape": "Srw", "locationName": "item" } }, @@ -6758,15 +7188,15 @@ "locationName": "instanceId" }, "InstanceState": { - "shape": "Sqo", + "shape": "Srz", "locationName": "instanceState" }, "InstanceStatus": { - "shape": "Sqq", + "shape": "Ss1", "locationName": "instanceStatus" }, "SystemStatus": { - "shape": "Sqq", + "shape": "Ss1", "locationName": "systemStatus" } } @@ -6787,7 +7217,7 @@ }, "LocationType": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -6837,7 +7267,7 @@ "member": {} }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -7117,6 +7547,31 @@ } } }, + "InferenceAcceleratorInfo": { + "locationName": "inferenceAcceleratorInfo", + "type": "structure", + "members": { + "Accelerators": { + "locationName": "item", + "type": "list", + "member": { + "type": "structure", + "members": { + "Count": { + "locationName": "count", + "type": "integer" + }, + "Name": { + "locationName": "name" + }, + "Manufacturer": { + "locationName": "manufacturer" + } + } + } + } + } + }, "HibernationSupported": { "locationName": "hibernationSupported", "type": "boolean" @@ -7147,11 +7602,11 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "InstanceIds": { - "shape": "Sk8", + "shape": "Sld", "locationName": "InstanceId" }, "DryRun": { @@ -7174,7 +7629,7 @@ "locationName": "reservationSet", "type": "list", "member": { - "shape": "St2", + "shape": "Suj", "locationName": "item" } }, @@ -7189,7 +7644,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -7197,7 +7652,7 @@ "type": "boolean" }, "InternetGatewayIds": { - "shape": "Se", + "shape": "Sl", "locationName": "internetGatewayId" }, "NextToken": {}, @@ -7213,7 +7668,7 @@ "locationName": "internetGatewaySet", "type": "list", "member": { - "shape": "S8h", + "shape": "S8r", "locationName": "item" } }, @@ -7228,7 +7683,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "KeyNames": { @@ -7276,7 +7731,7 @@ "LaunchTemplateId": {}, "LaunchTemplateName": {}, "Versions": { - "shape": "Sh6", + "shape": "Shw", "locationName": "LaunchTemplateVersion" }, "MinVersion": {}, @@ -7286,7 +7741,7 @@ "type": "integer" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" } } @@ -7298,7 +7753,7 @@ "locationName": "launchTemplateVersionSet", "type": "list", "member": { - "shape": "S9s", + "shape": "Sa2", "locationName": "item" } }, @@ -7316,7 +7771,7 @@ "type": "boolean" }, "LaunchTemplateIds": { - "shape": "Se", + "shape": "Sl", "locationName": "LaunchTemplateId" }, "LaunchTemplateNames": { @@ -7327,7 +7782,7 @@ } }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "NextToken": {}, @@ -7343,10 +7798,336 @@ "locationName": "launchTemplates", "type": "list", "member": { - "shape": "S9o", + "shape": "S9y", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations": { + "input": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds": { + "locationName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId", + "type": "list", + "member": { + "locationName": "item" + } + }, + "Filters": { + "shape": "Skd", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociations": { + "locationName": "localGatewayRouteTableVirtualInterfaceGroupAssociationSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { + "locationName": "localGatewayRouteTableVirtualInterfaceGroupAssociationId" + }, + "LocalGatewayVirtualInterfaceGroupId": { + "locationName": "localGatewayVirtualInterfaceGroupId" + }, + "LocalGatewayId": { + "locationName": "localGatewayId" + }, + "LocalGatewayRouteTableId": { + "locationName": "localGatewayRouteTableId" + }, + "State": { + "locationName": "state" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeLocalGatewayRouteTableVpcAssociations": { + "input": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociationIds": { + "locationName": "LocalGatewayRouteTableVpcAssociationId", + "type": "list", + "member": { + "locationName": "item" + } + }, + "Filters": { + "shape": "Skd", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociations": { + "locationName": "localGatewayRouteTableVpcAssociationSet", + "type": "list", + "member": { + "shape": "Sb0", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeLocalGatewayRouteTables": { + "input": { + "type": "structure", + "members": { + "LocalGatewayRouteTableIds": { + "locationName": "LocalGatewayRouteTableId", + "type": "list", + "member": { + "locationName": "item" + } + }, + "Filters": { + "shape": "Skd", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "LocalGatewayRouteTables": { + "locationName": "localGatewayRouteTableSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "locationName": "localGatewayRouteTableId" + }, + "LocalGatewayId": { + "locationName": "localGatewayId" + }, + "OutpostArn": { + "locationName": "outpostArn" + }, + "State": { + "locationName": "state" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeLocalGatewayVirtualInterfaceGroups": { + "input": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceGroupIds": { + "locationName": "LocalGatewayVirtualInterfaceGroupId", + "type": "list", + "member": { + "locationName": "item" + } + }, + "Filters": { + "shape": "Skd", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceGroups": { + "locationName": "localGatewayVirtualInterfaceGroupSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceGroupId": { + "locationName": "localGatewayVirtualInterfaceGroupId" + }, + "LocalGatewayVirtualInterfaceIds": { + "shape": "Sw9", + "locationName": "localGatewayVirtualInterfaceIdSet" + }, + "LocalGatewayId": { + "locationName": "localGatewayId" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeLocalGatewayVirtualInterfaces": { + "input": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceIds": { + "shape": "Sw9", + "locationName": "LocalGatewayVirtualInterfaceId" + }, + "Filters": { + "shape": "Skd", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaces": { + "locationName": "localGatewayVirtualInterfaceSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceId": { + "locationName": "localGatewayVirtualInterfaceId" + }, + "LocalGatewayId": { + "locationName": "localGatewayId" + }, + "Vlan": { + "locationName": "vlan", + "type": "integer" + }, + "LocalAddress": { + "locationName": "localAddress" + }, + "PeerAddress": { + "locationName": "peerAddress" + }, + "LocalBgpAsn": { + "locationName": "localBgpAsn", + "type": "integer" + }, + "PeerBgpAsn": { + "locationName": "peerBgpAsn", + "type": "integer" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeLocalGateways": { + "input": { + "type": "structure", + "members": { + "LocalGatewayIds": { + "locationName": "LocalGatewayId", + "type": "list", + "member": { "locationName": "item" } }, + "Filters": { + "shape": "Skd", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "LocalGateways": { + "locationName": "localGatewaySet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "LocalGatewayId": { + "locationName": "localGatewayId" + }, + "OutpostArn": { + "locationName": "outpostArn" + }, + "OwnerId": { + "locationName": "ownerId" + }, + "State": { + "locationName": "state" + } + } + } + }, "NextToken": { "locationName": "nextToken" } @@ -7358,7 +8139,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "filter" }, "DryRun": { @@ -7373,7 +8154,7 @@ "locationName": "nextToken" }, "PublicIps": { - "shape": "Se", + "shape": "Sl", "locationName": "publicIp" } } @@ -7408,13 +8189,13 @@ "type": "structure", "members": { "Filter": { - "shape": "Sj9" + "shape": "Skd" }, "MaxResults": { "type": "integer" }, "NatGatewayIds": { - "shape": "Se", + "shape": "Sl", "locationName": "NatGatewayId" }, "NextToken": {} @@ -7427,7 +8208,7 @@ "locationName": "natGatewaySet", "type": "list", "member": { - "shape": "Sal", + "shape": "Sb3", "locationName": "item" } }, @@ -7442,7 +8223,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -7450,7 +8231,7 @@ "type": "boolean" }, "NetworkAclIds": { - "shape": "Se", + "shape": "Sl", "locationName": "NetworkAclId" }, "NextToken": {}, @@ -7466,7 +8247,7 @@ "locationName": "networkAclSet", "type": "list", "member": { - "shape": "Sas", + "shape": "Sba", "locationName": "item" } }, @@ -7499,22 +8280,22 @@ "type": "structure", "members": { "Attachment": { - "shape": "Sb7", + "shape": "Sbp", "locationName": "attachment" }, "Description": { - "shape": "S6p", + "shape": "S6z", "locationName": "description" }, "Groups": { - "shape": "Sb8", + "shape": "Sbq", "locationName": "groupSet" }, "NetworkInterfaceId": { "locationName": "networkInterfaceId" }, "SourceDestCheck": { - "shape": "Sqa", + "shape": "Srl", "locationName": "sourceDestCheck" } } @@ -7530,7 +8311,7 @@ "member": {} }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "NextToken": {}, @@ -7546,7 +8327,7 @@ "locationName": "networkInterfacePermissions", "type": "list", "member": { - "shape": "Sbj", + "shape": "Sc1", "locationName": "item" } }, @@ -7561,7 +8342,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "filter" }, "DryRun": { @@ -7588,7 +8369,7 @@ "locationName": "networkInterfaceSet", "type": "list", "member": { - "shape": "Sb5", + "shape": "Sbn", "locationName": "item" } }, @@ -7603,7 +8384,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -7654,7 +8435,7 @@ "type": "boolean" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -7662,7 +8443,7 @@ }, "NextToken": {}, "PrefixListIds": { - "shape": "Se", + "shape": "Sl", "locationName": "PrefixListId" } } @@ -7681,7 +8462,7 @@ "type": "structure", "members": { "Cidrs": { - "shape": "Se", + "shape": "Sl", "locationName": "cidrSet" }, "PrefixListId": { @@ -7730,7 +8511,7 @@ "locationName": "arn" }, "Statuses": { - "shape": "Sji", + "shape": "Skm", "locationName": "statusSet" } } @@ -7747,7 +8528,7 @@ "type": "structure", "members": { "PoolIds": { - "shape": "Se", + "shape": "Sl", "locationName": "PoolId" }, "NextToken": {}, @@ -7818,7 +8599,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "RegionNames": { @@ -7867,12 +8648,12 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "OfferingClass": {}, "ReservedInstancesIds": { - "shape": "Svt", + "shape": "Sy4", "locationName": "ReservedInstancesId" }, "DryRun": { @@ -7946,14 +8727,14 @@ "locationName": "offeringType" }, "RecurringCharges": { - "shape": "Sw1", + "shape": "Syc", "locationName": "recurringCharges" }, "Scope": { "locationName": "scope" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } @@ -7967,7 +8748,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "ReservedInstancesId": { @@ -7982,7 +8763,7 @@ "type": "structure", "members": { "ReservedInstancesListings": { - "shape": "S4g", + "shape": "S4q", "locationName": "reservedInstancesListingsSet" } } @@ -7993,7 +8774,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "ReservedInstancesModificationIds": { @@ -8043,7 +8824,7 @@ "locationName": "reservedInstancesId" }, "TargetConfiguration": { - "shape": "Swe", + "shape": "Syp", "locationName": "targetConfiguration" } } @@ -8087,7 +8868,7 @@ "members": { "AvailabilityZone": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "IncludeMarketplace": { @@ -8198,7 +8979,7 @@ } }, "RecurringCharges": { - "shape": "Sw1", + "shape": "Syc", "locationName": "recurringCharges" }, "Scope": { @@ -8218,7 +8999,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -8226,7 +9007,7 @@ "type": "boolean" }, "RouteTableIds": { - "shape": "Se", + "shape": "Sl", "locationName": "RouteTableId" }, "NextToken": {}, @@ -8242,7 +9023,7 @@ "locationName": "routeTableSet", "type": "list", "member": { - "shape": "Sbz", + "shape": "Sci", "locationName": "item" } }, @@ -8264,7 +9045,7 @@ "type": "boolean" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "FirstSlotStartTimeRange": { @@ -8363,7 +9144,7 @@ "locationName": "purchaseToken" }, "Recurrence": { - "shape": "Sx0", + "shape": "Szb", "locationName": "recurrence" }, "SlotDurationInHours": { @@ -8388,7 +9169,7 @@ "type": "boolean" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -8425,7 +9206,7 @@ "locationName": "scheduledInstanceSet", "type": "list", "member": { - "shape": "Sx7", + "shape": "Szi", "locationName": "item" } } @@ -8480,15 +9261,15 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "GroupIds": { - "shape": "S2y", + "shape": "S38", "locationName": "GroupId" }, "GroupNames": { - "shape": "Sxe", + "shape": "Szp", "locationName": "GroupName" }, "DryRun": { @@ -8518,7 +9299,7 @@ "locationName": "groupName" }, "IpPermissions": { - "shape": "S3i", + "shape": "S3s", "locationName": "ipPermissions" }, "OwnerId": { @@ -8528,11 +9309,11 @@ "locationName": "groupId" }, "IpPermissionsEgress": { - "shape": "S3i", + "shape": "S3s", "locationName": "ipPermissionsEgress" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "VpcId": { @@ -8567,11 +9348,11 @@ "type": "structure", "members": { "CreateVolumePermissions": { - "shape": "Sxm", + "shape": "Szx", "locationName": "createVolumePermission" }, "ProductCodes": { - "shape": "Snu", + "shape": "Sp5", "locationName": "productCodes" }, "SnapshotId": { @@ -8585,7 +9366,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -8593,7 +9374,7 @@ }, "NextToken": {}, "OwnerIds": { - "shape": "Snz", + "shape": "Spa", "locationName": "Owner" }, "RestorableByUserIds": { @@ -8602,7 +9383,7 @@ "member": {} }, "SnapshotIds": { - "shape": "Sxq", + "shape": "S101", "locationName": "SnapshotId" }, "DryRun": { @@ -8618,7 +9399,7 @@ "locationName": "snapshotSet", "type": "list", "member": { - "shape": "Scb", + "shape": "Scu", "locationName": "item" } }, @@ -8642,7 +9423,7 @@ "type": "structure", "members": { "SpotDatafeedSubscription": { - "shape": "Scm", + "shape": "Sd5", "locationName": "spotDatafeedSubscription" } } @@ -8675,7 +9456,7 @@ "type": "structure", "members": { "ActiveInstances": { - "shape": "Sn1", + "shape": "Soc", "locationName": "activeInstanceSet" }, "NextToken": { @@ -8729,7 +9510,7 @@ "type": "structure", "members": { "EventInformation": { - "shape": "Smy", + "shape": "So9", "locationName": "eventInformation" }, "EventType": { @@ -8775,7 +9556,7 @@ "locationName": "nextToken" }, "SpotFleetRequestIds": { - "shape": "Se", + "shape": "Sl", "locationName": "spotFleetRequestId" } } @@ -8801,7 +9582,7 @@ "type": "timestamp" }, "SpotFleetRequestConfig": { - "shape": "Sy9", + "shape": "S10k", "locationName": "spotFleetRequestConfig" }, "SpotFleetRequestId": { @@ -8821,7 +9602,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -8829,7 +9610,7 @@ "type": "boolean" }, "SpotInstanceRequestIds": { - "shape": "S51", + "shape": "S5b", "locationName": "SpotInstanceRequestId" }, "NextToken": {}, @@ -8842,7 +9623,7 @@ "type": "structure", "members": { "SpotInstanceRequests": { - "shape": "Syy", + "shape": "S119", "locationName": "spotInstanceRequestSet" }, "NextToken": { @@ -8856,7 +9637,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "AvailabilityZone": { @@ -8968,11 +9749,11 @@ "locationName": "groupName" }, "StaleIpPermissions": { - "shape": "Szg", + "shape": "S11r", "locationName": "staleIpPermissions" }, "StaleIpPermissionsEgress": { - "shape": "Szg", + "shape": "S11r", "locationName": "staleIpPermissionsEgress" }, "VpcId": { @@ -8989,7 +9770,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "SubnetIds": { @@ -9016,7 +9797,7 @@ "locationName": "subnetSet", "type": "list", "member": { - "shape": "S67", + "shape": "S6h", "locationName": "item" } }, @@ -9035,7 +9816,7 @@ "type": "boolean" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9083,14 +9864,14 @@ "type": "structure", "members": { "TrafficMirrorFilterIds": { - "shape": "Se", + "shape": "Sl", "locationName": "TrafficMirrorFilterId" }, "DryRun": { "type": "boolean" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9106,7 +9887,7 @@ "locationName": "trafficMirrorFilterSet", "type": "list", "member": { - "shape": "Scv", + "shape": "Sde", "locationName": "item" } }, @@ -9121,14 +9902,14 @@ "type": "structure", "members": { "TrafficMirrorSessionIds": { - "shape": "Se", + "shape": "Sl", "locationName": "TrafficMirrorSessionId" }, "DryRun": { "type": "boolean" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9144,7 +9925,7 @@ "locationName": "trafficMirrorSessionSet", "type": "list", "member": { - "shape": "Sda", + "shape": "Sdt", "locationName": "item" } }, @@ -9159,14 +9940,14 @@ "type": "structure", "members": { "TrafficMirrorTargetIds": { - "shape": "Se", + "shape": "Sl", "locationName": "TrafficMirrorTargetId" }, "DryRun": { "type": "boolean" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9182,7 +9963,7 @@ "locationName": "trafficMirrorTargetSet", "type": "list", "member": { - "shape": "Sdd", + "shape": "Sdw", "locationName": "item" } }, @@ -9197,10 +9978,10 @@ "type": "structure", "members": { "TransitGatewayAttachmentIds": { - "shape": "S105" + "shape": "S12g" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9260,7 +10041,7 @@ "type": "timestamp" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } @@ -9272,6 +10053,83 @@ } } }, + "DescribeTransitGatewayMulticastDomains": { + "input": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainIds": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "Filters": { + "shape": "Skd", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomains": { + "locationName": "transitGatewayMulticastDomains", + "type": "list", + "member": { + "shape": "Seb", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "DescribeTransitGatewayPeeringAttachments": { + "input": { + "type": "structure", + "members": { + "TransitGatewayAttachmentIds": { + "shape": "S12g" + }, + "Filters": { + "shape": "Skd", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachments": { + "locationName": "transitGatewayPeeringAttachments", + "type": "list", + "member": { + "shape": "Sb", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, "DescribeTransitGatewayRouteTables": { "input": { "type": "structure", @@ -9283,7 +10141,7 @@ } }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9302,7 +10160,7 @@ "locationName": "transitGatewayRouteTables", "type": "list", "member": { - "shape": "Sdy", + "shape": "Seo", "locationName": "item" } }, @@ -9317,10 +10175,10 @@ "type": "structure", "members": { "TransitGatewayAttachmentIds": { - "shape": "S105" + "shape": "S12g" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9339,7 +10197,7 @@ "locationName": "transitGatewayVpcAttachments", "type": "list", "member": { - "shape": "Sc", + "shape": "Sk", "locationName": "item" } }, @@ -9360,7 +10218,7 @@ } }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9379,7 +10237,7 @@ "locationName": "transitGatewaySet", "type": "list", "member": { - "shape": "Sdm", + "shape": "Se6", "locationName": "item" } }, @@ -9409,11 +10267,11 @@ "type": "structure", "members": { "AutoEnableIO": { - "shape": "Sqa", + "shape": "Srl", "locationName": "autoEnableIO" }, "ProductCodes": { - "shape": "Snu", + "shape": "Sp5", "locationName": "productCodes" }, "VolumeId": { @@ -9427,7 +10285,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9435,7 +10293,7 @@ }, "NextToken": {}, "VolumeIds": { - "shape": "S10q", + "shape": "S138", "locationName": "VolumeId" }, "DryRun": { @@ -9482,6 +10340,9 @@ "AvailabilityZone": { "locationName": "availabilityZone" }, + "OutpostArn": { + "locationName": "outpostArn" + }, "Events": { "locationName": "eventsSet", "type": "list", @@ -9548,11 +10409,11 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "VolumeIds": { - "shape": "S10q", + "shape": "S138", "locationName": "VolumeId" }, "DryRun": { @@ -9575,7 +10436,7 @@ "locationName": "volumeSet", "type": "list", "member": { - "shape": "Se6", + "shape": "Sew", "locationName": "item" } }, @@ -9593,11 +10454,11 @@ "type": "boolean" }, "VolumeIds": { - "shape": "S10q", + "shape": "S138", "locationName": "VolumeId" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "NextToken": {}, @@ -9613,7 +10474,7 @@ "locationName": "volumeModificationSet", "type": "list", "member": { - "shape": "S119", + "shape": "S13r", "locationName": "item" } }, @@ -9646,11 +10507,11 @@ "locationName": "vpcId" }, "EnableDnsHostnames": { - "shape": "Sqa", + "shape": "Srl", "locationName": "enableDnsHostnames" }, "EnableDnsSupport": { - "shape": "Sqa", + "shape": "Srl", "locationName": "enableDnsSupport" } } @@ -9661,7 +10522,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -9669,7 +10530,7 @@ "type": "boolean" }, "VpcIds": { - "shape": "S11f", + "shape": "S13x", "locationName": "VpcId" } } @@ -9689,7 +10550,7 @@ "type": "boolean" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "VpcId": { @@ -9713,7 +10574,7 @@ "locationName": "nextToken" }, "VpcIds": { - "shape": "S11f" + "shape": "S13x" } } }, @@ -9752,7 +10613,7 @@ }, "ConnectionNotificationId": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9768,7 +10629,7 @@ "locationName": "connectionNotificationSet", "type": "list", "member": { - "shape": "Sen", + "shape": "Sfd", "locationName": "item" } }, @@ -9786,7 +10647,7 @@ "type": "boolean" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9822,11 +10683,11 @@ "type": "timestamp" }, "DnsEntries": { - "shape": "Sei", + "shape": "Sf8", "locationName": "dnsEntrySet" }, "NetworkLoadBalancerArns": { - "shape": "Se", + "shape": "Sl", "locationName": "networkLoadBalancerArnSet" } } @@ -9846,11 +10707,11 @@ "type": "boolean" }, "ServiceIds": { - "shape": "Se", + "shape": "Sl", "locationName": "ServiceId" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9866,7 +10727,7 @@ "locationName": "serviceConfigurationSet", "type": "list", "member": { - "shape": "Ses", + "shape": "Sfi", "locationName": "item" } }, @@ -9888,7 +10749,7 @@ }, "ServiceId": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9930,11 +10791,11 @@ "type": "boolean" }, "ServiceNames": { - "shape": "Se", + "shape": "Sl", "locationName": "ServiceName" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -9947,7 +10808,7 @@ "type": "structure", "members": { "ServiceNames": { - "shape": "Se", + "shape": "Sl", "locationName": "serviceNameSet" }, "ServiceDetails": { @@ -9964,18 +10825,18 @@ "locationName": "serviceId" }, "ServiceType": { - "shape": "Set", + "shape": "Sfj", "locationName": "serviceType" }, "AvailabilityZones": { - "shape": "Se", + "shape": "Sl", "locationName": "availabilityZoneSet" }, "Owner": { "locationName": "owner" }, "BaseEndpointDnsNames": { - "shape": "Se", + "shape": "Sl", "locationName": "baseEndpointDnsNameSet" }, "PrivateDnsName": { @@ -9994,7 +10855,7 @@ "type": "boolean" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } @@ -10014,11 +10875,11 @@ "type": "boolean" }, "VpcEndpointIds": { - "shape": "Se", + "shape": "Sl", "locationName": "VpcEndpointId" }, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -10034,7 +10895,7 @@ "locationName": "vpcEndpointSet", "type": "list", "member": { - "shape": "See", + "shape": "Sf4", "locationName": "item" } }, @@ -10049,7 +10910,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "DryRun": { @@ -10057,7 +10918,7 @@ "type": "boolean" }, "VpcPeeringConnectionIds": { - "shape": "Se", + "shape": "Sl", "locationName": "VpcPeeringConnectionId" }, "NextToken": {}, @@ -10073,7 +10934,7 @@ "locationName": "vpcPeeringConnectionSet", "type": "list", "member": { - "shape": "Su", + "shape": "Sy", "locationName": "item" } }, @@ -10088,7 +10949,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "VpcIds": { @@ -10115,7 +10976,7 @@ "locationName": "vpcSet", "type": "list", "member": { - "shape": "S6c", + "shape": "S6m", "locationName": "item" } }, @@ -10130,7 +10991,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "VpnConnectionIds": { @@ -10153,7 +11014,7 @@ "locationName": "vpnConnectionSet", "type": "list", "member": { - "shape": "Sfj", + "shape": "Sg9", "locationName": "item" } } @@ -10165,7 +11026,7 @@ "type": "structure", "members": { "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "VpnGatewayIds": { @@ -10188,7 +11049,7 @@ "locationName": "vpnGatewaySet", "type": "list", "member": { - "shape": "Sgc", + "shape": "Sh2", "locationName": "item" } } @@ -10287,7 +11148,7 @@ } }, "output": { - "shape": "S36" + "shape": "S3g" } }, "DetachVpnGateway": { @@ -10335,11 +11196,11 @@ ], "members": { "AvailabilityZones": { - "shape": "S132", + "shape": "S15k", "locationName": "AvailabilityZone" }, "SourceSnapshotIds": { - "shape": "Sxq", + "shape": "S101", "locationName": "SourceSnapshotId" }, "DryRun": { @@ -10458,7 +11319,7 @@ "type": "structure", "members": { "Propagation": { - "shape": "S13d", + "shape": "S15v", "locationName": "propagation" } } @@ -10555,7 +11416,7 @@ "locationName": "associationId" }, "Status": { - "shape": "S23", + "shape": "S27", "locationName": "status" } } @@ -10575,7 +11436,7 @@ "type": "structure", "members": { "IamInstanceProfileAssociation": { - "shape": "S2a", + "shape": "S2e", "locationName": "iamInstanceProfileAssociation" } } @@ -10614,7 +11475,7 @@ "type": "structure", "members": { "Ipv6CidrBlockAssociation": { - "shape": "S2i", + "shape": "S2n", "locationName": "ipv6CidrBlockAssociation" }, "SubnetId": { @@ -10623,6 +11484,30 @@ } } }, + "DisassociateTransitGatewayMulticastDomain": { + "input": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": {}, + "TransitGatewayAttachmentId": {}, + "SubnetIds": { + "shape": "Sl" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Associations": { + "shape": "S2s", + "locationName": "associations" + } + } + } + }, "DisassociateTransitGatewayRouteTable": { "input": { "type": "structure", @@ -10642,7 +11527,7 @@ "type": "structure", "members": { "Association": { - "shape": "S2o", + "shape": "S2z", "locationName": "association" } } @@ -10664,11 +11549,11 @@ "type": "structure", "members": { "Ipv6CidrBlockAssociation": { - "shape": "S2t", + "shape": "S33", "locationName": "ipv6CidrBlockAssociation" }, "CidrBlockAssociation": { - "shape": "S2w", + "shape": "S36", "locationName": "cidrBlockAssociation" }, "VpcId": { @@ -10705,11 +11590,11 @@ ], "members": { "AvailabilityZones": { - "shape": "S132", + "shape": "S15k", "locationName": "AvailabilityZone" }, "SourceSnapshotIds": { - "shape": "Sxq", + "shape": "S101", "locationName": "SourceSnapshotId" }, "DryRun": { @@ -10828,7 +11713,7 @@ "type": "structure", "members": { "Propagation": { - "shape": "S13d", + "shape": "S15v", "locationName": "propagation" } } @@ -11016,7 +11901,7 @@ "locationName": "progress" }, "S3ExportLocation": { - "shape": "Smi", + "shape": "Snt", "locationName": "s3ExportLocation" }, "Status": { @@ -11038,7 +11923,7 @@ "members": { "TransitGatewayRouteTableId": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "S3Bucket": {}, @@ -11116,6 +12001,61 @@ } } }, + "GetCoipPoolUsage": { + "input": { + "type": "structure", + "required": [ + "PoolId" + ], + "members": { + "PoolId": {}, + "Filters": { + "shape": "Skd", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "CoipPoolId": { + "locationName": "coipPoolId" + }, + "CoipAddressUsages": { + "locationName": "coipAddressUsageSet", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "AllocationId": { + "locationName": "allocationId" + }, + "AwsAccountId": { + "locationName": "awsAccountId" + }, + "AwsService": { + "locationName": "awsService" + }, + "CoIp": { + "locationName": "coIp" + } + } + } + }, + "LocalGatewayRouteTableId": { + "locationName": "localGatewayRouteTableId" + } + } + } + }, "GetConsoleOutput": { "input": { "type": "structure", @@ -11194,7 +12134,7 @@ "type": "structure", "members": { "InstanceFamilyCreditSpecification": { - "shape": "S156", + "shape": "S17t", "locationName": "instanceFamilyCreditSpecification" } } @@ -11246,7 +12186,7 @@ ], "members": { "HostIdSet": { - "shape": "S15c" + "shape": "S17z" }, "OfferingId": {} } @@ -11258,7 +12198,7 @@ "locationName": "currencyCode" }, "Purchase": { - "shape": "S15g", + "shape": "S183", "locationName": "purchase" }, "TotalHourlyPrice": { @@ -11287,7 +12227,7 @@ "type": "structure", "members": { "LaunchTemplateData": { - "shape": "S9t", + "shape": "Sa3", "locationName": "launchTemplateData" } } @@ -11361,7 +12301,7 @@ "locationName": "paymentDue" }, "ReservedInstanceValueRollup": { - "shape": "S15o", + "shape": "S18b", "locationName": "reservedInstanceValueRollup" }, "ReservedInstanceValueSet": { @@ -11372,7 +12312,7 @@ "type": "structure", "members": { "ReservationValue": { - "shape": "S15o", + "shape": "S18b", "locationName": "reservationValue" }, "ReservedInstanceId": { @@ -11382,7 +12322,7 @@ } }, "TargetConfigurationValueRollup": { - "shape": "S15o", + "shape": "S18b", "locationName": "targetConfigurationValueRollup" }, "TargetConfigurationValueSet": { @@ -11393,7 +12333,7 @@ "type": "structure", "members": { "ReservationValue": { - "shape": "S15o", + "shape": "S18b", "locationName": "reservationValue" }, "TargetConfiguration": { @@ -11427,7 +12367,7 @@ "members": { "TransitGatewayAttachmentId": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -11464,6 +12404,56 @@ } } }, + "GetTransitGatewayMulticastDomainAssociations": { + "input": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": {}, + "Filters": { + "shape": "Skd", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "MulticastDomainAssociations": { + "locationName": "multicastDomainAssociations", + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "locationName": "transitGatewayAttachmentId" + }, + "ResourceId": { + "locationName": "resourceId" + }, + "ResourceType": { + "locationName": "resourceType" + }, + "Subnet": { + "shape": "S2v", + "locationName": "subnet" + } + } + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, "GetTransitGatewayRouteTableAssociations": { "input": { "type": "structure", @@ -11473,7 +12463,7 @@ "members": { "TransitGatewayRouteTableId": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -11525,7 +12515,7 @@ "members": { "TransitGatewayRouteTableId": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -11599,7 +12589,7 @@ "members": { "Architecture": {}, "ClientData": { - "shape": "S169" + "shape": "S190" }, "ClientToken": {}, "Description": {}, @@ -11616,7 +12606,7 @@ "SnapshotId": {}, "Url": {}, "UserBucket": { - "shape": "S16c" + "shape": "S193" } } } @@ -11679,7 +12669,7 @@ "locationName": "progress" }, "SnapshotDetails": { - "shape": "Spu", + "shape": "Sr5", "locationName": "snapshotDetailSet" }, "Status": { @@ -11689,7 +12679,7 @@ "locationName": "statusMessage" }, "LicenseSpecifications": { - "shape": "Spx", + "shape": "Sr8", "locationName": "licenseSpecifications" } } @@ -11713,10 +12703,10 @@ "members": { "Description": {}, "Image": { - "shape": "S16j" + "shape": "S19a" }, "Volume": { - "shape": "S16k" + "shape": "S19b" } } } @@ -11736,11 +12726,11 @@ "locationName": "architecture" }, "GroupIds": { - "shape": "S8v", + "shape": "S95", "locationName": "GroupId" }, "GroupNames": { - "shape": "S99", + "shape": "S9j", "locationName": "GroupName" }, "InstanceInitiatedShutdownBehavior": { @@ -11754,7 +12744,7 @@ "type": "boolean" }, "Placement": { - "shape": "S7a", + "shape": "S7k", "locationName": "placement" }, "PrivateIpAddress": { @@ -11784,7 +12774,7 @@ "type": "structure", "members": { "ConversionTask": { - "shape": "Slh", + "shape": "Sms", "locationName": "conversionTask" } } @@ -11828,7 +12818,7 @@ "type": "structure", "members": { "ClientData": { - "shape": "S169" + "shape": "S190" }, "ClientToken": {}, "Description": {}, @@ -11839,7 +12829,7 @@ "Format": {}, "Url": {}, "UserBucket": { - "shape": "S16c" + "shape": "S193" } } }, @@ -11863,7 +12853,7 @@ "locationName": "importTaskId" }, "SnapshotTaskDetail": { - "shape": "Sq3", + "shape": "Sre", "locationName": "snapshotTaskDetail" } } @@ -11889,11 +12879,11 @@ "type": "boolean" }, "Image": { - "shape": "S16j", + "shape": "S19a", "locationName": "image" }, "Volume": { - "shape": "S16k", + "shape": "S19b", "locationName": "volume" } } @@ -11902,7 +12892,7 @@ "type": "structure", "members": { "ConversionTask": { - "shape": "Slh", + "shape": "Sms", "locationName": "conversionTask" } } @@ -11948,13 +12938,13 @@ "ClientVpnEndpointId": {}, "ServerCertificateArn": {}, "ConnectionLogOptions": { - "shape": "S5s" + "shape": "S62" }, "DnsServers": { "type": "structure", "members": { "CustomDnsServers": { - "shape": "Se" + "shape": "Sl" }, "Enabled": { "type": "boolean" @@ -11999,7 +12989,7 @@ "type": "structure", "members": { "InstanceFamilyCreditSpecification": { - "shape": "S156", + "shape": "S17t", "locationName": "instanceFamilyCreditSpecification" } } @@ -12041,7 +13031,7 @@ "ExcessCapacityTerminationPolicy": {}, "FleetId": {}, "TargetCapacitySpecification": { - "shape": "S7b" + "shape": "S7l" } } }, @@ -12069,25 +13059,25 @@ "Attribute": {}, "OperationType": {}, "UserIds": { - "shape": "S178", + "shape": "S19z", "locationName": "UserId" }, "UserGroups": { - "shape": "S179", + "shape": "S1a0", "locationName": "UserGroup" }, "ProductCodes": { - "shape": "S17a", + "shape": "S1a1", "locationName": "ProductCode" }, "LoadPermission": { "type": "structure", "members": { "Add": { - "shape": "S17c" + "shape": "S1a3" }, "Remove": { - "shape": "S17c" + "shape": "S1a3" } } }, @@ -12099,7 +13089,7 @@ "type": "structure", "members": { "FpgaImageAttribute": { - "shape": "Snq", + "shape": "Sp1", "locationName": "fpgaImageAttribute" } } @@ -12116,7 +13106,7 @@ "locationName": "autoPlacement" }, "HostIds": { - "shape": "Sol", + "shape": "Spw", "locationName": "hostId" }, "HostRecovery": {}, @@ -12128,11 +13118,11 @@ "type": "structure", "members": { "Successful": { - "shape": "S1h", + "shape": "S1l", "locationName": "successful" }, "Unsuccessful": { - "shape": "S17h", + "shape": "S1a8", "locationName": "unsuccessful" } } @@ -12184,31 +13174,31 @@ "members": { "Attribute": {}, "Description": { - "shape": "S6p" + "shape": "S6z" }, "ImageId": {}, "LaunchPermission": { "type": "structure", "members": { "Add": { - "shape": "Spa" + "shape": "Sql" }, "Remove": { - "shape": "Spa" + "shape": "Sql" } } }, "OperationType": {}, "ProductCodes": { - "shape": "S17a", + "shape": "S1a1", "locationName": "ProductCode" }, "UserGroups": { - "shape": "S179", + "shape": "S1a0", "locationName": "UserGroup" }, "UserIds": { - "shape": "S178", + "shape": "S19z", "locationName": "UserId" }, "Value": {}, @@ -12227,7 +13217,7 @@ ], "members": { "SourceDestCheck": { - "shape": "Sqa" + "shape": "Srl" }, "Attribute": { "locationName": "attribute" @@ -12265,7 +13255,7 @@ } }, "DisableApiTermination": { - "shape": "Sqa", + "shape": "Srl", "locationName": "disableApiTermination" }, "DryRun": { @@ -12273,38 +13263,38 @@ "type": "boolean" }, "EbsOptimized": { - "shape": "Sqa", + "shape": "Srl", "locationName": "ebsOptimized" }, "EnaSupport": { - "shape": "Sqa", + "shape": "Srl", "locationName": "enaSupport" }, "Groups": { - "shape": "S2y", + "shape": "S38", "locationName": "GroupId" }, "InstanceId": { "locationName": "instanceId" }, "InstanceInitiatedShutdownBehavior": { - "shape": "S6p", + "shape": "S6z", "locationName": "instanceInitiatedShutdownBehavior" }, "InstanceType": { - "shape": "S6p", + "shape": "S6z", "locationName": "instanceType" }, "Kernel": { - "shape": "S6p", + "shape": "S6z", "locationName": "kernel" }, "Ramdisk": { - "shape": "S6p", + "shape": "S6z", "locationName": "ramdisk" }, "SriovNetSupport": { - "shape": "S6p", + "shape": "S6z", "locationName": "sriovNetSupport" }, "UserData": { @@ -12333,7 +13323,7 @@ "members": { "InstanceId": {}, "CapacityReservationSpecification": { - "shape": "S17s" + "shape": "S1aj" }, "DryRun": { "type": "boolean" @@ -12442,7 +13432,7 @@ "type": "structure", "members": { "Event": { - "shape": "Sql", + "shape": "Srw", "locationName": "event" } } @@ -12473,7 +13463,7 @@ "locationName": "instanceId" }, "InstanceMetadataOptions": { - "shape": "Stn", + "shape": "Sv4", "locationName": "instanceMetadataOptions" } } @@ -12534,7 +13524,7 @@ "type": "structure", "members": { "LaunchTemplate": { - "shape": "S9o", + "shape": "S9y", "locationName": "launchTemplate" } } @@ -12561,7 +13551,7 @@ } }, "Description": { - "shape": "S6p", + "shape": "S6z", "locationName": "description" }, "DryRun": { @@ -12569,14 +13559,14 @@ "type": "boolean" }, "Groups": { - "shape": "S8v", + "shape": "S95", "locationName": "SecurityGroupId" }, "NetworkInterfaceId": { "locationName": "networkInterfaceId" }, "SourceDestCheck": { - "shape": "Sqa", + "shape": "Srl", "locationName": "sourceDestCheck" } } @@ -12591,7 +13581,7 @@ ], "members": { "ReservedInstancesIds": { - "shape": "Svt", + "shape": "Sy4", "locationName": "ReservedInstancesId" }, "ClientToken": { @@ -12601,7 +13591,7 @@ "locationName": "ReservedInstancesConfigurationSetItemType", "type": "list", "member": { - "shape": "Swe", + "shape": "Syp", "locationName": "item" } } @@ -12628,21 +13618,21 @@ "type": "structure", "members": { "Add": { - "shape": "Sxm" + "shape": "Szx" }, "Remove": { - "shape": "Sxm" + "shape": "Szx" } } }, "GroupNames": { - "shape": "Sxe", + "shape": "Szp", "locationName": "UserGroup" }, "OperationType": {}, "SnapshotId": {}, "UserIds": { - "shape": "S178", + "shape": "S19z", "locationName": "UserId" }, "DryRun": { @@ -12692,10 +13682,10 @@ ], "members": { "AssignIpv6AddressOnCreation": { - "shape": "Sqa" + "shape": "Srl" }, "MapPublicIpOnLaunch": { - "shape": "Sqa" + "shape": "Srl" }, "SubnetId": { "locationName": "subnetId" @@ -12712,11 +13702,11 @@ "members": { "TrafficMirrorFilterId": {}, "AddNetworkServices": { - "shape": "Sd1", + "shape": "Sdk", "locationName": "AddNetworkService" }, "RemoveNetworkServices": { - "shape": "Sd1", + "shape": "Sdk", "locationName": "RemoveNetworkService" }, "DryRun": { @@ -12728,7 +13718,7 @@ "type": "structure", "members": { "TrafficMirrorFilter": { - "shape": "Scv", + "shape": "Sde", "locationName": "trafficMirrorFilter" } } @@ -12748,10 +13738,10 @@ }, "RuleAction": {}, "DestinationPortRange": { - "shape": "Sd5" + "shape": "Sdo" }, "SourcePortRange": { - "shape": "Sd5" + "shape": "Sdo" }, "Protocol": { "type": "integer" @@ -12773,7 +13763,7 @@ "type": "structure", "members": { "TrafficMirrorFilterRule": { - "shape": "Scx", + "shape": "Sdg", "locationName": "trafficMirrorFilterRule" } } @@ -12813,7 +13803,7 @@ "type": "structure", "members": { "TrafficMirrorSession": { - "shape": "Sda", + "shape": "Sdt", "locationName": "trafficMirrorSession" } } @@ -12828,10 +13818,10 @@ "members": { "TransitGatewayAttachmentId": {}, "AddSubnetIds": { - "shape": "Se" + "shape": "Sl" }, "RemoveSubnetIds": { - "shape": "Se" + "shape": "Sl" }, "Options": { "type": "structure", @@ -12849,7 +13839,7 @@ "type": "structure", "members": { "TransitGatewayVpcAttachment": { - "shape": "Sc", + "shape": "Sk", "locationName": "transitGatewayVpcAttachment" } } @@ -12879,7 +13869,7 @@ "type": "structure", "members": { "VolumeModification": { - "shape": "S119", + "shape": "S13r", "locationName": "volumeModification" } } @@ -12893,7 +13883,7 @@ ], "members": { "AutoEnableIO": { - "shape": "Sqa" + "shape": "Srl" }, "VolumeId": {}, "DryRun": { @@ -12911,10 +13901,10 @@ ], "members": { "EnableDnsHostnames": { - "shape": "Sqa" + "shape": "Srl" }, "EnableDnsSupport": { - "shape": "Sqa" + "shape": "Srl" }, "VpcId": { "locationName": "vpcId" @@ -12938,27 +13928,27 @@ }, "PolicyDocument": {}, "AddRouteTableIds": { - "shape": "Se", + "shape": "Sl", "locationName": "AddRouteTableId" }, "RemoveRouteTableIds": { - "shape": "Se", + "shape": "Sl", "locationName": "RemoveRouteTableId" }, "AddSubnetIds": { - "shape": "Se", + "shape": "Sl", "locationName": "AddSubnetId" }, "RemoveSubnetIds": { - "shape": "Se", + "shape": "Sl", "locationName": "RemoveSubnetId" }, "AddSecurityGroupIds": { - "shape": "Se", + "shape": "Sl", "locationName": "AddSecurityGroupId" }, "RemoveSecurityGroupIds": { - "shape": "Se", + "shape": "Sl", "locationName": "RemoveSecurityGroupId" }, "PrivateDnsEnabled": { @@ -12989,7 +13979,7 @@ "ConnectionNotificationId": {}, "ConnectionNotificationArn": {}, "ConnectionEvents": { - "shape": "Se" + "shape": "Sl" } } }, @@ -13018,11 +14008,11 @@ "type": "boolean" }, "AddNetworkLoadBalancerArns": { - "shape": "Se", + "shape": "Sl", "locationName": "AddNetworkLoadBalancerArn" }, "RemoveNetworkLoadBalancerArns": { - "shape": "Se", + "shape": "Sl", "locationName": "RemoveNetworkLoadBalancerArn" } } @@ -13049,10 +14039,10 @@ }, "ServiceId": {}, "AddAllowedPrincipals": { - "shape": "Se" + "shape": "Sl" }, "RemoveAllowedPrincipals": { - "shape": "Se" + "shape": "Sl" } } }, @@ -13074,13 +14064,13 @@ ], "members": { "AccepterPeeringConnectionOptions": { - "shape": "S19h" + "shape": "S1c8" }, "DryRun": { "type": "boolean" }, "RequesterPeeringConnectionOptions": { - "shape": "S19h" + "shape": "S1c8" }, "VpcPeeringConnectionId": {} } @@ -13089,11 +14079,11 @@ "type": "structure", "members": { "AccepterPeeringConnectionOptions": { - "shape": "S19j", + "shape": "S1ca", "locationName": "accepterPeeringConnectionOptions" }, "RequesterPeeringConnectionOptions": { - "shape": "S19j", + "shape": "S1ca", "locationName": "requesterPeeringConnectionOptions" } } @@ -13144,7 +14134,7 @@ "type": "structure", "members": { "VpnConnection": { - "shape": "Sfj", + "shape": "Sg9", "locationName": "vpnConnection" } } @@ -13169,7 +14159,7 @@ "type": "structure", "members": { "VpnConnection": { - "shape": "Sfj", + "shape": "Sg9", "locationName": "vpnConnection" } } @@ -13210,31 +14200,31 @@ "type": "integer" }, "Phase1EncryptionAlgorithms": { - "shape": "Sf4", + "shape": "Sfu", "locationName": "Phase1EncryptionAlgorithm" }, "Phase2EncryptionAlgorithms": { - "shape": "Sf6", + "shape": "Sfw", "locationName": "Phase2EncryptionAlgorithm" }, "Phase1IntegrityAlgorithms": { - "shape": "Sf8", + "shape": "Sfy", "locationName": "Phase1IntegrityAlgorithm" }, "Phase2IntegrityAlgorithms": { - "shape": "Sfa", + "shape": "Sg0", "locationName": "Phase2IntegrityAlgorithm" }, "Phase1DHGroupNumbers": { - "shape": "Sfc", + "shape": "Sg2", "locationName": "Phase1DHGroupNumber" }, "Phase2DHGroupNumbers": { - "shape": "Sfe", + "shape": "Sg4", "locationName": "Phase2DHGroupNumber" }, "IKEVersions": { - "shape": "Sfg", + "shape": "Sg6", "locationName": "IKEVersion" } } @@ -13248,7 +14238,7 @@ "type": "structure", "members": { "VpnConnection": { - "shape": "Sfj", + "shape": "Sg9", "locationName": "vpnConnection" } } @@ -13262,7 +14252,7 @@ ], "members": { "InstanceIds": { - "shape": "Sk8", + "shape": "Sld", "locationName": "InstanceId" }, "DryRun": { @@ -13275,7 +14265,7 @@ "type": "structure", "members": { "InstanceMonitorings": { - "shape": "S19w", + "shape": "S1cn", "locationName": "instancesSet" } } @@ -13338,7 +14328,7 @@ "type": "structure", "members": { "ByoipCidr": { - "shape": "S15", + "shape": "S19", "locationName": "byoipCidr" } } @@ -13355,7 +14345,7 @@ "ClientToken": {}, "CurrencyCode": {}, "HostIdSet": { - "shape": "S15c" + "shape": "S17z" }, "LimitPrice": {}, "OfferingId": {} @@ -13371,7 +14361,7 @@ "locationName": "currencyCode" }, "Purchase": { - "shape": "S15g", + "shape": "S183", "locationName": "purchase" }, "TotalHourlyPrice": { @@ -13466,7 +14456,7 @@ "locationName": "scheduledInstanceSet", "type": "list", "member": { - "shape": "Sx7", + "shape": "Szi", "locationName": "item" } } @@ -13481,7 +14471,7 @@ ], "members": { "InstanceIds": { - "shape": "Sk8", + "shape": "Sld", "locationName": "InstanceId" }, "DryRun": { @@ -13503,7 +14493,7 @@ "locationName": "architecture" }, "BlockDeviceMappings": { - "shape": "S80", + "shape": "S8a", "locationName": "BlockDeviceMapping" }, "Description": { @@ -13553,6 +14543,101 @@ } } }, + "RegisterTransitGatewayMulticastGroupMembers": { + "input": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": {}, + "GroupIpAddress": {}, + "NetworkInterfaceIds": { + "shape": "Sl" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "RegisteredMulticastGroupMembers": { + "locationName": "registeredMulticastGroupMembers", + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "locationName": "transitGatewayMulticastDomainId" + }, + "RegisteredNetworkInterfaceIds": { + "shape": "Sl", + "locationName": "registeredNetworkInterfaceIds" + }, + "GroupIpAddress": { + "locationName": "groupIpAddress" + } + } + } + } + } + }, + "RegisterTransitGatewayMulticastGroupSources": { + "input": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": {}, + "GroupIpAddress": {}, + "NetworkInterfaceIds": { + "shape": "Sl" + }, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "RegisteredMulticastGroupSources": { + "locationName": "registeredMulticastGroupSources", + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "locationName": "transitGatewayMulticastDomainId" + }, + "RegisteredNetworkInterfaceIds": { + "shape": "Sl", + "locationName": "registeredNetworkInterfaceIds" + }, + "GroupIpAddress": { + "locationName": "groupIpAddress" + } + } + } + } + } + }, + "RejectTransitGatewayPeeringAttachment": { + "input": { + "type": "structure", + "required": [ + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayAttachmentId": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayPeeringAttachment": { + "shape": "Sb", + "locationName": "transitGatewayPeeringAttachment" + } + } + } + }, "RejectTransitGatewayVpcAttachment": { "input": { "type": "structure", @@ -13570,7 +14655,7 @@ "type": "structure", "members": { "TransitGatewayVpcAttachment": { - "shape": "Sc", + "shape": "Sk", "locationName": "transitGatewayVpcAttachment" } } @@ -13589,7 +14674,7 @@ }, "ServiceId": {}, "VpcEndpointIds": { - "shape": "Se", + "shape": "Sl", "locationName": "VpcEndpointId" } } @@ -13598,7 +14683,7 @@ "type": "structure", "members": { "Unsuccessful": { - "shape": "So", + "shape": "Ss", "locationName": "unsuccessful" } } @@ -13636,6 +14721,7 @@ "members": { "AllocationId": {}, "PublicIp": {}, + "NetworkBorderGroup": {}, "DryRun": { "locationName": "dryRun", "type": "boolean" @@ -13651,7 +14737,7 @@ ], "members": { "HostIds": { - "shape": "Sol", + "shape": "Spw", "locationName": "hostId" } } @@ -13660,11 +14746,11 @@ "type": "structure", "members": { "Successful": { - "shape": "S1h", + "shape": "S1l", "locationName": "successful" }, "Unsuccessful": { - "shape": "S17h", + "shape": "S1a8", "locationName": "unsuccessful" } } @@ -13679,7 +14765,7 @@ ], "members": { "IamInstanceProfile": { - "shape": "S28" + "shape": "S2c" }, "AssociationId": {} } @@ -13688,7 +14774,7 @@ "type": "structure", "members": { "IamInstanceProfileAssociation": { - "shape": "S2a", + "shape": "S2e", "locationName": "iamInstanceProfileAssociation" } } @@ -13746,7 +14832,7 @@ "type": "boolean" }, "IcmpTypeCode": { - "shape": "Sax", + "shape": "Sbf", "locationName": "Icmp" }, "Ipv6CidrBlock": { @@ -13756,7 +14842,7 @@ "locationName": "networkAclId" }, "PortRange": { - "shape": "Say", + "shape": "Sbg", "locationName": "portRange" }, "Protocol": { @@ -13798,10 +14884,14 @@ "InstanceId": { "locationName": "instanceId" }, + "LocalTarget": { + "type": "boolean" + }, "NatGatewayId": { "locationName": "natGatewayId" }, "TransitGatewayId": {}, + "LocalGatewayId": {}, "NetworkInterfaceId": { "locationName": "networkInterfaceId" }, @@ -13839,6 +14929,10 @@ "members": { "NewAssociationId": { "locationName": "newAssociationId" + }, + "AssociationState": { + "shape": "S2j", + "locationName": "associationState" } } } @@ -13866,7 +14960,7 @@ "type": "structure", "members": { "Route": { - "shape": "Sdr", + "shape": "Seh", "locationName": "route" } } @@ -13893,7 +14987,7 @@ "type": "timestamp" }, "Instances": { - "shape": "Sk8", + "shape": "Sld", "locationName": "instanceId" }, "ReasonCodes": { @@ -13925,7 +15019,7 @@ "type": "boolean" }, "SpotFleetRequestConfig": { - "shape": "Sy9", + "shape": "S10k", "locationName": "spotFleetRequestConfig" } } @@ -13968,18 +15062,18 @@ "type": "structure", "members": { "SecurityGroupIds": { - "shape": "Se", + "shape": "Sl", "locationName": "SecurityGroupId" }, "SecurityGroups": { - "shape": "Se", + "shape": "Sl", "locationName": "SecurityGroup" }, "AddressingType": { "locationName": "addressingType" }, "BlockDeviceMappings": { - "shape": "Sp9", + "shape": "Sqk", "locationName": "blockDeviceMapping" }, "EbsOptimized": { @@ -13987,7 +15081,7 @@ "type": "boolean" }, "IamInstanceProfile": { - "shape": "S28", + "shape": "S2c", "locationName": "iamInstanceProfile" }, "ImageId": { @@ -14003,15 +15097,15 @@ "locationName": "keyName" }, "Monitoring": { - "shape": "Sz1", + "shape": "S11c", "locationName": "monitoring" }, "NetworkInterfaces": { - "shape": "Syg", + "shape": "S10r", "locationName": "NetworkInterface" }, "Placement": { - "shape": "Syi", + "shape": "S10t", "locationName": "placement" }, "RamdiskId": { @@ -14046,7 +15140,7 @@ "type": "structure", "members": { "SpotInstanceRequests": { - "shape": "Syy", + "shape": "S119", "locationName": "spotInstanceRequestSet" } } @@ -14220,7 +15314,7 @@ "type": "structure", "members": { "Status": { - "shape": "S3f", + "shape": "S3p", "locationName": "status" } } @@ -14241,7 +15335,7 @@ "locationName": "groupId" }, "IpPermissions": { - "shape": "S3i", + "shape": "S3s", "locationName": "ipPermissions" }, "CidrIp": { @@ -14278,7 +15372,7 @@ "GroupId": {}, "GroupName": {}, "IpPermissions": { - "shape": "S3i" + "shape": "S3s" }, "IpProtocol": {}, "SourceSecurityGroupName": {}, @@ -14302,7 +15396,7 @@ ], "members": { "BlockDeviceMappings": { - "shape": "S80", + "shape": "S8a", "locationName": "BlockDeviceMapping" }, "ImageId": {}, @@ -14311,7 +15405,7 @@ "type": "integer" }, "Ipv6Addresses": { - "shape": "Sa0", + "shape": "Saa", "locationName": "Ipv6Address" }, "KernelId": {}, @@ -14323,18 +15417,18 @@ "type": "integer" }, "Monitoring": { - "shape": "Sz1" + "shape": "S11c" }, "Placement": { - "shape": "S7a" + "shape": "S7k" }, "RamdiskId": {}, "SecurityGroupIds": { - "shape": "S8v", + "shape": "S95", "locationName": "SecurityGroupId" }, "SecurityGroups": { - "shape": "S99", + "shape": "S9j", "locationName": "SecurityGroup" }, "SubnetId": {}, @@ -14358,14 +15452,14 @@ "type": "boolean" }, "IamInstanceProfile": { - "shape": "S28", + "shape": "S2c", "locationName": "iamInstanceProfile" }, "InstanceInitiatedShutdownBehavior": { "locationName": "instanceInitiatedShutdownBehavior" }, "NetworkInterfaces": { - "shape": "Syg", + "shape": "S10r", "locationName": "networkInterface" }, "PrivateIpAddress": { @@ -14374,7 +15468,7 @@ "ElasticGpuSpecification": { "type": "list", "member": { - "shape": "S96", + "shape": "S9g", "locationName": "item" } }, @@ -14393,7 +15487,7 @@ } }, "TagSpecifications": { - "shape": "S1c", + "shape": "S1g", "locationName": "TagSpecification" }, "LaunchTemplate": { @@ -14425,7 +15519,7 @@ } }, "CreditSpecification": { - "shape": "S9f" + "shape": "S9p" }, "CpuOptions": { "type": "structure", @@ -14439,7 +15533,7 @@ } }, "CapacityReservationSpecification": { - "shape": "S17s" + "shape": "S1aj" }, "HibernationOptions": { "type": "structure", @@ -14473,7 +15567,7 @@ } }, "output": { - "shape": "St2" + "shape": "Suj" } }, "RunScheduledInstances": { @@ -14571,7 +15665,7 @@ "type": "integer" }, "Groups": { - "shape": "S1cc", + "shape": "S1fb", "locationName": "Group" }, "Ipv6AddressCount": { @@ -14620,25 +15714,133 @@ }, "RamdiskId": {}, "SecurityGroupIds": { - "shape": "S1cc", + "shape": "S1fb", "locationName": "SecurityGroupId" }, "SubnetId": {}, "UserData": {} } }, - "ScheduledInstanceId": {} + "ScheduledInstanceId": {} + } + }, + "output": { + "type": "structure", + "members": { + "InstanceIdSet": { + "locationName": "instanceIdSet", + "type": "list", + "member": { + "locationName": "item" + } + } + } + } + }, + "SearchLocalGatewayRoutes": { + "input": { + "type": "structure", + "required": [ + "LocalGatewayRouteTableId", + "Filters" + ], + "members": { + "LocalGatewayRouteTableId": {}, + "Filters": { + "shape": "Skd", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } + } + }, + "output": { + "type": "structure", + "members": { + "Routes": { + "locationName": "routeSet", + "type": "list", + "member": { + "shape": "Sav", + "locationName": "item" + } + }, + "NextToken": { + "locationName": "nextToken" + } + } + } + }, + "SearchTransitGatewayMulticastGroups": { + "input": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": {}, + "Filters": { + "shape": "Skd", + "locationName": "Filter" + }, + "MaxResults": { + "type": "integer" + }, + "NextToken": {}, + "DryRun": { + "type": "boolean" + } } }, "output": { "type": "structure", "members": { - "InstanceIdSet": { - "locationName": "instanceIdSet", + "MulticastGroups": { + "locationName": "multicastGroups", "type": "list", "member": { - "locationName": "item" + "locationName": "item", + "type": "structure", + "members": { + "GroupIpAddress": { + "locationName": "groupIpAddress" + }, + "TransitGatewayAttachmentId": { + "locationName": "transitGatewayAttachmentId" + }, + "SubnetId": { + "locationName": "subnetId" + }, + "ResourceId": { + "locationName": "resourceId" + }, + "ResourceType": { + "locationName": "resourceType" + }, + "NetworkInterfaceId": { + "locationName": "networkInterfaceId" + }, + "GroupMember": { + "locationName": "groupMember", + "type": "boolean" + }, + "GroupSource": { + "locationName": "groupSource", + "type": "boolean" + }, + "MemberType": { + "locationName": "memberType" + }, + "SourceType": { + "locationName": "sourceType" + } + } } + }, + "NextToken": { + "locationName": "nextToken" } } } @@ -14653,7 +15855,7 @@ "members": { "TransitGatewayRouteTableId": {}, "Filters": { - "shape": "Sj9", + "shape": "Skd", "locationName": "Filter" }, "MaxResults": { @@ -14671,7 +15873,7 @@ "locationName": "routeSet", "type": "list", "member": { - "shape": "Sdr", + "shape": "Seh", "locationName": "item" } }, @@ -14704,7 +15906,7 @@ ], "members": { "InstanceIds": { - "shape": "Sk8", + "shape": "Sld", "locationName": "InstanceId" }, "AdditionalInfo": { @@ -14720,7 +15922,7 @@ "type": "structure", "members": { "StartingInstances": { - "shape": "S1cs", + "shape": "S1g0", "locationName": "instancesSet" } } @@ -14734,7 +15936,7 @@ ], "members": { "InstanceIds": { - "shape": "Sk8", + "shape": "Sld", "locationName": "InstanceId" }, "Hibernate": { @@ -14754,7 +15956,7 @@ "type": "structure", "members": { "StoppingInstances": { - "shape": "S1cs", + "shape": "S1g0", "locationName": "instancesSet" } } @@ -14795,11 +15997,11 @@ "locationName": "connectionId" }, "PreviousStatus": { - "shape": "Skn", + "shape": "Sls", "locationName": "previousStatus" }, "CurrentStatus": { - "shape": "Skn", + "shape": "Sls", "locationName": "currentStatus" } } @@ -14816,7 +16018,7 @@ ], "members": { "InstanceIds": { - "shape": "Sk8", + "shape": "Sld", "locationName": "InstanceId" }, "DryRun": { @@ -14829,7 +16031,7 @@ "type": "structure", "members": { "TerminatingInstances": { - "shape": "S1cs", + "shape": "S1g0", "locationName": "instancesSet" } } @@ -14844,7 +16046,7 @@ ], "members": { "Ipv6Addresses": { - "shape": "S1o", + "shape": "S1s", "locationName": "ipv6Addresses" }, "NetworkInterfaceId": { @@ -14859,7 +16061,7 @@ "locationName": "networkInterfaceId" }, "UnassignedIpv6Addresses": { - "shape": "S1o", + "shape": "S1s", "locationName": "unassignedIpv6Addresses" } } @@ -14877,7 +16079,7 @@ "locationName": "networkInterfaceId" }, "PrivateIpAddresses": { - "shape": "S1s", + "shape": "S1w", "locationName": "privateIpAddress" } } @@ -14891,7 +16093,7 @@ ], "members": { "InstanceIds": { - "shape": "Sk8", + "shape": "Sld", "locationName": "InstanceId" }, "DryRun": { @@ -14904,7 +16106,7 @@ "type": "structure", "members": { "InstanceMonitorings": { - "shape": "S19w", + "shape": "S1cn", "locationName": "instancesSet" } } @@ -14923,7 +16125,7 @@ "GroupId": {}, "GroupName": {}, "IpPermissions": { - "shape": "S3i" + "shape": "S3s" } } }, @@ -14950,7 +16152,7 @@ "GroupId": {}, "GroupName": {}, "IpPermissions": { - "shape": "S3i" + "shape": "S3s" } } }, @@ -14981,7 +16183,7 @@ "type": "structure", "members": { "ByoipCidr": { - "shape": "S15", + "shape": "S19", "locationName": "byoipCidr" } } @@ -15011,7 +16213,75 @@ } } }, + "Sb": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "locationName": "transitGatewayAttachmentId" + }, + "RequesterTgwInfo": { + "shape": "Sc", + "locationName": "requesterTgwInfo" + }, + "AccepterTgwInfo": { + "shape": "Sc", + "locationName": "accepterTgwInfo" + }, + "Status": { + "locationName": "status", + "type": "structure", + "members": { + "Code": { + "locationName": "code" + }, + "Message": { + "locationName": "message" + } + } + }, + "State": { + "locationName": "state" + }, + "CreationTime": { + "locationName": "creationTime", + "type": "timestamp" + }, + "Tags": { + "shape": "Sg", + "locationName": "tagSet" + } + } + }, "Sc": { + "type": "structure", + "members": { + "TransitGatewayId": { + "locationName": "transitGatewayId" + }, + "OwnerId": { + "locationName": "ownerId" + }, + "Region": { + "locationName": "region" + } + } + }, + "Sg": { + "type": "list", + "member": { + "locationName": "item", + "type": "structure", + "members": { + "Key": { + "locationName": "key" + }, + "Value": { + "locationName": "value" + } + } + } + }, + "Sk": { "type": "structure", "members": { "TransitGatewayAttachmentId": { @@ -15030,7 +16300,7 @@ "locationName": "state" }, "SubnetIds": { - "shape": "Se", + "shape": "Sl", "locationName": "subnetIds" }, "CreationTime": { @@ -15050,40 +16320,25 @@ } }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "Se": { + "Sl": { "type": "list", "member": { "locationName": "item" } }, - "Sj": { - "type": "list", - "member": { - "locationName": "item", - "type": "structure", - "members": { - "Key": { - "locationName": "key" - }, - "Value": { - "locationName": "value" - } - } - } - }, - "So": { + "Ss": { "type": "list", "member": { - "shape": "Sp", + "shape": "St", "locationName": "item" } }, - "Sp": { + "St": { "type": "structure", "members": { "Error": { @@ -15103,11 +16358,11 @@ } } }, - "Su": { + "Sy": { "type": "structure", "members": { "AccepterVpcInfo": { - "shape": "Sv", + "shape": "Sz", "locationName": "accepterVpcInfo" }, "ExpirationTime": { @@ -15115,7 +16370,7 @@ "type": "timestamp" }, "RequesterVpcInfo": { - "shape": "Sv", + "shape": "Sz", "locationName": "requesterVpcInfo" }, "Status": { @@ -15131,7 +16386,7 @@ } }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "VpcPeeringConnectionId": { @@ -15139,7 +16394,7 @@ } } }, - "Sv": { + "Sz": { "type": "structure", "members": { "CidrBlock": { @@ -15200,7 +16455,7 @@ } } }, - "S15": { + "S19": { "type": "structure", "members": { "Cidr": { @@ -15217,7 +16472,7 @@ } } }, - "S1c": { + "S1g": { "type": "list", "member": { "locationName": "item", @@ -15227,37 +16482,37 @@ "locationName": "resourceType" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "Tag" } } } }, - "S1h": { + "S1l": { "type": "list", "member": { "locationName": "item" } }, - "S1l": { + "S1p": { "type": "list", "member": { "locationName": "item" } }, - "S1o": { + "S1s": { "type": "list", "member": { "locationName": "item" } }, - "S1s": { + "S1w": { "type": "list", "member": { "locationName": "PrivateIpAddress" } }, - "S23": { + "S27": { "type": "structure", "members": { "Code": { @@ -15268,7 +16523,7 @@ } } }, - "S28": { + "S2c": { "type": "structure", "members": { "Arn": { @@ -15279,7 +16534,7 @@ } } }, - "S2a": { + "S2e": { "type": "structure", "members": { "AssociationId": { @@ -15289,7 +16544,7 @@ "locationName": "instanceId" }, "IamInstanceProfile": { - "shape": "S2b", + "shape": "S2f", "locationName": "iamInstanceProfile" }, "State": { @@ -15301,7 +16556,7 @@ } } }, - "S2b": { + "S2f": { "type": "structure", "members": { "Arn": { @@ -15312,7 +16567,18 @@ } } }, - "S2i": { + "S2j": { + "type": "structure", + "members": { + "State": { + "locationName": "state" + }, + "StatusMessage": { + "locationName": "statusMessage" + } + } + }, + "S2n": { "type": "structure", "members": { "AssociationId": { @@ -15335,7 +16601,43 @@ } } }, - "S2o": { + "S2s": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "locationName": "transitGatewayMulticastDomainId" + }, + "TransitGatewayAttachmentId": { + "locationName": "transitGatewayAttachmentId" + }, + "ResourceId": { + "locationName": "resourceId" + }, + "ResourceType": { + "locationName": "resourceType" + }, + "Subnets": { + "locationName": "subnets", + "type": "list", + "member": { + "shape": "S2v", + "locationName": "item" + } + } + } + }, + "S2v": { + "type": "structure", + "members": { + "SubnetId": { + "locationName": "subnetId" + }, + "State": { + "locationName": "state" + } + } + }, + "S2z": { "type": "structure", "members": { "TransitGatewayRouteTableId": { @@ -15355,7 +16657,7 @@ } } }, - "S2t": { + "S33": { "type": "structure", "members": { "AssociationId": { @@ -15365,12 +16667,15 @@ "locationName": "ipv6CidrBlock" }, "Ipv6CidrBlockState": { - "shape": "S2u", + "shape": "S34", "locationName": "ipv6CidrBlockState" + }, + "NetworkBorderGroup": { + "locationName": "networkBorderGroup" } } }, - "S2u": { + "S34": { "type": "structure", "members": { "State": { @@ -15381,7 +16686,7 @@ } } }, - "S2w": { + "S36": { "type": "structure", "members": { "AssociationId": { @@ -15391,18 +16696,18 @@ "locationName": "cidrBlock" }, "CidrBlockState": { - "shape": "S2u", + "shape": "S34", "locationName": "cidrBlockState" } } }, - "S2y": { + "S38": { "type": "list", "member": { "locationName": "groupId" } }, - "S36": { + "S3g": { "type": "structure", "members": { "AttachTime": { @@ -15427,7 +16732,7 @@ } } }, - "S3b": { + "S3l": { "type": "structure", "members": { "State": { @@ -15438,7 +16743,7 @@ } } }, - "S3f": { + "S3p": { "type": "structure", "members": { "Code": { @@ -15449,7 +16754,7 @@ } } }, - "S3i": { + "S3s": { "type": "list", "member": { "locationName": "item", @@ -15518,14 +16823,14 @@ "locationName": "groups", "type": "list", "member": { - "shape": "S3r", + "shape": "S41", "locationName": "item" } } } } }, - "S3r": { + "S41": { "type": "structure", "members": { "Description": { @@ -15551,7 +16856,7 @@ } } }, - "S3u": { + "S44": { "type": "structure", "members": { "S3": { @@ -15575,7 +16880,7 @@ } } }, - "S3y": { + "S48": { "type": "structure", "members": { "BundleId": { @@ -15607,7 +16912,7 @@ "locationName": "state" }, "Storage": { - "shape": "S3u", + "shape": "S44", "locationName": "storage" }, "UpdateTime": { @@ -15616,7 +16921,7 @@ } } }, - "S4g": { + "S4q": { "type": "list", "member": { "locationName": "item", @@ -15684,7 +16989,7 @@ "locationName": "statusMessage" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "UpdateDate": { @@ -15694,13 +16999,13 @@ } } }, - "S51": { + "S5b": { "type": "list", "member": { "locationName": "SpotInstanceRequestId" } }, - "S5k": { + "S5u": { "type": "structure", "members": { "CapacityReservationId": { @@ -15761,12 +17066,12 @@ "type": "timestamp" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "S5s": { + "S62": { "type": "structure", "members": { "Enabled": { @@ -15776,7 +17081,7 @@ "CloudwatchLogStream": {} } }, - "S5v": { + "S65": { "type": "structure", "members": { "Code": { @@ -15787,7 +17092,7 @@ } } }, - "S5z": { + "S69": { "type": "structure", "members": { "Code": { @@ -15798,7 +17103,7 @@ } } }, - "S64": { + "S6e": { "type": "structure", "members": { "BgpAsn": { @@ -15823,12 +17128,12 @@ "locationName": "deviceName" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "S67": { + "S6h": { "type": "structure", "members": { "AvailabilityZone": { @@ -15872,20 +17177,23 @@ "locationName": "ipv6CidrBlockAssociationSet", "type": "list", "member": { - "shape": "S2i", + "shape": "S2n", "locationName": "item" } }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "SubnetArn": { "locationName": "subnetArn" + }, + "OutpostArn": { + "locationName": "outpostArn" } } }, - "S6c": { + "S6m": { "type": "structure", "members": { "CidrBlock": { @@ -15910,7 +17218,7 @@ "locationName": "ipv6CidrBlockAssociationSet", "type": "list", "member": { - "shape": "S2t", + "shape": "S33", "locationName": "item" } }, @@ -15918,7 +17226,7 @@ "locationName": "cidrBlockAssociationSet", "type": "list", "member": { - "shape": "S2w", + "shape": "S36", "locationName": "item" } }, @@ -15927,12 +17235,12 @@ "type": "boolean" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "S6l": { + "S6v": { "type": "structure", "members": { "DhcpConfigurations": { @@ -15949,7 +17257,7 @@ "locationName": "valueSet", "type": "list", "member": { - "shape": "S6p", + "shape": "S6z", "locationName": "item" } } @@ -15963,12 +17271,12 @@ "locationName": "ownerId" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "S6p": { + "S6z": { "type": "structure", "members": { "Value": { @@ -15976,11 +17284,11 @@ } } }, - "S6s": { + "S72": { "type": "structure", "members": { "Attachments": { - "shape": "S6t", + "shape": "S73", "locationName": "attachmentSet" }, "EgressOnlyInternetGatewayId": { @@ -15988,7 +17296,7 @@ } } }, - "S6t": { + "S73": { "type": "list", "member": { "locationName": "item", @@ -16003,7 +17311,7 @@ } } }, - "S7a": { + "S7k": { "type": "structure", "members": { "AvailabilityZone": { @@ -16033,7 +17341,7 @@ } } }, - "S7b": { + "S7l": { "type": "structure", "required": [ "TotalTargetCapacity" @@ -16051,20 +17359,20 @@ "DefaultTargetCapacityType": {} } }, - "S7i": { + "S7s": { "type": "structure", "members": { "LaunchTemplateSpecification": { - "shape": "S7j", + "shape": "S7t", "locationName": "launchTemplateSpecification" }, "Overrides": { - "shape": "S7k", + "shape": "S7u", "locationName": "overrides" } } }, - "S7j": { + "S7t": { "type": "structure", "members": { "LaunchTemplateId": { @@ -16078,7 +17386,7 @@ } } }, - "S7k": { + "S7u": { "type": "structure", "members": { "InstanceType": { @@ -16112,27 +17420,27 @@ } } }, - "S7p": { + "S7z": { "type": "list", "member": { "locationName": "item" } }, - "S7x": { + "S87": { "type": "structure", "members": { "Bucket": {}, "Key": {} } }, - "S80": { + "S8a": { "type": "list", "member": { - "shape": "S81", + "shape": "S8b", "locationName": "BlockDeviceMapping" } }, - "S81": { + "S8b": { "type": "structure", "members": { "DeviceName": { @@ -16175,7 +17483,7 @@ } } }, - "S8b": { + "S8l": { "type": "structure", "members": { "Description": { @@ -16222,11 +17530,11 @@ } } }, - "S8h": { + "S8r": { "type": "structure", "members": { "Attachments": { - "shape": "S6t", + "shape": "S73", "locationName": "attachmentSet" }, "InternetGatewayId": { @@ -16236,12 +17544,12 @@ "locationName": "ownerId" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "S8o": { + "S8y": { "type": "structure", "members": { "KernelId": {}, @@ -16306,7 +17614,7 @@ "type": "integer" }, "Groups": { - "shape": "S8v", + "shape": "S95", "locationName": "SecurityGroupId" }, "InterfaceType": {}, @@ -16326,7 +17634,7 @@ "NetworkInterfaceId": {}, "PrivateIpAddress": {}, "PrivateIpAddresses": { - "shape": "S8y" + "shape": "S98" }, "SecondaryPrivateIpAddressCount": { "type": "integer" @@ -16373,7 +17681,7 @@ "members": { "ResourceType": {}, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "Tag" } } @@ -16383,7 +17691,7 @@ "locationName": "ElasticGpuSpecification", "type": "list", "member": { - "shape": "S96", + "shape": "S9g", "locationName": "ElasticGpuSpecification" } }, @@ -16402,11 +17710,11 @@ } }, "SecurityGroupIds": { - "shape": "S8v", + "shape": "S95", "locationName": "SecurityGroupId" }, "SecurityGroups": { - "shape": "S99", + "shape": "S9j", "locationName": "SecurityGroup" }, "InstanceMarketOptions": { @@ -16430,7 +17738,7 @@ } }, "CreditSpecification": { - "shape": "S9f" + "shape": "S9p" }, "CpuOptions": { "type": "structure", @@ -16448,7 +17756,7 @@ "members": { "CapacityReservationPreference": {}, "CapacityReservationTarget": { - "shape": "S9j" + "shape": "S9t" } } }, @@ -16473,13 +17781,13 @@ } } }, - "S8v": { + "S95": { "type": "list", "member": { "locationName": "SecurityGroupId" } }, - "S8y": { + "S98": { "type": "list", "member": { "locationName": "item", @@ -16495,7 +17803,7 @@ } } }, - "S96": { + "S9g": { "type": "structure", "required": [ "Type" @@ -16504,13 +17812,13 @@ "Type": {} } }, - "S99": { + "S9j": { "type": "list", "member": { "locationName": "SecurityGroup" } }, - "S9f": { + "S9p": { "type": "structure", "required": [ "CpuCredits" @@ -16519,13 +17827,13 @@ "CpuCredits": {} } }, - "S9j": { + "S9t": { "type": "structure", "members": { "CapacityReservationId": {} } }, - "S9o": { + "S9y": { "type": "structure", "members": { "LaunchTemplateId": { @@ -16550,12 +17858,12 @@ "type": "long" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "S9s": { + "Sa2": { "type": "structure", "members": { "LaunchTemplateId": { @@ -16583,12 +17891,12 @@ "type": "boolean" }, "LaunchTemplateData": { - "shape": "S9t", + "shape": "Sa3", "locationName": "launchTemplateData" } } }, - "S9t": { + "Sa3": { "type": "structure", "members": { "KernelId": { @@ -16683,7 +17991,7 @@ "type": "integer" }, "Groups": { - "shape": "S2y", + "shape": "S38", "locationName": "groupSet" }, "InterfaceType": { @@ -16694,7 +18002,7 @@ "type": "integer" }, "Ipv6Addresses": { - "shape": "Sa0", + "shape": "Saa", "locationName": "ipv6AddressesSet" }, "NetworkInterfaceId": { @@ -16704,7 +18012,7 @@ "locationName": "privateIpAddress" }, "PrivateIpAddresses": { - "shape": "S8y", + "shape": "S98", "locationName": "privateIpAddressesSet" }, "SecondaryPrivateIpAddressCount": { @@ -16787,7 +18095,7 @@ "locationName": "resourceType" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } @@ -16820,11 +18128,11 @@ } }, "SecurityGroupIds": { - "shape": "Se", + "shape": "Sl", "locationName": "securityGroupIdSet" }, "SecurityGroups": { - "shape": "Se", + "shape": "Sl", "locationName": "securityGroupSet" }, "InstanceMarketOptions": { @@ -16890,7 +18198,7 @@ "locationName": "capacityReservationPreference" }, "CapacityReservationTarget": { - "shape": "Saf", + "shape": "Sap", "locationName": "capacityReservationTarget" } } @@ -16920,7 +18228,7 @@ } } }, - "Sa0": { + "Saa": { "type": "list", "member": { "locationName": "item", @@ -16932,7 +18240,7 @@ } } }, - "Saf": { + "Sap": { "type": "structure", "members": { "CapacityReservationId": { @@ -16940,7 +18248,47 @@ } } }, - "Sal": { + "Sav": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "locationName": "destinationCidrBlock" + }, + "LocalGatewayVirtualInterfaceGroupId": { + "locationName": "localGatewayVirtualInterfaceGroupId" + }, + "Type": { + "locationName": "type" + }, + "State": { + "locationName": "state" + }, + "LocalGatewayRouteTableId": { + "locationName": "localGatewayRouteTableId" + } + } + }, + "Sb0": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociationId": { + "locationName": "localGatewayRouteTableVpcAssociationId" + }, + "LocalGatewayRouteTableId": { + "locationName": "localGatewayRouteTableId" + }, + "LocalGatewayId": { + "locationName": "localGatewayId" + }, + "VpcId": { + "locationName": "vpcId" + }, + "State": { + "locationName": "state" + } + } + }, + "Sb3": { "type": "structure", "members": { "CreateTime": { @@ -17015,12 +18363,12 @@ "locationName": "vpcId" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "Sas": { + "Sba": { "type": "structure", "members": { "Associations": { @@ -17057,14 +18405,14 @@ "type": "boolean" }, "IcmpTypeCode": { - "shape": "Sax", + "shape": "Sbf", "locationName": "icmpTypeCode" }, "Ipv6CidrBlock": { "locationName": "ipv6CidrBlock" }, "PortRange": { - "shape": "Say", + "shape": "Sbg", "locationName": "portRange" }, "Protocol": { @@ -17088,7 +18436,7 @@ "locationName": "networkAclId" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "VpcId": { @@ -17099,7 +18447,7 @@ } } }, - "Sax": { + "Sbf": { "type": "structure", "members": { "Code": { @@ -17112,7 +18460,7 @@ } } }, - "Say": { + "Sbg": { "type": "structure", "members": { "From": { @@ -17125,15 +18473,15 @@ } } }, - "Sb5": { + "Sbn": { "type": "structure", "members": { "Association": { - "shape": "Sb6", + "shape": "Sbo", "locationName": "association" }, "Attachment": { - "shape": "Sb7", + "shape": "Sbp", "locationName": "attachment" }, "AvailabilityZone": { @@ -17143,7 +18491,7 @@ "locationName": "description" }, "Groups": { - "shape": "Sb8", + "shape": "Sbq", "locationName": "groupSet" }, "InterfaceType": { @@ -17168,6 +18516,9 @@ "NetworkInterfaceId": { "locationName": "networkInterfaceId" }, + "OutpostArn": { + "locationName": "outpostArn" + }, "OwnerId": { "locationName": "ownerId" }, @@ -17185,7 +18536,7 @@ "type": "structure", "members": { "Association": { - "shape": "Sb6", + "shape": "Sbo", "locationName": "association" }, "Primary": { @@ -17219,7 +18570,7 @@ "locationName": "subnetId" }, "TagSet": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "VpcId": { @@ -17227,7 +18578,7 @@ } } }, - "Sb6": { + "Sbo": { "type": "structure", "members": { "AllocationId": { @@ -17247,7 +18598,7 @@ } } }, - "Sb7": { + "Sbp": { "type": "structure", "members": { "AttachTime": { @@ -17276,7 +18627,7 @@ } } }, - "Sb8": { + "Sbq": { "type": "list", "member": { "locationName": "item", @@ -17291,7 +18642,7 @@ } } }, - "Sbj": { + "Sc1": { "type": "structure", "members": { "NetworkInterfacePermissionId": { @@ -17323,7 +18674,7 @@ } } }, - "Sbz": { + "Sci": { "type": "structure", "members": { "Associations": { @@ -17345,6 +18696,13 @@ }, "SubnetId": { "locationName": "subnetId" + }, + "GatewayId": { + "locationName": "gatewayId" + }, + "AssociationState": { + "shape": "S2j", + "locationName": "associationState" } } } @@ -17399,6 +18757,9 @@ "TransitGatewayId": { "locationName": "transitGatewayId" }, + "LocalGatewayId": { + "locationName": "localGatewayId" + }, "NetworkInterfaceId": { "locationName": "networkInterfaceId" }, @@ -17415,7 +18776,7 @@ } }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "VpcId": { @@ -17426,7 +18787,7 @@ } } }, - "Scb": { + "Scu": { "type": "structure", "members": { "DataEncryptionKeyId": { @@ -17472,19 +18833,19 @@ "locationName": "ownerAlias" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "Scm": { + "Sd5": { "type": "structure", "members": { "Bucket": { "locationName": "bucket" }, "Fault": { - "shape": "Scn", + "shape": "Sd6", "locationName": "fault" }, "OwnerId": { @@ -17498,7 +18859,7 @@ } } }, - "Scn": { + "Sd6": { "type": "structure", "members": { "Code": { @@ -17509,45 +18870,45 @@ } } }, - "Scs": { + "Sdb": { "type": "list", "member": {} }, - "Scv": { + "Sde": { "type": "structure", "members": { "TrafficMirrorFilterId": { "locationName": "trafficMirrorFilterId" }, "IngressFilterRules": { - "shape": "Scw", + "shape": "Sdf", "locationName": "ingressFilterRuleSet" }, "EgressFilterRules": { - "shape": "Scw", + "shape": "Sdf", "locationName": "egressFilterRuleSet" }, "NetworkServices": { - "shape": "Sd1", + "shape": "Sdk", "locationName": "networkServiceSet" }, "Description": { "locationName": "description" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "Scw": { + "Sdf": { "type": "list", "member": { - "shape": "Scx", + "shape": "Sdg", "locationName": "item" } }, - "Scx": { + "Sdg": { "type": "structure", "members": { "TrafficMirrorFilterRuleId": { @@ -17571,11 +18932,11 @@ "type": "integer" }, "DestinationPortRange": { - "shape": "Sd0", + "shape": "Sdj", "locationName": "destinationPortRange" }, "SourcePortRange": { - "shape": "Sd0", + "shape": "Sdj", "locationName": "sourcePortRange" }, "DestinationCidrBlock": { @@ -17589,7 +18950,7 @@ } } }, - "Sd0": { + "Sdj": { "type": "structure", "members": { "FromPort": { @@ -17602,13 +18963,13 @@ } } }, - "Sd1": { + "Sdk": { "type": "list", "member": { "locationName": "item" } }, - "Sd5": { + "Sdo": { "type": "structure", "members": { "FromPort": { @@ -17619,7 +18980,7 @@ } } }, - "Sda": { + "Sdt": { "type": "structure", "members": { "TrafficMirrorSessionId": { @@ -17653,12 +19014,12 @@ "locationName": "description" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "Sdd": { + "Sdw": { "type": "structure", "members": { "TrafficMirrorTargetId": { @@ -17680,12 +19041,12 @@ "locationName": "ownerId" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "Sdm": { + "Se6": { "type": "structure", "members": { "TransitGatewayId": { @@ -17735,16 +19096,41 @@ }, "DnsSupport": { "locationName": "dnsSupport" + }, + "MulticastSupport": { + "locationName": "multicastSupport" } } }, "Tags": { - "shape": "Sj", + "shape": "Sg", + "locationName": "tagSet" + } + } + }, + "Seb": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "locationName": "transitGatewayMulticastDomainId" + }, + "TransitGatewayId": { + "locationName": "transitGatewayId" + }, + "State": { + "locationName": "state" + }, + "CreationTime": { + "locationName": "creationTime", + "type": "timestamp" + }, + "Tags": { + "shape": "Sg", "locationName": "tagSet" } } }, - "Sdr": { + "Seh": { "type": "structure", "members": { "DestinationCidrBlock": { @@ -17777,7 +19163,7 @@ } } }, - "Sdy": { + "Seo": { "type": "structure", "members": { "TransitGatewayRouteTableId": { @@ -17802,19 +19188,19 @@ "type": "timestamp" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "Se6": { + "Sew": { "type": "structure", "members": { "Attachments": { "locationName": "attachmentSet", "type": "list", "member": { - "shape": "S36", + "shape": "S3g", "locationName": "item" } }, @@ -17832,6 +19218,9 @@ "KmsKeyId": { "locationName": "kmsKeyId" }, + "OutpostArn": { + "locationName": "outpostArn" + }, "Size": { "locationName": "size", "type": "integer" @@ -17850,7 +19239,7 @@ "type": "integer" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "VolumeType": { @@ -17862,7 +19251,7 @@ } } }, - "See": { + "Sf4": { "type": "structure", "members": { "VpcEndpointId": { @@ -17884,11 +19273,11 @@ "locationName": "policyDocument" }, "RouteTableIds": { - "shape": "Se", + "shape": "Sl", "locationName": "routeTableIdSet" }, "SubnetIds": { - "shape": "Se", + "shape": "Sl", "locationName": "subnetIdSet" }, "Groups": { @@ -17916,11 +19305,11 @@ "type": "boolean" }, "NetworkInterfaceIds": { - "shape": "Se", + "shape": "Sl", "locationName": "networkInterfaceIdSet" }, "DnsEntries": { - "shape": "Sei", + "shape": "Sf8", "locationName": "dnsEntrySet" }, "CreationTimestamp": { @@ -17928,7 +19317,7 @@ "type": "timestamp" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "OwnerId": { @@ -17936,7 +19325,7 @@ } } }, - "Sei": { + "Sf8": { "type": "list", "member": { "locationName": "item", @@ -17951,7 +19340,7 @@ } } }, - "Sen": { + "Sfd": { "type": "structure", "members": { "ConnectionNotificationId": { @@ -17970,7 +19359,7 @@ "locationName": "connectionNotificationArn" }, "ConnectionEvents": { - "shape": "Se", + "shape": "Sl", "locationName": "connectionEvents" }, "ConnectionNotificationState": { @@ -17978,11 +19367,11 @@ } } }, - "Ses": { + "Sfi": { "type": "structure", "members": { "ServiceType": { - "shape": "Set", + "shape": "Sfj", "locationName": "serviceType" }, "ServiceId": { @@ -17995,7 +19384,7 @@ "locationName": "serviceState" }, "AvailabilityZones": { - "shape": "Se", + "shape": "Sl", "locationName": "availabilityZoneSet" }, "AcceptanceRequired": { @@ -18007,23 +19396,23 @@ "type": "boolean" }, "NetworkLoadBalancerArns": { - "shape": "Se", + "shape": "Sl", "locationName": "networkLoadBalancerArnSet" }, "BaseEndpointDnsNames": { - "shape": "Se", + "shape": "Sl", "locationName": "baseEndpointDnsNameSet" }, "PrivateDnsName": { "locationName": "privateDnsName" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "Set": { + "Sfj": { "type": "list", "member": { "locationName": "item", @@ -18035,7 +19424,7 @@ } } }, - "Sf4": { + "Sfu": { "type": "list", "member": { "locationName": "item", @@ -18045,7 +19434,7 @@ } } }, - "Sf6": { + "Sfw": { "type": "list", "member": { "locationName": "item", @@ -18055,7 +19444,7 @@ } } }, - "Sf8": { + "Sfy": { "type": "list", "member": { "locationName": "item", @@ -18065,7 +19454,7 @@ } } }, - "Sfa": { + "Sg0": { "type": "list", "member": { "locationName": "item", @@ -18075,7 +19464,7 @@ } } }, - "Sfc": { + "Sg2": { "type": "list", "member": { "locationName": "item", @@ -18087,7 +19476,7 @@ } } }, - "Sfe": { + "Sg4": { "type": "list", "member": { "locationName": "item", @@ -18099,7 +19488,7 @@ } } }, - "Sfg": { + "Sg6": { "type": "list", "member": { "locationName": "item", @@ -18109,7 +19498,7 @@ } } }, - "Sfj": { + "Sg9": { "type": "structure", "members": { "CustomerGatewayConfiguration": { @@ -18140,6 +19529,10 @@ "locationName": "options", "type": "structure", "members": { + "EnableAcceleration": { + "locationName": "enableAcceleration", + "type": "boolean" + }, "StaticRoutesOnly": { "locationName": "staticRoutesOnly", "type": "boolean" @@ -18302,7 +19695,7 @@ } }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "VgwTelemetry": { @@ -18337,7 +19730,7 @@ } } }, - "Sgc": { + "Sh2": { "type": "structure", "members": { "AvailabilityZone": { @@ -18353,7 +19746,7 @@ "locationName": "attachments", "type": "list", "member": { - "shape": "S3b", + "shape": "S3l", "locationName": "item" } }, @@ -18365,22 +19758,22 @@ "type": "long" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "Sgn": { + "Shd": { "type": "list", "member": {} }, - "Sh6": { + "Shw": { "type": "list", "member": { "locationName": "item" } }, - "Sj9": { + "Skd": { "type": "list", "member": { "locationName": "Filter", @@ -18388,13 +19781,13 @@ "members": { "Name": {}, "Values": { - "shape": "Se", + "shape": "Sl", "locationName": "Value" } } } }, - "Sji": { + "Skm": { "type": "list", "member": { "locationName": "item", @@ -18414,13 +19807,13 @@ } } }, - "Sk8": { + "Sld": { "type": "list", "member": { "locationName": "InstanceId" } }, - "Skn": { + "Sls": { "type": "structure", "members": { "Code": { @@ -18431,7 +19824,7 @@ } } }, - "Slh": { + "Sms": { "type": "structure", "members": { "ConversionTaskId": { @@ -18471,7 +19864,7 @@ "locationName": "description" }, "Image": { - "shape": "Sll", + "shape": "Smw", "locationName": "image" }, "Status": { @@ -18481,7 +19874,7 @@ "locationName": "statusMessage" }, "Volume": { - "shape": "Slm", + "shape": "Smx", "locationName": "volume" } } @@ -18504,11 +19897,11 @@ "locationName": "description" }, "Image": { - "shape": "Sll", + "shape": "Smw", "locationName": "image" }, "Volume": { - "shape": "Slm", + "shape": "Smx", "locationName": "volume" } } @@ -18520,12 +19913,12 @@ "locationName": "statusMessage" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" } } }, - "Sll": { + "Smw": { "type": "structure", "members": { "Checksum": { @@ -18543,7 +19936,7 @@ } } }, - "Slm": { + "Smx": { "type": "structure", "members": { "Id": { @@ -18555,7 +19948,7 @@ } } }, - "Smi": { + "Snt": { "type": "structure", "members": { "S3Bucket": { @@ -18566,7 +19959,7 @@ } } }, - "Smy": { + "So9": { "type": "structure", "members": { "EventDescription": { @@ -18580,7 +19973,7 @@ } } }, - "Sn1": { + "Soc": { "type": "list", "member": { "locationName": "item", @@ -18601,7 +19994,7 @@ } } }, - "Snq": { + "Sp1": { "type": "structure", "members": { "FpgaImageId": { @@ -18630,12 +20023,12 @@ } }, "ProductCodes": { - "shape": "Snu", + "shape": "Sp5", "locationName": "productCodes" } } }, - "Snu": { + "Sp5": { "type": "list", "member": { "locationName": "item", @@ -18650,32 +20043,32 @@ } } }, - "Snz": { + "Spa": { "type": "list", "member": { "locationName": "Owner" } }, - "Soi": { + "Spt": { "type": "list", "member": { "locationName": "item" } }, - "Sol": { + "Spw": { "type": "list", "member": { "locationName": "item" } }, - "Sp9": { + "Sqk": { "type": "list", "member": { - "shape": "S81", + "shape": "S8b", "locationName": "item" } }, - "Spa": { + "Sql": { "type": "list", "member": { "locationName": "item", @@ -18690,7 +20083,7 @@ } } }, - "Spn": { + "Sqy": { "type": "structure", "members": { "Code": { @@ -18701,13 +20094,13 @@ } } }, - "Spq": { + "Sr1": { "type": "list", "member": { "locationName": "ImportTaskId" } }, - "Spu": { + "Sr5": { "type": "list", "member": { "locationName": "item", @@ -18742,13 +20135,13 @@ "locationName": "url" }, "UserBucket": { - "shape": "Spw", + "shape": "Sr7", "locationName": "userBucket" } } } }, - "Spw": { + "Sr7": { "type": "structure", "members": { "S3Bucket": { @@ -18759,7 +20152,7 @@ } } }, - "Spx": { + "Sr8": { "type": "list", "member": { "locationName": "item", @@ -18771,7 +20164,7 @@ } } }, - "Sq3": { + "Sre": { "type": "structure", "members": { "Description": { @@ -18807,12 +20200,12 @@ "locationName": "url" }, "UserBucket": { - "shape": "Spw", + "shape": "Sr7", "locationName": "userBucket" } } }, - "Sq7": { + "Sri": { "type": "list", "member": { "locationName": "item", @@ -18844,7 +20237,7 @@ } } }, - "Sqa": { + "Srl": { "type": "structure", "members": { "Value": { @@ -18853,7 +20246,7 @@ } } }, - "Sql": { + "Srw": { "type": "structure", "members": { "InstanceEventId": { @@ -18879,7 +20272,7 @@ } } }, - "Sqo": { + "Srz": { "type": "structure", "members": { "Code": { @@ -18891,7 +20284,7 @@ } } }, - "Sqq": { + "Ss1": { "type": "structure", "members": { "Details": { @@ -18919,11 +20312,11 @@ } } }, - "St2": { + "Suj": { "type": "structure", "members": { "Groups": { - "shape": "Sb8", + "shape": "Sbq", "locationName": "groupSet" }, "Instances": { @@ -18957,11 +20350,11 @@ "type": "timestamp" }, "Monitoring": { - "shape": "St5", + "shape": "Sum", "locationName": "monitoring" }, "Placement": { - "shape": "S7a", + "shape": "S7k", "locationName": "placement" }, "Platform": { @@ -18974,7 +20367,7 @@ "locationName": "privateIpAddress" }, "ProductCodes": { - "shape": "Snu", + "shape": "Sp5", "locationName": "productCodes" }, "PublicDnsName": { @@ -18987,7 +20380,7 @@ "locationName": "ramdiskId" }, "State": { - "shape": "Sqo", + "shape": "Srz", "locationName": "instanceState" }, "StateTransitionReason": { @@ -19003,7 +20396,7 @@ "locationName": "architecture" }, "BlockDeviceMappings": { - "shape": "Sq7", + "shape": "Sri", "locationName": "blockDeviceMapping" }, "ClientToken": { @@ -19021,7 +20414,7 @@ "locationName": "hypervisor" }, "IamInstanceProfile": { - "shape": "S2b", + "shape": "S2f", "locationName": "iamInstanceProfile" }, "InstanceLifecycle": { @@ -19080,7 +20473,7 @@ "type": "structure", "members": { "Association": { - "shape": "Ste", + "shape": "Suv", "locationName": "association" }, "Attachment": { @@ -19111,11 +20504,11 @@ "locationName": "description" }, "Groups": { - "shape": "Sb8", + "shape": "Sbq", "locationName": "groupSet" }, "Ipv6Addresses": { - "shape": "Sa0", + "shape": "Saa", "locationName": "ipv6AddressesSet" }, "MacAddress": { @@ -19141,7 +20534,7 @@ "type": "structure", "members": { "Association": { - "shape": "Ste", + "shape": "Suv", "locationName": "association" }, "Primary": { @@ -19176,6 +20569,9 @@ } } }, + "OutpostArn": { + "locationName": "outpostArn" + }, "RootDeviceName": { "locationName": "rootDeviceName" }, @@ -19183,7 +20579,7 @@ "locationName": "rootDeviceType" }, "SecurityGroups": { - "shape": "Sb8", + "shape": "Sbq", "locationName": "groupSet" }, "SourceDestCheck": { @@ -19197,11 +20593,11 @@ "locationName": "sriovNetSupport" }, "StateReason": { - "shape": "Spn", + "shape": "Sqy", "locationName": "stateReason" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "VirtualizationType": { @@ -19232,7 +20628,7 @@ "locationName": "capacityReservationPreference" }, "CapacityReservationTarget": { - "shape": "Saf", + "shape": "Sap", "locationName": "capacityReservationTarget" } } @@ -19261,7 +20657,7 @@ } }, "MetadataOptions": { - "shape": "Stn", + "shape": "Sv4", "locationName": "metadataOptions" } } @@ -19278,7 +20674,7 @@ } } }, - "St5": { + "Sum": { "type": "structure", "members": { "State": { @@ -19286,7 +20682,7 @@ } } }, - "Ste": { + "Suv": { "type": "structure", "members": { "IpOwnerId": { @@ -19300,7 +20696,7 @@ } } }, - "Stn": { + "Sv4": { "type": "structure", "members": { "State": { @@ -19318,13 +20714,19 @@ } } }, - "Svt": { + "Sw9": { + "type": "list", + "member": { + "locationName": "item" + } + }, + "Sy4": { "type": "list", "member": { "locationName": "ReservedInstancesId" } }, - "Sw1": { + "Syc": { "type": "list", "member": { "locationName": "item", @@ -19340,7 +20742,7 @@ } } }, - "Swe": { + "Syp": { "type": "structure", "members": { "AvailabilityZone": { @@ -19361,7 +20763,7 @@ } } }, - "Sx0": { + "Szb": { "type": "structure", "members": { "Frequency": { @@ -19388,7 +20790,7 @@ } } }, - "Sx7": { + "Szi": { "type": "structure", "members": { "AvailabilityZone": { @@ -19423,7 +20825,7 @@ "type": "timestamp" }, "Recurrence": { - "shape": "Sx0", + "shape": "Szb", "locationName": "recurrence" }, "ScheduledInstanceId": { @@ -19447,13 +20849,13 @@ } } }, - "Sxe": { + "Szp": { "type": "list", "member": { "locationName": "GroupName" } }, - "Sxm": { + "Szx": { "type": "list", "member": { "locationName": "item", @@ -19468,13 +20870,13 @@ } } }, - "Sxq": { + "S101": { "type": "list", "member": { "locationName": "SnapshotId" } }, - "Sy9": { + "S10k": { "type": "structure", "required": [ "IamFleetRole", @@ -19512,14 +20914,14 @@ "type": "structure", "members": { "SecurityGroups": { - "shape": "Sb8", + "shape": "Sbq", "locationName": "groupSet" }, "AddressingType": { "locationName": "addressingType" }, "BlockDeviceMappings": { - "shape": "Sp9", + "shape": "Sqk", "locationName": "blockDeviceMapping" }, "EbsOptimized": { @@ -19527,7 +20929,7 @@ "type": "boolean" }, "IamInstanceProfile": { - "shape": "S28", + "shape": "S2c", "locationName": "iamInstanceProfile" }, "ImageId": { @@ -19553,11 +20955,11 @@ } }, "NetworkInterfaces": { - "shape": "Syg", + "shape": "S10r", "locationName": "networkInterfaceSet" }, "Placement": { - "shape": "Syi", + "shape": "S10t", "locationName": "placement" }, "RamdiskId": { @@ -19587,7 +20989,7 @@ "locationName": "resourceType" }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tag" } } @@ -19604,7 +21006,7 @@ "type": "structure", "members": { "LaunchTemplateSpecification": { - "shape": "S7j", + "shape": "S7t", "locationName": "launchTemplateSpecification" }, "Overrides": { @@ -19729,7 +21131,7 @@ } } }, - "Syg": { + "S10r": { "type": "list", "member": { "locationName": "item", @@ -19751,7 +21153,7 @@ "type": "integer" }, "Groups": { - "shape": "S8v", + "shape": "S95", "locationName": "SecurityGroupId" }, "Ipv6AddressCount": { @@ -19759,7 +21161,7 @@ "type": "integer" }, "Ipv6Addresses": { - "shape": "Sa0", + "shape": "Saa", "locationName": "ipv6AddressesSet", "queryName": "Ipv6Addresses" }, @@ -19770,7 +21172,7 @@ "locationName": "privateIpAddress" }, "PrivateIpAddresses": { - "shape": "S8y", + "shape": "S98", "locationName": "privateIpAddressesSet", "queryName": "PrivateIpAddresses" }, @@ -19785,7 +21187,7 @@ } } }, - "Syi": { + "S10t": { "type": "structure", "members": { "AvailabilityZone": { @@ -19799,7 +21201,7 @@ } } }, - "Syy": { + "S119": { "type": "list", "member": { "locationName": "item", @@ -19820,7 +21222,7 @@ "type": "timestamp" }, "Fault": { - "shape": "Scn", + "shape": "Sd6", "locationName": "fault" }, "InstanceId": { @@ -19837,14 +21239,14 @@ "locationName": "userData" }, "SecurityGroups": { - "shape": "Sb8", + "shape": "Sbq", "locationName": "groupSet" }, "AddressingType": { "locationName": "addressingType" }, "BlockDeviceMappings": { - "shape": "Sp9", + "shape": "Sqk", "locationName": "blockDeviceMapping" }, "EbsOptimized": { @@ -19852,7 +21254,7 @@ "type": "boolean" }, "IamInstanceProfile": { - "shape": "S28", + "shape": "S2c", "locationName": "iamInstanceProfile" }, "ImageId": { @@ -19868,11 +21270,11 @@ "locationName": "keyName" }, "NetworkInterfaces": { - "shape": "Syg", + "shape": "S10r", "locationName": "networkInterfaceSet" }, "Placement": { - "shape": "Syi", + "shape": "S10t", "locationName": "placement" }, "RamdiskId": { @@ -19882,7 +21284,7 @@ "locationName": "subnetId" }, "Monitoring": { - "shape": "Sz1", + "shape": "S11c", "locationName": "monitoring" } } @@ -19919,7 +21321,7 @@ } }, "Tags": { - "shape": "Sj", + "shape": "Sg", "locationName": "tagSet" }, "Type": { @@ -19939,7 +21341,7 @@ } } }, - "Sz1": { + "S11c": { "type": "structure", "required": [ "Enabled" @@ -19951,7 +21353,7 @@ } } }, - "Szg": { + "S11r": { "type": "list", "member": { "locationName": "item", @@ -19986,24 +21388,24 @@ "locationName": "groups", "type": "list", "member": { - "shape": "S3r", + "shape": "S41", "locationName": "item" } } } } }, - "S105": { + "S12g": { "type": "list", "member": {} }, - "S10q": { + "S138": { "type": "list", "member": { "locationName": "VolumeId" } }, - "S119": { + "S13r": { "type": "structure", "members": { "VolumeId": { @@ -20051,19 +21453,19 @@ } } }, - "S11f": { + "S13x": { "type": "list", "member": { "locationName": "VpcId" } }, - "S132": { + "S15k": { "type": "list", "member": { "locationName": "AvailabilityZone" } }, - "S13d": { + "S15v": { "type": "structure", "members": { "TransitGatewayAttachmentId": { @@ -20083,7 +21485,7 @@ } } }, - "S156": { + "S17t": { "type": "structure", "members": { "InstanceFamily": { @@ -20094,13 +21496,13 @@ } } }, - "S15c": { + "S17z": { "type": "list", "member": { "locationName": "item" } }, - "S15g": { + "S183": { "type": "list", "member": { "locationName": "item", @@ -20114,7 +21516,7 @@ "type": "integer" }, "HostIdSet": { - "shape": "Soi", + "shape": "Spt", "locationName": "hostIdSet" }, "HostReservationId": { @@ -20135,7 +21537,7 @@ } } }, - "S15o": { + "S18b": { "type": "structure", "members": { "HourlyPrice": { @@ -20149,7 +21551,7 @@ } } }, - "S169": { + "S190": { "type": "structure", "members": { "Comment": {}, @@ -20164,14 +21566,14 @@ } } }, - "S16c": { + "S193": { "type": "structure", "members": { "S3Bucket": {}, "S3Key": {} } }, - "S16j": { + "S19a": { "type": "structure", "required": [ "Bytes", @@ -20191,7 +21593,7 @@ } } }, - "S16k": { + "S19b": { "type": "structure", "required": [ "Size" @@ -20203,25 +21605,25 @@ } } }, - "S178": { + "S19z": { "type": "list", "member": { "locationName": "UserId" } }, - "S179": { + "S1a0": { "type": "list", "member": { "locationName": "UserGroup" } }, - "S17a": { + "S1a1": { "type": "list", "member": { "locationName": "ProductCode" } }, - "S17c": { + "S1a3": { "type": "list", "member": { "locationName": "item", @@ -20232,23 +21634,23 @@ } } }, - "S17h": { + "S1a8": { "type": "list", "member": { - "shape": "Sp", + "shape": "St", "locationName": "item" } }, - "S17s": { + "S1aj": { "type": "structure", "members": { "CapacityReservationPreference": {}, "CapacityReservationTarget": { - "shape": "S9j" + "shape": "S9t" } } }, - "S19h": { + "S1c8": { "type": "structure", "members": { "AllowDnsResolutionFromRemoteVpc": { @@ -20262,7 +21664,7 @@ } } }, - "S19j": { + "S1ca": { "type": "structure", "members": { "AllowDnsResolutionFromRemoteVpc": { @@ -20279,7 +21681,7 @@ } } }, - "S19w": { + "S1cn": { "type": "list", "member": { "locationName": "item", @@ -20289,33 +21691,33 @@ "locationName": "instanceId" }, "Monitoring": { - "shape": "St5", + "shape": "Sum", "locationName": "monitoring" } } } }, - "S1cc": { + "S1fb": { "type": "list", "member": { "locationName": "SecurityGroupId" } }, - "S1cs": { + "S1g0": { "type": "list", "member": { "locationName": "item", "type": "structure", "members": { "CurrentState": { - "shape": "Sqo", + "shape": "Srz", "locationName": "currentState" }, "InstanceId": { "locationName": "instanceId" }, "PreviousState": { - "shape": "Sqo", + "shape": "Srz", "locationName": "previousState" } } diff --git a/apis/ec2-2016-11-15.normal.json b/apis/ec2-2016-11-15.normal.json index 275373ef5a..38e104f797 100644 --- a/apis/ec2-2016-11-15.normal.json +++ b/apis/ec2-2016-11-15.normal.json @@ -26,6 +26,20 @@ }, "documentation": "Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
" }, + "AcceptTransitGatewayPeeringAttachment": { + "name": "AcceptTransitGatewayPeeringAttachment", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AcceptTransitGatewayPeeringAttachmentRequest" + }, + "output": { + "shape": "AcceptTransitGatewayPeeringAttachmentResult" + }, + "documentation": "Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance
state.
Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table from the subnet later. A route table can be associated with multiple subnets.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" + "documentation": "Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" }, "AssociateSubnetCidrBlock": { "name": "AssociateSubnetCidrBlock", @@ -233,6 +247,20 @@ }, "documentation": "Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64.
" }, + "AssociateTransitGatewayMulticastDomain": { + "name": "AssociateTransitGatewayMulticastDomain", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "AssociateTransitGatewayMulticastDomainRequest" + }, + "output": { + "shape": "AssociateTransitGatewayMulticastDomainResult" + }, + "documentation": "Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
" + }, "AssociateTransitGatewayRouteTable": { "name": "AssociateTransitGatewayRouteTable", "http": { @@ -284,7 +312,7 @@ "input": { "shape": "AttachInternetGatewayRequest" }, - "documentation": "Attaches an internet gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
" + "documentation": "Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
" }, "AttachNetworkInterface": { "name": "AttachNetworkInterface", @@ -778,6 +806,34 @@ }, "documentation": "Creates a new version for a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot specify, change, or replace the numbering of launch template versions.
" }, + "CreateLocalGatewayRoute": { + "name": "CreateLocalGatewayRoute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateLocalGatewayRouteRequest" + }, + "output": { + "shape": "CreateLocalGatewayRouteResult" + }, + "documentation": "Creates a static route for the specified local gateway route table.
" + }, + "CreateLocalGatewayRouteTableVpcAssociation": { + "name": "CreateLocalGatewayRouteTableVpcAssociation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateLocalGatewayRouteTableVpcAssociationRequest" + }, + "output": { + "shape": "CreateLocalGatewayRouteTableVpcAssociationResult" + }, + "documentation": "Associates the specified VPC with the specified local gateway route table.
" + }, "CreateNatGateway": { "name": "CreateNatGateway", "http": { @@ -882,7 +938,7 @@ "output": { "shape": "CreateRouteResult" }, - "documentation": "Creates a route in a route table within a VPC.
You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway.
When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3
, and the route table includes the following two IPv4 routes:
192.0.2.0/24
(goes to some target A)
192.0.2.0/28
(goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3
. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" + "documentation": "Creates a route in a route table within a VPC.
You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address 192.0.2.3
, and the route table includes the following two IPv4 routes:
192.0.2.0/24
(goes to some target A)
192.0.2.0/28
(goes to some target B)
Both routes apply to the traffic destined for 192.0.2.3
. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic.
For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" }, "CreateRouteTable": { "name": "CreateRouteTable", @@ -1049,6 +1105,34 @@ }, "documentation": "Creates a transit gateway.
You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the available
state, you can attach your VPCs and VPN connections to the transit gateway.
To attach your VPCs, use CreateTransitGatewayVpcAttachment.
To attach a VPN connection, use CreateCustomerGateway to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to CreateVpnConnection.
When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use CreateTransitGatewayRouteTable to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use EnableTransitGatewayRouteTablePropagation to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use AssociateTransitGatewayRouteTable to associate a resource attachment with a transit gateway route table.
" }, + "CreateTransitGatewayMulticastDomain": { + "name": "CreateTransitGatewayMulticastDomain", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateTransitGatewayMulticastDomainRequest" + }, + "output": { + "shape": "CreateTransitGatewayMulticastDomainResult" + }, + "documentation": "Creates a multicast domain using the specified transit gateway.
The transit gateway must be in the available state before you create a domain. Use DescribeTransitGateways to see the state of transit gateway.
" + }, + "CreateTransitGatewayPeeringAttachment": { + "name": "CreateTransitGatewayPeeringAttachment", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateTransitGatewayPeeringAttachmentRequest" + }, + "output": { + "shape": "CreateTransitGatewayPeeringAttachmentResult" + }, + "documentation": "Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The transit gateways must be in different Regions. The peer transit gateway can be in your account or a different AWS account.
After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.
" + }, "CreateTransitGatewayRoute": { "name": "CreateTransitGatewayRoute", "http": { @@ -1370,6 +1454,34 @@ }, "documentation": "Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.
" }, + "DeleteLocalGatewayRoute": { + "name": "DeleteLocalGatewayRoute", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteLocalGatewayRouteRequest" + }, + "output": { + "shape": "DeleteLocalGatewayRouteResult" + }, + "documentation": "Deletes the specified route from the specified local gateway route table.
" + }, + "DeleteLocalGatewayRouteTableVpcAssociation": { + "name": "DeleteLocalGatewayRouteTableVpcAssociation", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteLocalGatewayRouteTableVpcAssociationRequest" + }, + "output": { + "shape": "DeleteLocalGatewayRouteTableVpcAssociationResult" + }, + "documentation": "Deletes the specified association between a VPC and local gateway route table.
" + }, "DeleteNatGateway": { "name": "DeleteNatGateway", "http": { @@ -1603,6 +1715,34 @@ }, "documentation": "Deletes the specified transit gateway.
" }, + "DeleteTransitGatewayMulticastDomain": { + "name": "DeleteTransitGatewayMulticastDomain", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteTransitGatewayMulticastDomainRequest" + }, + "output": { + "shape": "DeleteTransitGatewayMulticastDomainResult" + }, + "documentation": "Deletes the specified transit gateway multicast domain.
" + }, + "DeleteTransitGatewayPeeringAttachment": { + "name": "DeleteTransitGatewayPeeringAttachment", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteTransitGatewayPeeringAttachmentRequest" + }, + "output": { + "shape": "DeleteTransitGatewayPeeringAttachmentResult" + }, + "documentation": "Deletes a transit gateway peering attachment.
" + }, "DeleteTransitGatewayRoute": { "name": "DeleteTransitGatewayRoute", "http": { @@ -1781,6 +1921,34 @@ }, "documentation": "Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, it doesn't affect any instances that you've already launched from the AMI. You'll continue to incur usage costs for those instances until you terminate them.
When you deregister an Amazon EBS-backed AMI, it doesn't affect the snapshot that was created for the root volume of the instance during the AMI creation process. When you deregister an instance store-backed AMI, it doesn't affect the files that you uploaded to Amazon S3 when you created the AMI.
" }, + "DeregisterTransitGatewayMulticastGroupMembers": { + "name": "DeregisterTransitGatewayMulticastGroupMembers", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeregisterTransitGatewayMulticastGroupMembersRequest" + }, + "output": { + "shape": "DeregisterTransitGatewayMulticastGroupMembersResult" + }, + "documentation": "Deregisters the specified members (network interfaces) from the transit gateway multicast group.
" + }, + "DeregisterTransitGatewayMulticastGroupSources": { + "name": "DeregisterTransitGatewayMulticastGroupSources", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeregisterTransitGatewayMulticastGroupSourcesRequest" + }, + "output": { + "shape": "DeregisterTransitGatewayMulticastGroupSourcesResult" + }, + "documentation": "Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
" + }, "DescribeAccountAttributes": { "name": "DescribeAccountAttributes", "http": { @@ -1835,7 +2003,7 @@ "output": { "shape": "DescribeAvailabilityZonesResult" }, - "documentation": "Describes the Availability Zones that are available to you. The results include zones only for the Region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.
For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.
" + "documentation": "Describes the Availability Zones and Local Zones that are available to you. If there is an event impacting an Availability Zone or Local Zone, you can use this request to view the state and any provided messages for that Availability Zone or Local Zone.
For more information about Availability Zones and Local Zones, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.
" }, "DescribeBundleTasks": { "name": "DescribeBundleTasks", @@ -1963,6 +2131,20 @@ }, "documentation": "Describes the target networks associated with the specified Client VPN endpoint.
" }, + "DescribeCoipPools": { + "name": "DescribeCoipPools", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeCoipPoolsRequest" + }, + "output": { + "shape": "DescribeCoipPoolsResult" + }, + "documentation": "Describes the specified customer-owned address pools or all of your customer-owned address pools.
" + }, "DescribeConversionTasks": { "name": "DescribeConversionTasks", "http": { @@ -2439,6 +2621,90 @@ }, "documentation": "Describes one or more launch templates.
" }, + "DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations": { + "name": "DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest" + }, + "output": { + "shape": "DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult" + }, + "documentation": "Describes the associations between virtual interface groups and local gateway route tables.
" + }, + "DescribeLocalGatewayRouteTableVpcAssociations": { + "name": "DescribeLocalGatewayRouteTableVpcAssociations", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeLocalGatewayRouteTableVpcAssociationsRequest" + }, + "output": { + "shape": "DescribeLocalGatewayRouteTableVpcAssociationsResult" + }, + "documentation": "Describes the specified associations between VPCs and local gateway route tables.
" + }, + "DescribeLocalGatewayRouteTables": { + "name": "DescribeLocalGatewayRouteTables", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeLocalGatewayRouteTablesRequest" + }, + "output": { + "shape": "DescribeLocalGatewayRouteTablesResult" + }, + "documentation": "Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.
" + }, + "DescribeLocalGatewayVirtualInterfaceGroups": { + "name": "DescribeLocalGatewayVirtualInterfaceGroups", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeLocalGatewayVirtualInterfaceGroupsRequest" + }, + "output": { + "shape": "DescribeLocalGatewayVirtualInterfaceGroupsResult" + }, + "documentation": "Describes the specified local gateway virtual interface groups.
" + }, + "DescribeLocalGatewayVirtualInterfaces": { + "name": "DescribeLocalGatewayVirtualInterfaces", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeLocalGatewayVirtualInterfacesRequest" + }, + "output": { + "shape": "DescribeLocalGatewayVirtualInterfacesResult" + }, + "documentation": "Describes the specified local gateway virtual interfaces.
" + }, + "DescribeLocalGateways": { + "name": "DescribeLocalGateways", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeLocalGatewaysRequest" + }, + "output": { + "shape": "DescribeLocalGatewaysResult" + }, + "documentation": "Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.
" + }, "DescribeMovingAddresses": { "name": "DescribeMovingAddresses", "http": { @@ -2929,6 +3195,34 @@ }, "documentation": "Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner.
" }, + "DescribeTransitGatewayMulticastDomains": { + "name": "DescribeTransitGatewayMulticastDomains", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeTransitGatewayMulticastDomainsRequest" + }, + "output": { + "shape": "DescribeTransitGatewayMulticastDomainsResult" + }, + "documentation": "Describes one or more transit gateway multicast domains.
" + }, + "DescribeTransitGatewayPeeringAttachments": { + "name": "DescribeTransitGatewayPeeringAttachments", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeTransitGatewayPeeringAttachmentsRequest" + }, + "output": { + "shape": "DescribeTransitGatewayPeeringAttachmentsResult" + }, + "documentation": "Describes your transit gateway peering attachments.
" + }, "DescribeTransitGatewayRouteTables": { "name": "DescribeTransitGatewayRouteTables", "http": { @@ -3415,6 +3709,20 @@ }, "documentation": "Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it.
" }, + "DisassociateTransitGatewayMulticastDomain": { + "name": "DisassociateTransitGatewayMulticastDomain", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DisassociateTransitGatewayMulticastDomainRequest" + }, + "output": { + "shape": "DisassociateTransitGatewayMulticastDomainResult" + }, + "documentation": "Disassociates the specified subnets from the transit gateway multicast domain.
" + }, "DisassociateTransitGatewayRouteTable": { "name": "DisassociateTransitGatewayRouteTable", "http": { @@ -3605,6 +3913,20 @@ }, "documentation": "Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each AWS account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage.
" }, + "GetCoipPoolUsage": { + "name": "GetCoipPoolUsage", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetCoipPoolUsageRequest" + }, + "output": { + "shape": "GetCoipPoolUsageResult" + }, + "documentation": "Describes the allocations from the specified customer-owned address pool.
" + }, "GetConsoleOutput": { "name": "GetConsoleOutput", "http": { @@ -3745,6 +4067,20 @@ }, "documentation": "Lists the route tables to which the specified resource attachment propagates routes.
" }, + "GetTransitGatewayMulticastDomainAssociations": { + "name": "GetTransitGatewayMulticastDomainAssociations", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetTransitGatewayMulticastDomainAssociationsRequest" + }, + "output": { + "shape": "GetTransitGatewayMulticastDomainAssociationsResult" + }, + "documentation": "Gets information about the associations for the transit gateway multicast domain.
" + }, "GetTransitGatewayRouteTableAssociations": { "name": "GetTransitGatewayRouteTableAssociations", "http": { @@ -4471,6 +4807,48 @@ }, "documentation": "Registers an AMI. When you're creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Creating Your Own AMIs in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don't have to register the AMI yourself.
You can also use RegisterImage
to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using the block device mapping. For more information, see Launching a Linux Instance from a Backup in the Amazon Elastic Compute Cloud User Guide.
You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, do the following:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create a new AMI from the instance using CreateImage to preserve the billing product code association.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
" }, + "RegisterTransitGatewayMulticastGroupMembers": { + "name": "RegisterTransitGatewayMulticastGroupMembers", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RegisterTransitGatewayMulticastGroupMembersRequest" + }, + "output": { + "shape": "RegisterTransitGatewayMulticastGroupMembersResult" + }, + "documentation": "Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways.
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
" + }, + "RegisterTransitGatewayMulticastGroupSources": { + "name": "RegisterTransitGatewayMulticastGroupSources", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RegisterTransitGatewayMulticastGroupSourcesRequest" + }, + "output": { + "shape": "RegisterTransitGatewayMulticastGroupSourcesResult" + }, + "documentation": "Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
" + }, + "RejectTransitGatewayPeeringAttachment": { + "name": "RejectTransitGatewayPeeringAttachment", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "RejectTransitGatewayPeeringAttachmentRequest" + }, + "output": { + "shape": "RejectTransitGatewayPeeringAttachmentResult" + }, + "documentation": "Rejects a transit gateway peering attachment request.
" + }, "RejectTransitGatewayVpcAttachment": { "name": "RejectTransitGatewayVpcAttachment", "http": { @@ -4586,7 +4964,7 @@ "input": { "shape": "ReplaceRouteRequest" }, - "documentation": "Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" + "documentation": "Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway, virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, egress-only internet gateway, or transit gateway.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
" }, "ReplaceRouteTableAssociation": { "name": "ReplaceRouteTableAssociation", @@ -4600,7 +4978,7 @@ "output": { "shape": "ReplaceRouteTableAssociationResult" }, - "documentation": "Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.
" + "documentation": "Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table.
" }, "ReplaceTransitGatewayRoute": { "name": "ReplaceTransitGatewayRoute", @@ -4805,6 +5183,34 @@ }, "documentation": "Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon Elastic Compute Cloud User Guide.
" }, + "SearchLocalGatewayRoutes": { + "name": "SearchLocalGatewayRoutes", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "SearchLocalGatewayRoutesRequest" + }, + "output": { + "shape": "SearchLocalGatewayRoutesResult" + }, + "documentation": "Searches for routes in the specified local gateway route table.
" + }, + "SearchTransitGatewayMulticastGroups": { + "name": "SearchTransitGatewayMulticastGroups", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "SearchTransitGatewayMulticastGroupsRequest" + }, + "output": { + "shape": "SearchTransitGatewayMulticastGroupsResult" + }, + "documentation": "Searches one or more transit gateway multicast groups and returns the group membership information.
" + }, "SearchTransitGatewayRoutes": { "name": "SearchTransitGatewayRoutes", "http": { @@ -5003,6 +5409,32 @@ }, "documentation": "The result of the exchange and whether it was successful
.
The ID of the transit gateway attachment.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
The transit gateway peering attachment.
", + "locationName": "transitGatewayPeeringAttachment" + } + } + }, "AcceptTransitGatewayVpcAttachmentRequest": { "type": "structure", "required": [ @@ -5010,7 +5442,7 @@ ], "members": { "TransitGatewayAttachmentId": { - "shape": "TransitGatewayAttachmentId", + "shape": "String", "documentation": "The ID of the attachment.
" }, "DryRun": { @@ -5235,6 +5667,21 @@ "shape": "String", "documentation": "The ID of an address pool.
", "locationName": "publicIpv4Pool" + }, + "NetworkBorderGroup": { + "shape": "String", + "documentation": "The name of the location from which the IP address is advertised.
", + "locationName": "networkBorderGroup" + }, + "CustomerOwnedIp": { + "shape": "String", + "documentation": "The customer-owned IP address.
", + "locationName": "customerOwnedIp" + }, + "CustomerOwnedIpv4Pool": { + "shape": "String", + "documentation": "The ID of the customer-owned address pool.
", + "locationName": "customerOwnedIpv4Pool" } }, "documentation": "Describes an Elastic IP address.
" @@ -5294,6 +5741,14 @@ "shape": "String", "documentation": "The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the Address
parameter instead.
The location from which the IP address is advertised. Use this parameter to limit the address to this location.
Use DescribeVpcs to view the network border groups.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination
error. For more information, see Error Codes.
The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool.
" + }, "DryRun": { "shape": "Boolean", "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
The ID of an address pool.
", "locationName": "publicIpv4Pool" }, + "NetworkBorderGroup": { + "shape": "String", + "documentation": "The location from which the IP address is advertised.
", + "locationName": "networkBorderGroup" + }, "Domain": { "shape": "DomainType", "documentation": "Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard
) or instances in a VPC (vpc
).
The customer-owned IP address.
", + "locationName": "customerOwnedIp" + }, + "CustomerOwnedIpv4Pool": { + "shape": "String", + "documentation": "The ID of the customer-owned address pool.
", + "locationName": "customerOwnedIpv4Pool" } } }, @@ -5743,8 +6213,7 @@ "AssociateRouteTableRequest": { "type": "structure", "required": [ - "RouteTableId", - "SubnetId" + "RouteTableId" ], "members": { "DryRun": { @@ -5753,14 +6222,18 @@ "locationName": "dryRun" }, "RouteTableId": { - "shape": "RouteTableId", + "shape": "String", "documentation": "The ID of the route table.
", "locationName": "routeTableId" }, "SubnetId": { - "shape": "SubnetId", + "shape": "String", "documentation": "The ID of the subnet.
", "locationName": "subnetId" + }, + "GatewayId": { + "shape": "String", + "documentation": "The ID of the internet gateway or virtual private gateway.
" } } }, @@ -5771,6 +6244,11 @@ "shape": "String", "documentation": "The route table association ID. This ID is required for disassociating the route table.
", "locationName": "associationId" + }, + "AssociationState": { + "shape": "RouteTableAssociationState", + "documentation": "The state of the association.
", + "locationName": "associationState" } } }, @@ -5787,7 +6265,7 @@ "locationName": "ipv6CidrBlock" }, "SubnetId": { - "shape": "SubnetId", + "shape": "String", "documentation": "The ID of your subnet.
", "locationName": "subnetId" } @@ -5808,6 +6286,37 @@ } } }, + "AssociateTransitGatewayMulticastDomainRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
" + }, + "TransitGatewayAttachmentId": { + "shape": "String", + "documentation": "The ID of the transit gateway attachment to associate with the transit gateway multicast domain.
" + }, + "SubnetIds": { + "shape": "ValueStringList", + "documentation": "The IDs of the subnets to associate with the transit gateway multicast domain.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the transit gateway multicast domain associations.
", + "locationName": "associations" + } + } + }, "AssociateTransitGatewayRouteTableRequest": { "type": "structure", "required": [ @@ -5816,11 +6325,11 @@ ], "members": { "TransitGatewayRouteTableId": { - "shape": "TransitGatewayRouteTableId", + "shape": "String", "documentation": "The ID of the transit gateway route table.
" }, "TransitGatewayAttachmentId": { - "shape": "TransitGatewayAttachmentId", + "shape": "String", "documentation": "The ID of the attachment.
" }, "DryRun": { @@ -5858,6 +6367,10 @@ "shape": "VpcId", "documentation": "The ID of the VPC.
", "locationName": "vpcId" + }, + "Ipv6CidrBlockNetworkBorderGroup": { + "shape": "String", + "documentation": "The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CiDR block to this location.
You must set AmazonProvidedIpv6CidrBlock
to true
to use this parameter.
You can have one IPv6 CIDR block association per network border group.
" } } }, @@ -6356,12 +6869,17 @@ "members": { "State": { "shape": "AvailabilityZoneState", - "documentation": "The state of the Availability Zone.
", + "documentation": "The state of the Availability Zone or Local Zone.
", "locationName": "zoneState" }, + "OptInStatus": { + "shape": "AvailabilityZoneOptInStatus", + "documentation": " For Availability Zones, this parameter always has the value of opt-in-not-required
.
For Local Zones, this parameter is the opt in status. The possible values are opted-in
, and not-opted-in
.
Any messages about the Availability Zone.
", + "documentation": "Any messages about the Availability Zone or Local Zone.
", "locationName": "messageSet" }, "RegionName": { @@ -6371,16 +6889,26 @@ }, "ZoneName": { "shape": "String", - "documentation": "The name of the Availability Zone.
", + "documentation": "The name of the Availability Zone or Local Zone.
", "locationName": "zoneName" }, "ZoneId": { "shape": "String", - "documentation": "The ID of the Availability Zone.
", + "documentation": "The ID of the Availability Zone or Local Zone.
", "locationName": "zoneId" + }, + "GroupName": { + "shape": "String", + "documentation": "For Availability Zones, this parameter has the same value as the Region name.
For Local Zones, the name of the associated group, for example us-west-2-lax-1
.
The name of the location from which the address is advertised.
", + "locationName": "networkBorderGroup" } }, - "documentation": "Describes an Availability Zone.
" + "documentation": "Describes an Availability Zone or Local Zone.
" }, "AvailabilityZoneList": { "type": "list", @@ -6394,11 +6922,11 @@ "members": { "Message": { "shape": "String", - "documentation": "The message about the Availability Zone.
", + "documentation": "The message about the Availability Zone or Local Zone.
", "locationName": "message" } }, - "documentation": "Describes a message about an Availability Zone.
" + "documentation": "Describes a message about an Availability Zone or Local Zone.
" }, "AvailabilityZoneMessageList": { "type": "list", @@ -6407,6 +6935,14 @@ "locationName": "item" } }, + "AvailabilityZoneOptInStatus": { + "type": "string", + "enum": [ + "opt-in-not-required", + "opted-in", + "not-opted-in" + ] + }, "AvailabilityZoneState": { "type": "string", "enum": [ @@ -7802,6 +8338,84 @@ "locationName": "item" } }, + "CoipAddressUsage": { + "type": "structure", + "members": { + "AllocationId": { + "shape": "String", + "documentation": "The allocation ID of the address.
", + "locationName": "allocationId" + }, + "AwsAccountId": { + "shape": "String", + "documentation": "The AWS account ID.
", + "locationName": "awsAccountId" + }, + "AwsService": { + "shape": "String", + "documentation": "The AWS service.
", + "locationName": "awsService" + }, + "CoIp": { + "shape": "String", + "documentation": "The customer-owned IP address.
", + "locationName": "coIp" + } + }, + "documentation": "Describes address usage for a customer-owned address pool.
" + }, + "CoipAddressUsageSet": { + "type": "list", + "member": { + "shape": "CoipAddressUsage", + "locationName": "item" + } + }, + "CoipPool": { + "type": "structure", + "members": { + "PoolId": { + "shape": "String", + "documentation": "The ID of the address pool.
", + "locationName": "poolId" + }, + "PoolCidrs": { + "shape": "ValueStringList", + "documentation": "The address ranges of the address pool.
", + "locationName": "poolCidrSet" + }, + "LocalGatewayRouteTableId": { + "shape": "String", + "documentation": "The ID of the local gateway route table.
", + "locationName": "localGatewayRouteTableId" + }, + "Tags": { + "shape": "TagList", + "documentation": "The tags.
", + "locationName": "tagSet" + } + }, + "documentation": "Describes a customer-owned address pool.
" + }, + "CoipPoolIdSet": { + "type": "list", + "member": { + "shape": "String", + "locationName": "item" + } + }, + "CoipPoolMaxResults": { + "type": "integer", + "max": 1000, + "min": 5 + }, + "CoipPoolSet": { + "type": "list", + "member": { + "shape": "CoipPool", + "locationName": "item" + } + }, "ConfirmProductInstanceRequest": { "type": "structure", "required": [ @@ -8767,7 +9381,7 @@ }, "LogDestination": { "shape": "String", - "documentation": "Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType
.
If LogDestinationType is not specified or cloud-watch-logs
, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.
If LogDestinationType is s3
, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/
. For example, to specify a subfolder named my-logs
in a bucket named my-bucket
, use the following ARN: arn:aws:s3:::my-bucket/my-logs/
. You cannot use AWSLogs
as a subfolder name. This is a reserved term.
Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType
.
If LogDestinationType
is not specified or cloud-watch-logs
, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group. For example, to publish to a log group called my-logs
, specify arn:aws:logs:us-east-1:123456789012:log-group:my-logs
. Alternatively, use LogGroupName
instead.
If LogDestinationType is s3
, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/
. For example, to specify a subfolder named my-logs
in a bucket named my-bucket
, use the following ARN: arn:aws:s3:::my-bucket/my-logs/
. You cannot use AWSLogs
as a subfolder name. This is a reserved term.
The CIDR range used for destination matches. Routing decisions are based on the most specific match.
" + }, + "LocalGatewayRouteTableId": { + "shape": "String", + "documentation": "The ID of the local gateway route table.
" + }, + "LocalGatewayVirtualInterfaceGroupId": { + "shape": "String", + "documentation": "The ID of the virtual interface group.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the route.
", + "locationName": "route" + } + } + }, + "CreateLocalGatewayRouteTableVpcAssociationRequest": { + "type": "structure", + "required": [ + "LocalGatewayRouteTableId", + "VpcId" + ], + "members": { + "LocalGatewayRouteTableId": { + "shape": "String", + "documentation": "The ID of the local gateway route table.
" + }, + "VpcId": { + "shape": "String", + "documentation": "The ID of the VPC.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the association.
", + "locationName": "localGatewayRouteTableVpcAssociation" + } + } + }, "CreateNatGatewayRequest": { "type": "structure", "required": [ @@ -9409,6 +10090,10 @@ "shape": "TransitGatewayId", "documentation": "The ID of a transit gateway.
" }, + "LocalGatewayId": { + "shape": "String", + "documentation": "The ID of the local gateway.
" + }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of a network interface.
", @@ -9610,11 +10295,11 @@ "members": { "AvailabilityZone": { "shape": "String", - "documentation": "The Availability Zone for the subnet.
Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.
" + "documentation": "The Availability Zone or Local Zone for the subnet.
Default: AWS selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.
To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a
. For information about the Regions that support Local Zones, see Available Regions in the Amazon Elastic Compute Cloud User Guide.
The AZ ID of the subnet.
" + "documentation": "The AZ ID or the Local Zone ID of the subnet.
" }, "CidrBlock": { "shape": "String", @@ -9624,8 +10309,12 @@ "shape": "String", "documentation": "The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.
" }, + "OutpostArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the Outpost.
" + }, "VpcId": { - "shape": "VpcId", + "shape": "String", "documentation": "The ID of the VPC.
" }, "DryRun": { @@ -9898,6 +10587,83 @@ } } }, + "CreateTransitGatewayMulticastDomainRequest": { + "type": "structure", + "required": [ + "TransitGatewayId" + ], + "members": { + "TransitGatewayId": { + "shape": "String", + "documentation": "The ID of the transit gateway.
" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "The tags for the transit gateway multicast domain.
", + "locationName": "TagSpecification" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the transit gateway multicast domain.
", + "locationName": "transitGatewayMulticastDomain" + } + } + }, + "CreateTransitGatewayPeeringAttachmentRequest": { + "type": "structure", + "required": [ + "TransitGatewayId", + "PeerTransitGatewayId", + "PeerAccountId", + "PeerRegion" + ], + "members": { + "TransitGatewayId": { + "shape": "String", + "documentation": "The ID of the transit gateway.
" + }, + "PeerTransitGatewayId": { + "shape": "String", + "documentation": "The ID of the peer transit gateway with which to create the peering attachment.
" + }, + "PeerAccountId": { + "shape": "String", + "documentation": "The AWS account ID of the owner of the peer transit gateway.
" + }, + "PeerRegion": { + "shape": "String", + "documentation": "The Region where the peer transit gateway is located.
" + }, + "TagSpecifications": { + "shape": "TagSpecificationList", + "documentation": "The tags to apply to the transit gateway peering attachment.
", + "locationName": "TagSpecification" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
The transit gateway peering attachment.
", + "locationName": "transitGatewayPeeringAttachment" + } + } + }, "CreateTransitGatewayRequest": { "type": "structure", "members": { @@ -9942,11 +10708,11 @@ "documentation": "The CIDR range used for destination matches. Routing decisions are based on the most specific match.
" }, "TransitGatewayRouteTableId": { - "shape": "TransitGatewayRouteTableId", + "shape": "String", "documentation": "The ID of the transit gateway route table.
" }, "TransitGatewayAttachmentId": { - "shape": "TransitGatewayAttachmentId", + "shape": "String", "documentation": "The ID of the attachment.
" }, "Blackhole": { @@ -9976,7 +10742,7 @@ ], "members": { "TransitGatewayId": { - "shape": "TransitGatewayId", + "shape": "String", "documentation": "The ID of the transit gateway.
" }, "TagSpecifications": { @@ -10008,11 +10774,11 @@ ], "members": { "TransitGatewayId": { - "shape": "TransitGatewayId", + "shape": "String", "documentation": "The ID of the transit gateway.
" }, "VpcId": { - "shape": "VpcId", + "shape": "String", "documentation": "The ID of the VPC.
" }, "SubnetIds": { @@ -10117,6 +10883,10 @@ "shape": "KmsKeyId", "documentation": "The identifier of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for Amazon EBS encryption. If this parameter is not specified, your AWS managed CMK for EBS is used. If KmsKeyId
is specified, the encrypted state must be true
.
You can specify the CMK using any of the following:
Key ID. For example, key/1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS authenticates the CMK asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
" }, + "OutpostArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the Outpost.
" + }, "Size": { "shape": "Integer", "documentation": "The size of the volume, in GiBs.
Constraints: 1-16,384 for gp2
, 4-16,384 for io1
, 500-16,384 for st1
, 500-16,384 for sc1
, and 1-1,024 for standard
. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
At least one of Size or SnapshotId is required.
The tenancy options for instances launched into the VPC. For default
, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For dedicated
, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of dedicated
or host
into a dedicated tenancy VPC.
Important: The host
value cannot be used with this parameter. Use the default
or dedicated
values only.
Default: default
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set AmazonProvidedIpv6CidrBlock
to true
to use this parameter.
The CIDR range for the route. This must match the CIDR for the route exactly.
" + }, + "LocalGatewayRouteTableId": { + "shape": "String", + "documentation": "The ID of the local gateway route table.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the route.
", + "locationName": "route" + } + } + }, + "DeleteLocalGatewayRouteTableVpcAssociationRequest": { + "type": "structure", + "required": [ + "LocalGatewayRouteTableVpcAssociationId" + ], + "members": { + "LocalGatewayRouteTableVpcAssociationId": { + "shape": "String", + "documentation": "The ID of the association.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the association.
", + "locationName": "localGatewayRouteTableVpcAssociation" + } + } + }, "DeleteNatGatewayRequest": { "type": "structure", "required": [ @@ -11370,7 +12201,7 @@ ], "members": { "SubnetId": { - "shape": "SubnetId", + "shape": "String", "documentation": "The ID of the subnet.
" }, "DryRun": { @@ -11507,6 +12338,58 @@ } } }, + "DeleteTransitGatewayMulticastDomainRequest": { + "type": "structure", + "required": [ + "TransitGatewayMulticastDomainId" + ], + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the deleted transit gateway multicast domain.
", + "locationName": "transitGatewayMulticastDomain" + } + } + }, + "DeleteTransitGatewayPeeringAttachmentRequest": { + "type": "structure", + "required": [ + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayAttachmentId": { + "shape": "String", + "documentation": "The ID of the transit gateway peering attachment.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
The transit gateway peering attachment.
", + "locationName": "transitGatewayPeeringAttachment" + } + } + }, "DeleteTransitGatewayRequest": { "type": "structure", "required": [ @@ -11514,7 +12397,7 @@ ], "members": { "TransitGatewayId": { - "shape": "TransitGatewayId", + "shape": "String", "documentation": "The ID of the transit gateway.
" }, "DryRun": { @@ -11541,7 +12424,7 @@ ], "members": { "TransitGatewayRouteTableId": { - "shape": "TransitGatewayRouteTableId", + "shape": "String", "documentation": "The ID of the transit gateway route table.
" }, "DestinationCidrBlock": { @@ -11571,7 +12454,7 @@ ], "members": { "TransitGatewayRouteTableId": { - "shape": "TransitGatewayRouteTableId", + "shape": "String", "documentation": "The ID of the transit gateway route table.
" }, "DryRun": { @@ -11597,7 +12480,7 @@ ], "members": { "TransitGatewayAttachmentId": { - "shape": "TransitGatewayAttachmentId", + "shape": "String", "documentation": "The ID of the attachment.
" }, "DryRun": { @@ -11859,6 +12742,68 @@ }, "documentation": "Contains the parameters for DeregisterImage.
" }, + "DeregisterTransitGatewayMulticastGroupMembersRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
" + }, + "GroupIpAddress": { + "shape": "String", + "documentation": "The IP address assigned to the transit gateway multicast group.
" + }, + "NetworkInterfaceIds": { + "shape": "ValueStringList", + "documentation": "The IDs of the group members' network interfaces.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the deregistered members.
", + "locationName": "deregisteredMulticastGroupMembers" + } + } + }, + "DeregisterTransitGatewayMulticastGroupSourcesRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
" + }, + "GroupIpAddress": { + "shape": "String", + "documentation": "The IP address assigned to the transit gateway multicast group.
" + }, + "NetworkInterfaceIds": { + "shape": "ValueStringList", + "documentation": "The IDs of the group sources' network interfaces.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the deregistered group sources.
", + "locationName": "deregisteredMulticastGroupSources" + } + } + }, "DescribeAccountAttributesRequest": { "type": "structure", "members": { @@ -11948,19 +12893,23 @@ "members": { "Filters": { "shape": "FilterList", - "documentation": "The filters.
message
- Information about the Availability Zone.
region-name
- The name of the Region for the Availability Zone (for example, us-east-1
).
state
- The state of the Availability Zone (available
| information
| impaired
| unavailable
).
zone-id
- The ID of the Availability Zone (for example, use1-az1
).
zone-name
- The name of the Availability Zone (for example, us-east-1a
).
The filters.
group-name
- For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1
).
message
- The Availability Zone or Local Zone message.
opt-in-status
- The opt in status (opted-in
, and not-opted-in
| opt-in-not-required
).
region-name
- The name of the Region for the Availability Zone or Local Zone (for example, us-east-1
).
state
- The state of the Availability Zone or Local Zone (available
| information
| impaired
| unavailable
).
zone-id
- The ID of the Availability Zone (for example, use1-az1
) or the Local Zone (for example, use usw2-lax1-az1
).
zone-name
- The name of the Availability Zone (for example, us-east-1a
) or the Local Zone (for example, use us-west-2-lax-1a
).
The names of the Availability Zones.
", + "documentation": "The names of the Availability Zones and Local Zones.
", "locationName": "ZoneName" }, "ZoneIds": { "shape": "ZoneIdStringList", - "documentation": "The IDs of the Availability Zones.
", + "documentation": "The IDs of the Availability Zones and Local Zones.
", "locationName": "ZoneId" }, + "AllAvailabilityZones": { + "shape": "Boolean", + "documentation": "Include all Availability Zones and Local Zones regardless of your opt in status.
If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
" + }, "DryRun": { "shape": "Boolean", "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the Availability Zones.
", + "documentation": "Information about the Availability Zones and Local Zones.
", "locationName": "availabilityZoneInfo" } } @@ -12392,6 +13341,48 @@ } } }, + "DescribeCoipPoolsRequest": { + "type": "structure", + "members": { + "PoolIds": { + "shape": "CoipPoolIdSet", + "documentation": "The IDs of the address pools.
", + "locationName": "PoolId" + }, + "Filters": { + "shape": "FilterList", + "documentation": "The filters. The following are the possible values:
coip-pool.pool-id
coip-pool.local-gateway-route-table-id
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the address pools.
", + "locationName": "coipPoolSet" + }, + "NextToken": { + "shape": "String", + "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The IDs of the associations.
", + "locationName": "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId" + }, + "Filters": { + "shape": "FilterList", + "documentation": "One or more filters.
", + "locationName": "Filter" + }, + "MaxResults": { + "shape": "LocalGatewayMaxResults", + "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the associations.
", + "locationName": "localGatewayRouteTableVirtualInterfaceGroupAssociationSet" + }, + "NextToken": { + "shape": "String", + "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The IDs of the associations.
", + "locationName": "LocalGatewayRouteTableVpcAssociationId" + }, + "Filters": { + "shape": "FilterList", + "documentation": "One or more filters.
", + "locationName": "Filter" + }, + "MaxResults": { + "shape": "LocalGatewayMaxResults", + "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the associations.
", + "locationName": "localGatewayRouteTableVpcAssociationSet" + }, + "NextToken": { + "shape": "String", + "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The IDs of the local gateway route tables.
", + "locationName": "LocalGatewayRouteTableId" + }, + "Filters": { + "shape": "FilterList", + "documentation": "One or more filters.
", + "locationName": "Filter" + }, + "MaxResults": { + "shape": "LocalGatewayMaxResults", + "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the local gateway route tables.
", + "locationName": "localGatewayRouteTableSet" + }, + "NextToken": { + "shape": "String", + "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The IDs of the virtual interface groups.
", + "locationName": "LocalGatewayVirtualInterfaceGroupId" + }, + "Filters": { + "shape": "FilterList", + "documentation": "One or more filters.
", + "locationName": "Filter" + }, + "MaxResults": { + "shape": "LocalGatewayMaxResults", + "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
The virtual interface groups.
", + "locationName": "localGatewayVirtualInterfaceGroupSet" + }, + "NextToken": { + "shape": "String", + "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The IDs of the virtual interfaces.
", + "locationName": "LocalGatewayVirtualInterfaceId" + }, + "Filters": { + "shape": "FilterList", + "documentation": "One or more filters.
", + "locationName": "Filter" + }, + "MaxResults": { + "shape": "LocalGatewayMaxResults", + "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the virtual interfaces.
", + "locationName": "localGatewayVirtualInterfaceSet" + }, + "NextToken": { + "shape": "String", + "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The IDs of the local gateways.
", + "locationName": "LocalGatewayId" + }, + "Filters": { + "shape": "FilterList", + "documentation": "One or more filters.
", + "locationName": "Filter" + }, + "MaxResults": { + "shape": "LocalGatewayMaxResults", + "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the local gateways.
", + "locationName": "localGatewaySet" + }, + "NextToken": { + "shape": "String", + "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The ID of the transit gateway multicast domain.
" + }, + "Filters": { + "shape": "FilterList", + "documentation": "One or more filters. The possible values are:
state
- The state of the transit gateway multicast domain. Valid values are pending
| available
| deleting
| deleted
.
transit-gateway-id
- The ID of the transit gateway.
transit-gateway-multicast-domain-id
- The ID of the transit gateway multicast domain.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the transit gateway multicast domains.
", + "locationName": "transitGatewayMulticastDomains" + }, + "NextToken": { + "shape": "String", + "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
One or more IDs of the transit gateway peering attachments.
" + }, + "Filters": { + "shape": "FilterList", + "documentation": "One or more filters.
", + "locationName": "Filter" + }, + "MaxResults": { + "shape": "TransitGatewayMaxResults", + "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
The transit gateway peering attachments.
", + "locationName": "transitGatewayPeeringAttachments" + }, + "NextToken": { + "shape": "String", + "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The ID of the propagation route table.
" }, "TransitGatewayAttachmentId": { - "shape": "TransitGatewayAttachmentId", + "shape": "String", "documentation": "The ID of the attachment.
" }, "DryRun": { @@ -16982,7 +18307,7 @@ ], "members": { "AssociationId": { - "shape": "SubnetCidrAssociationId", + "shape": "String", "documentation": "The association ID for the CIDR block.
", "locationName": "associationId" } @@ -17003,6 +18328,37 @@ } } }, + "DisassociateTransitGatewayMulticastDomainRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
" + }, + "TransitGatewayAttachmentId": { + "shape": "String", + "documentation": "The ID of the attachment.
" + }, + "SubnetIds": { + "shape": "ValueStringList", + "documentation": "The IDs of the subnets;
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the association.
", + "locationName": "associations" + } + } + }, "DisassociateTransitGatewayRouteTableRequest": { "type": "structure", "required": [ @@ -17011,11 +18367,11 @@ ], "members": { "TransitGatewayRouteTableId": { - "shape": "TransitGatewayRouteTableId", + "shape": "String", "documentation": "The ID of the transit gateway route table.
" }, "TransitGatewayAttachmentId": { - "shape": "TransitGatewayAttachmentId", + "shape": "String", "documentation": "The ID of the attachment.
" }, "DryRun": { @@ -17816,11 +19172,11 @@ ], "members": { "TransitGatewayRouteTableId": { - "shape": "TransitGatewayRouteTableId", + "shape": "String", "documentation": "The ID of the propagation route table.
" }, "TransitGatewayAttachmentId": { - "shape": "TransitGatewayAttachmentId", + "shape": "String", "documentation": "The ID of the attachment.
" }, "DryRun": { @@ -18354,7 +19710,7 @@ ], "members": { "TransitGatewayRouteTableId": { - "shape": "TransitGatewayRouteTableId", + "shape": "String", "documentation": "The ID of the route table.
" }, "Filters": { @@ -19181,6 +20537,55 @@ } } }, + "GetCoipPoolUsageRequest": { + "type": "structure", + "required": [ + "PoolId" + ], + "members": { + "PoolId": { + "shape": "String", + "documentation": "The ID of the address pool.
" + }, + "Filters": { + "shape": "FilterList", + "documentation": "The filters. The following are the possible values:
coip-address-usage.allocation-id
coip-address-usage.aws-account-id
coip-address-usage.aws-service
coip-address-usage.co-ip
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
The ID of the customer-owned address pool.
", + "locationName": "coipPoolId" + }, + "CoipAddressUsages": { + "shape": "CoipAddressUsageSet", + "documentation": "Information about the address usage.
", + "locationName": "coipAddressUsageSet" + }, + "LocalGatewayRouteTableId": { + "shape": "String", + "documentation": "The ID of the local gateway route table.
", + "locationName": "localGatewayRouteTableId" + } + } + }, "GetConsoleOutputRequest": { "type": "structure", "required": [ @@ -19507,7 +20912,7 @@ ], "members": { "TransitGatewayAttachmentId": { - "shape": "TransitGatewayAttachmentId", + "shape": "String", "documentation": "The ID of the attachment.
" }, "Filters": { @@ -19544,6 +20949,47 @@ } } }, + "GetTransitGatewayMulticastDomainAssociationsRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
" + }, + "Filters": { + "shape": "FilterList", + "documentation": "One or more filters. The possible values are:
resource-id
- The ID of the resource.
resource-type
- The type of resource. The valid value is: vpc
.
state
- The state of the subnet association. Valid values are associated
| associating
| disassociated
| disassociating
.
subnet-id
- The ID of the subnet.
transit-gateway-attachment-id
- The id of the transit gateway attachment.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the multicast domain associations.
", + "locationName": "multicastDomainAssociations" + }, + "NextToken": { + "shape": "String", + "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The ID of the transit gateway route table.
" }, "Filters": { @@ -19595,7 +21041,7 @@ ], "members": { "TransitGatewayRouteTableId": { - "shape": "TransitGatewayRouteTableId", + "shape": "String", "documentation": "The ID of the transit gateway route table.
" }, "Filters": { @@ -21247,6 +22693,54 @@ }, "documentation": "Describes an import volume task.
" }, + "InferenceAcceleratorInfo": { + "type": "structure", + "members": { + "Accelerators": { + "shape": "InferenceDeviceInfoList", + "documentation": "Describes the Inference accelerators for the instance type.
", + "locationName": "accelerators" + } + }, + "documentation": "Describes the Inference accelerators for the instance type.
" + }, + "InferenceDeviceCount": { + "type": "integer" + }, + "InferenceDeviceInfo": { + "type": "structure", + "members": { + "Count": { + "shape": "InferenceDeviceCount", + "documentation": "The number of Inference accelerators for the instance type.
", + "locationName": "count" + }, + "Name": { + "shape": "InferenceDeviceName", + "documentation": "The name of the Inference accelerator.
", + "locationName": "name" + }, + "Manufacturer": { + "shape": "InferenceDeviceManufacturerName", + "documentation": "The manufacturer of the Inference accelerator.
", + "locationName": "manufacturer" + } + }, + "documentation": "Describes the Inference accelerators for the instance type.
" + }, + "InferenceDeviceInfoList": { + "type": "list", + "member": { + "shape": "InferenceDeviceInfo" + }, + "locationName": "item" + }, + "InferenceDeviceManufacturerName": { + "type": "string" + }, + "InferenceDeviceName": { + "type": "string" + }, "Instance": { "type": "structure", "members": { @@ -21405,6 +22899,11 @@ "documentation": "[EC2-VPC] The network interfaces for the instance.
", "locationName": "networkInterfaceSet" }, + "OutpostArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", + "locationName": "outpostArn" + }, "RootDeviceName": { "shape": "String", "documentation": "The device name of the root device volume (for example, /dev/sda1
).
The Availability Zone of the instance.
", "locationName": "availabilityZone" }, + "OutpostArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", + "locationName": "outpostArn" + }, "Events": { "shape": "InstanceStatusEventList", "documentation": "Any scheduled events associated with the instance.
", @@ -22703,7 +24207,11 @@ "r5n.8xlarge", "r5n.12xlarge", "r5n.16xlarge", - "r5n.24xlarge" + "r5n.24xlarge", + "inf1.xlarge", + "inf1.2xlarge", + "inf1.6xlarge", + "inf1.24xlarge" ] }, "InstanceTypeHypervisor": { @@ -22801,6 +24309,11 @@ "documentation": "Describes the placement group settings for the instance type.
", "locationName": "placementGroupInfo" }, + "InferenceAcceleratorInfo": { + "shape": "InferenceAcceleratorInfo", + "documentation": "Describes the Inference accelerator settings for the instance type.
", + "locationName": "inferenceAcceleratorInfo" + }, "HibernationSupported": { "shape": "HibernationFlag", "documentation": "Indicates whether On-Demand hibernation is supported.
", @@ -24325,6 +25838,326 @@ }, "documentation": "Describes a load permission.
" }, + "LocalGateway": { + "type": "structure", + "members": { + "LocalGatewayId": { + "shape": "String", + "documentation": "The ID of the local gateway.
", + "locationName": "localGatewayId" + }, + "OutpostArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", + "locationName": "outpostArn" + }, + "OwnerId": { + "shape": "String", + "documentation": "The ID of the AWS account ID that owns the local gateway.
", + "locationName": "ownerId" + }, + "State": { + "shape": "String", + "documentation": "The state of the local gateway.
", + "locationName": "state" + } + }, + "documentation": "Describes a local gateway.
" + }, + "LocalGatewayIdSet": { + "type": "list", + "member": { + "shape": "String", + "locationName": "item" + } + }, + "LocalGatewayMaxResults": { + "type": "integer", + "max": 1000, + "min": 5 + }, + "LocalGatewayRoute": { + "type": "structure", + "members": { + "DestinationCidrBlock": { + "shape": "String", + "documentation": "The CIDR block used for destination matches.
", + "locationName": "destinationCidrBlock" + }, + "LocalGatewayVirtualInterfaceGroupId": { + "shape": "String", + "documentation": "The ID of the virtual interface group.
", + "locationName": "localGatewayVirtualInterfaceGroupId" + }, + "Type": { + "shape": "LocalGatewayRouteType", + "documentation": "The route type.
", + "locationName": "type" + }, + "State": { + "shape": "LocalGatewayRouteState", + "documentation": "The state of the route.
", + "locationName": "state" + }, + "LocalGatewayRouteTableId": { + "shape": "String", + "documentation": "The ID of the local gateway route table.
", + "locationName": "localGatewayRouteTableId" + } + }, + "documentation": "Describes a route for a local gateway route table.
" + }, + "LocalGatewayRouteList": { + "type": "list", + "member": { + "shape": "LocalGatewayRoute", + "locationName": "item" + } + }, + "LocalGatewayRouteState": { + "type": "string", + "enum": [ + "pending", + "active", + "blackhole", + "deleting", + "deleted" + ] + }, + "LocalGatewayRouteTable": { + "type": "structure", + "members": { + "LocalGatewayRouteTableId": { + "shape": "String", + "documentation": "The ID of the local gateway route table.
", + "locationName": "localGatewayRouteTableId" + }, + "LocalGatewayId": { + "shape": "String", + "documentation": "The ID of the local gateway.
", + "locationName": "localGatewayId" + }, + "OutpostArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", + "locationName": "outpostArn" + }, + "State": { + "shape": "String", + "documentation": "The state of the local gateway route table.
", + "locationName": "state" + } + }, + "documentation": "Describes a local gateway route table.
" + }, + "LocalGatewayRouteTableIdSet": { + "type": "list", + "member": { + "shape": "String", + "locationName": "item" + } + }, + "LocalGatewayRouteTableSet": { + "type": "list", + "member": { + "shape": "LocalGatewayRouteTable", + "locationName": "item" + } + }, + "LocalGatewayRouteTableVirtualInterfaceGroupAssociation": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationId": { + "shape": "String", + "documentation": "The ID of the association.
", + "locationName": "localGatewayRouteTableVirtualInterfaceGroupAssociationId" + }, + "LocalGatewayVirtualInterfaceGroupId": { + "shape": "String", + "documentation": "The ID of the virtual interface group.
", + "locationName": "localGatewayVirtualInterfaceGroupId" + }, + "LocalGatewayId": { + "shape": "String", + "documentation": "The ID of the local gateway.
", + "locationName": "localGatewayId" + }, + "LocalGatewayRouteTableId": { + "shape": "String", + "documentation": "The ID of the local gateway route table.
", + "locationName": "localGatewayRouteTableId" + }, + "State": { + "shape": "String", + "documentation": "The state of the association.
", + "locationName": "state" + } + }, + "documentation": "Describes an association between a local gateway route table and a virtual interface group.
" + }, + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet": { + "type": "list", + "member": { + "shape": "String", + "locationName": "item" + } + }, + "LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet": { + "type": "list", + "member": { + "shape": "LocalGatewayRouteTableVirtualInterfaceGroupAssociation", + "locationName": "item" + } + }, + "LocalGatewayRouteTableVpcAssociation": { + "type": "structure", + "members": { + "LocalGatewayRouteTableVpcAssociationId": { + "shape": "String", + "documentation": "The ID of the association.
", + "locationName": "localGatewayRouteTableVpcAssociationId" + }, + "LocalGatewayRouteTableId": { + "shape": "String", + "documentation": "The ID of the local gateway route table.
", + "locationName": "localGatewayRouteTableId" + }, + "LocalGatewayId": { + "shape": "String", + "documentation": "The ID of the local gateway.
", + "locationName": "localGatewayId" + }, + "VpcId": { + "shape": "String", + "documentation": "The ID of the VPC.
", + "locationName": "vpcId" + }, + "State": { + "shape": "String", + "documentation": "The state of the association.
", + "locationName": "state" + } + }, + "documentation": "Describes an association between a local gateway route table and a VPC.
" + }, + "LocalGatewayRouteTableVpcAssociationIdSet": { + "type": "list", + "member": { + "shape": "String", + "locationName": "item" + } + }, + "LocalGatewayRouteTableVpcAssociationSet": { + "type": "list", + "member": { + "shape": "LocalGatewayRouteTableVpcAssociation", + "locationName": "item" + } + }, + "LocalGatewayRouteType": { + "type": "string", + "enum": [ + "static", + "propagated" + ] + }, + "LocalGatewaySet": { + "type": "list", + "member": { + "shape": "LocalGateway", + "locationName": "item" + } + }, + "LocalGatewayVirtualInterface": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceId": { + "shape": "String", + "documentation": "The ID of the virtual interface.
", + "locationName": "localGatewayVirtualInterfaceId" + }, + "LocalGatewayId": { + "shape": "String", + "documentation": "The ID of the local gateway.
", + "locationName": "localGatewayId" + }, + "Vlan": { + "shape": "Integer", + "documentation": "The ID of the VLAN.
", + "locationName": "vlan" + }, + "LocalAddress": { + "shape": "String", + "documentation": "The local address.
", + "locationName": "localAddress" + }, + "PeerAddress": { + "shape": "String", + "documentation": "The peer address.
", + "locationName": "peerAddress" + }, + "LocalBgpAsn": { + "shape": "Integer", + "documentation": "The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
", + "locationName": "localBgpAsn" + }, + "PeerBgpAsn": { + "shape": "Integer", + "documentation": "The peer BGP ASN.
", + "locationName": "peerBgpAsn" + } + }, + "documentation": "Describes a local gateway virtual interface.
" + }, + "LocalGatewayVirtualInterfaceGroup": { + "type": "structure", + "members": { + "LocalGatewayVirtualInterfaceGroupId": { + "shape": "String", + "documentation": "The ID of the virtual interface group.
", + "locationName": "localGatewayVirtualInterfaceGroupId" + }, + "LocalGatewayVirtualInterfaceIds": { + "shape": "LocalGatewayVirtualInterfaceIdSet", + "documentation": "The IDs of the virtual interfaces.
", + "locationName": "localGatewayVirtualInterfaceIdSet" + }, + "LocalGatewayId": { + "shape": "String", + "documentation": "The ID of the local gateway.
", + "locationName": "localGatewayId" + } + }, + "documentation": "Describes a local gateway virtual interface group.
" + }, + "LocalGatewayVirtualInterfaceGroupIdSet": { + "type": "list", + "member": { + "shape": "String", + "locationName": "item" + } + }, + "LocalGatewayVirtualInterfaceGroupSet": { + "type": "list", + "member": { + "shape": "LocalGatewayVirtualInterfaceGroup", + "locationName": "item" + } + }, + "LocalGatewayVirtualInterfaceIdSet": { + "type": "list", + "member": { + "shape": "String", + "locationName": "item" + } + }, + "LocalGatewayVirtualInterfaceSet": { + "type": "list", + "member": { + "shape": "LocalGatewayVirtualInterface", + "locationName": "item" + } + }, "Location": { "type": "string" }, @@ -24361,6 +26194,16 @@ "MaxNetworkInterfaces": { "type": "integer" }, + "MaxResults": { + "type": "integer" + }, + "MembershipType": { + "type": "string", + "enum": [ + "static", + "igmp" + ] + }, "MemoryInfo": { "type": "structure", "members": { @@ -25241,7 +27084,7 @@ "documentation": "Specify true
to indicate that ENIs attached to instances created in the specified subnet should be assigned a public IPv4 address.
The ID of the subnet.
", "locationName": "subnetId" } @@ -25412,7 +27255,7 @@ ], "members": { "TransitGatewayAttachmentId": { - "shape": "TransitGatewayAttachmentId", + "shape": "String", "documentation": "The ID of the attachment.
" }, "AddSubnetIds": { @@ -26070,6 +27913,13 @@ "locationName": "item" } }, + "MulticastSupportValue": { + "type": "string", + "enum": [ + "enable", + "disable" + ] + }, "NatGateway": { "type": "structure", "members": { @@ -26403,6 +28253,11 @@ "documentation": "The ID of the network interface.
", "locationName": "networkInterfaceId" }, + "OutpostArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", + "locationName": "outpostArn" + }, "OwnerId": { "shape": "String", "documentation": "The AWS account ID of the owner of the network interface.
", @@ -26893,6 +28748,22 @@ }, "documentation": "Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus.
" }, + "PeeringAttachmentStatus": { + "type": "structure", + "members": { + "Code": { + "shape": "String", + "documentation": "The status code.
", + "locationName": "code" + }, + "Message": { + "shape": "String", + "documentation": "The status message, if applicable.
", + "locationName": "message" + } + }, + "documentation": "The status of the transit gateway peering attachment.
" + }, "PeeringConnectionOptions": { "type": "structure", "members": { @@ -26932,6 +28803,27 @@ }, "documentation": "The VPC peering connection options.
" }, + "PeeringTgwInfo": { + "type": "structure", + "members": { + "TransitGatewayId": { + "shape": "String", + "documentation": "The ID of the transit gateway.
", + "locationName": "transitGatewayId" + }, + "OwnerId": { + "shape": "String", + "documentation": "The AWS account ID of the owner of the transit gateway.
", + "locationName": "ownerId" + }, + "Region": { + "shape": "String", + "documentation": "The Region of the transit gateway.
", + "locationName": "region" + } + }, + "documentation": "Information about the transit gateway in the peering attachment.
" + }, "PermissionGroup": { "type": "string", "enum": [ @@ -28157,6 +30049,94 @@ }, "documentation": "Contains the output of RegisterImage.
" }, + "RegisterTransitGatewayMulticastGroupMembersRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
" + }, + "GroupIpAddress": { + "shape": "String", + "documentation": "The IP address assigned to the transit gateway multicast group.
" + }, + "NetworkInterfaceIds": { + "shape": "ValueStringList", + "documentation": "The group members' network interface IDs to register with the transit gateway multicast group.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the registered transit gateway multicast group members.
", + "locationName": "registeredMulticastGroupMembers" + } + } + }, + "RegisterTransitGatewayMulticastGroupSourcesRequest": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
" + }, + "GroupIpAddress": { + "shape": "String", + "documentation": "The IP address assigned to the transit gateway multicast group.
" + }, + "NetworkInterfaceIds": { + "shape": "ValueStringList", + "documentation": "The group sources' network interface IDs to register with the transit gateway multicast group.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the transit gateway multicast group sources.
", + "locationName": "registeredMulticastGroupSources" + } + } + }, + "RejectTransitGatewayPeeringAttachmentRequest": { + "type": "structure", + "required": [ + "TransitGatewayAttachmentId" + ], + "members": { + "TransitGatewayAttachmentId": { + "shape": "String", + "documentation": "The ID of the transit gateway peering attachment.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
The transit gateway peering attachment.
", + "locationName": "transitGatewayPeeringAttachment" + } + } + }, "RejectTransitGatewayVpcAttachmentRequest": { "type": "structure", "required": [ @@ -28164,7 +30144,7 @@ ], "members": { "TransitGatewayAttachmentId": { - "shape": "TransitGatewayAttachmentId", + "shape": "String", "documentation": "The ID of the attachment.
" }, "DryRun": { @@ -28247,13 +30227,17 @@ "type": "structure", "members": { "AllocationId": { - "shape": "AllocationId", + "shape": "String", "documentation": "[EC2-VPC] The allocation ID. Required for EC2-VPC.
" }, "PublicIp": { "shape": "String", "documentation": "[EC2-Classic] The Elastic IP address. Required for EC2-Classic.
" }, + "NetworkBorderGroup": { + "shape": "String", + "documentation": "The location that the IP address is released from.
If you provide an incorrect network border group, you will receive an InvalidAddress.NotFound
error. For more information, see Error Codes.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an InvalidParameterCombination
error. For more information, see Error Codes.
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
The ID of a NAT instance in your VPC.
", "locationName": "instanceId" }, + "LocalTarget": { + "shape": "Boolean", + "documentation": "Specifies whether to reset the local route to its default target (local
).
[IPv4 traffic only] The ID of a NAT gateway.
", @@ -28457,6 +30445,10 @@ "shape": "TransitGatewayId", "documentation": "The ID of a transit gateway.
" }, + "LocalGatewayId": { + "shape": "String", + "documentation": "The ID of the local gateway.
" + }, "NetworkInterfaceId": { "shape": "NetworkInterfaceId", "documentation": "The ID of a network interface.
", @@ -28505,6 +30497,11 @@ "shape": "String", "documentation": "The ID of the new association.
", "locationName": "newAssociationId" + }, + "AssociationState": { + "shape": "RouteTableAssociationState", + "documentation": "The state of the association.
", + "locationName": "associationState" } } }, @@ -28520,11 +30517,11 @@ "documentation": "The CIDR range used for the destination match. Routing decisions are based on the most specific match.
" }, "TransitGatewayRouteTableId": { - "shape": "TransitGatewayRouteTableId", + "shape": "String", "documentation": "The ID of the route table.
" }, "TransitGatewayAttachmentId": { - "shape": "TransitGatewayAttachmentId", + "shape": "String", "documentation": "The ID of the attachment.
" }, "Blackhole": { @@ -29676,6 +31673,7 @@ "traffic-mirror-target", "transit-gateway", "transit-gateway-attachment", + "transit-gateway-multicast-domain", "transit-gateway-route-table", "volume", "vpc", @@ -30084,6 +32082,11 @@ "documentation": "The ID of a transit gateway.
", "locationName": "transitGatewayId" }, + "LocalGatewayId": { + "shape": "String", + "documentation": "The ID of the local gateway.
", + "locationName": "localGatewayId" + }, "NetworkInterfaceId": { "shape": "String", "documentation": "The ID of the network interface.
", @@ -30134,7 +32137,7 @@ "members": { "Associations": { "shape": "RouteTableAssociationList", - "documentation": "The associations between the route table and one or more subnets.
", + "documentation": "The associations between the route table and one or more subnets or a gateway.
", "locationName": "associationSet" }, "PropagatingVgws": { @@ -30180,7 +32183,7 @@ }, "RouteTableAssociationId": { "shape": "String", - "documentation": "The ID of the association between a route table and a subnet.
", + "documentation": "The ID of the association.
", "locationName": "routeTableAssociationId" }, "RouteTableId": { @@ -30192,9 +32195,19 @@ "shape": "String", "documentation": "The ID of the subnet. A subnet ID is not returned for an implicit association.
", "locationName": "subnetId" + }, + "GatewayId": { + "shape": "String", + "documentation": "The ID of the internet gateway or virtual private gateway.
", + "locationName": "gatewayId" + }, + "AssociationState": { + "shape": "RouteTableAssociationState", + "documentation": "The state of the association.
", + "locationName": "associationState" } }, - "documentation": "Describes an association between a route table and a subnet.
" + "documentation": "Describes an association between a route table and a subnet or gateway.
" }, "RouteTableAssociationId": { "type": "string" @@ -30206,6 +32219,32 @@ "locationName": "item" } }, + "RouteTableAssociationState": { + "type": "structure", + "members": { + "State": { + "shape": "RouteTableAssociationStateCode", + "documentation": "The state of the association.
", + "locationName": "state" + }, + "StatusMessage": { + "shape": "String", + "documentation": "The status message, if applicable.
", + "locationName": "statusMessage" + } + }, + "documentation": "Describes the state of an association between a route table and a subnet or gateway.
" + }, + "RouteTableAssociationStateCode": { + "type": "string", + "enum": [ + "associating", + "associated", + "disassociating", + "disassociated", + "failed" + ] + }, "RouteTableGatewayId": { "type": "string" }, @@ -30982,6 +33021,92 @@ "locationName": "SecurityGroupId" } }, + "SearchLocalGatewayRoutesRequest": { + "type": "structure", + "required": [ + "LocalGatewayRouteTableId", + "Filters" + ], + "members": { + "LocalGatewayRouteTableId": { + "shape": "String", + "documentation": "The ID of the local gateway route table.
" + }, + "Filters": { + "shape": "FilterList", + "documentation": "One or more filters.
", + "locationName": "Filter" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the routes.
", + "locationName": "routeSet" + }, + "NextToken": { + "shape": "String", + "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The ID of the transit gateway multicast domain.
" + }, + "Filters": { + "shape": "FilterList", + "documentation": "One or more filters. The possible values are:
group-ip-address
- The IP address of the transit gateway multicast group.
is-group-member
- The resource is a group member. Valid values are true
| false
.
is-group-source
- The resource is a group source. Valid values are true
| false
.
member-type
- The member type. Valid values are igmp
| static
.
resource-id
- The ID of the resource.
resource-type
- The type of resource. Valid values are vpc
| vpn
| direct-connect-gateway
| tgw-peering
.
source-type
- The source type. Valid values are igmp
| static
.
state
- The state of the subnet association. Valid values are associated
| associated
| disassociated
| disassociating
.
subnet-id
- The ID of the subnet.
transit-gateway-attachment-id
- The id of the transit gateway attachment.
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken
value.
The token for the next page of results.
" + }, + "DryRun": { + "shape": "Boolean", + "documentation": "Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation
. Otherwise, it is UnauthorizedOperation
.
Information about the transit gateway multicast group.
", + "locationName": "multicastGroups" + }, + "NextToken": { + "shape": "String", + "documentation": "The token to use to retrieve the next page of results. This value is null
when there are no more results to return.
The ID of the transit gateway route table.
" }, "Filters": { @@ -32658,12 +34783,37 @@ "shape": "String", "documentation": "The Amazon Resource Name (ARN) of the subnet.
", "locationName": "subnetArn" + }, + "OutpostArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", + "locationName": "outpostArn" } }, "documentation": "Describes a subnet.
" }, - "SubnetCidrAssociationId": { - "type": "string" + "SubnetAssociation": { + "type": "structure", + "members": { + "SubnetId": { + "shape": "String", + "documentation": "The ID of the subnet.
", + "locationName": "subnetId" + }, + "State": { + "shape": "TransitGatewayMulitcastDomainAssociationState", + "documentation": "The state of the subnet association.
", + "locationName": "state" + } + }, + "documentation": "Describes the subnet association with the transit gateway multicast domain.
" + }, + "SubnetAssociationList": { + "type": "list", + "member": { + "shape": "SubnetAssociation", + "locationName": "item" + } }, "SubnetCidrBlockState": { "type": "structure", @@ -33680,9 +35830,6 @@ }, "documentation": "Describes an association.
" }, - "TransitGatewayAttachmentId": { - "type": "string" - }, "TransitGatewayAttachmentIdStringList": { "type": "list", "member": { @@ -33724,12 +35871,14 @@ "enum": [ "vpc", "vpn", - "direct-connect-gateway" + "direct-connect-gateway", + "tgw-peering" ] }, "TransitGatewayAttachmentState": { "type": "string", "enum": [ + "initiating", "pendingAcceptance", "rollingBack", "pending", @@ -33765,6 +35914,280 @@ "max": 1000, "min": 5 }, + "TransitGatewayMulitcastDomainAssociationState": { + "type": "string", + "enum": [ + "associating", + "associated", + "disassociating", + "disassociated" + ] + }, + "TransitGatewayMulticastDeregisteredGroupMembers": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
", + "locationName": "transitGatewayMulticastDomainId" + }, + "DeregisteredNetworkInterfaceIds": { + "shape": "ValueStringList", + "documentation": "The network interface IDs of the deregistered members.
", + "locationName": "deregisteredNetworkInterfaceIds" + }, + "GroupIpAddress": { + "shape": "String", + "documentation": "The IP address assigned to the transit gateway multicast group.
", + "locationName": "groupIpAddress" + } + }, + "documentation": "Describes the deregistered transit gateway multicast group members.
" + }, + "TransitGatewayMulticastDeregisteredGroupSources": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
", + "locationName": "transitGatewayMulticastDomainId" + }, + "DeregisteredNetworkInterfaceIds": { + "shape": "ValueStringList", + "documentation": "The network interface IDs of the non-registered members.
", + "locationName": "deregisteredNetworkInterfaceIds" + }, + "GroupIpAddress": { + "shape": "String", + "documentation": "The IP address assigned to the transit gateway multicast group.
", + "locationName": "groupIpAddress" + } + }, + "documentation": "Describes the deregistered transit gateway multicast group sources.
" + }, + "TransitGatewayMulticastDomain": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
", + "locationName": "transitGatewayMulticastDomainId" + }, + "TransitGatewayId": { + "shape": "String", + "documentation": "The ID of the transit gateway.
", + "locationName": "transitGatewayId" + }, + "State": { + "shape": "TransitGatewayMulticastDomainState", + "documentation": "The state of the transit gateway multicast domain.
", + "locationName": "state" + }, + "CreationTime": { + "shape": "DateTime", + "documentation": "The time the transit gateway multicast domain was created.
", + "locationName": "creationTime" + }, + "Tags": { + "shape": "TagList", + "documentation": "The tags for the transit gateway multicast domain.
", + "locationName": "tagSet" + } + }, + "documentation": "Describes the transit gateway multicast domain.
" + }, + "TransitGatewayMulticastDomainAssociation": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "shape": "String", + "documentation": "The ID of the transit gateway attachment.
", + "locationName": "transitGatewayAttachmentId" + }, + "ResourceId": { + "shape": "String", + "documentation": "The ID of the resource.
", + "locationName": "resourceId" + }, + "ResourceType": { + "shape": "TransitGatewayAttachmentResourceType", + "documentation": "The type of resource, for example a VPC attachment.
", + "locationName": "resourceType" + }, + "Subnet": { + "shape": "SubnetAssociation", + "documentation": "The subnet associated with the transit gateway multicast domain.
", + "locationName": "subnet" + } + }, + "documentation": "Describes the resources associated with the transit gateway multicast domain.
" + }, + "TransitGatewayMulticastDomainAssociationList": { + "type": "list", + "member": { + "shape": "TransitGatewayMulticastDomainAssociation", + "locationName": "item" + } + }, + "TransitGatewayMulticastDomainAssociations": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
", + "locationName": "transitGatewayMulticastDomainId" + }, + "TransitGatewayAttachmentId": { + "shape": "String", + "documentation": "The ID of the transit gateway attachment.
", + "locationName": "transitGatewayAttachmentId" + }, + "ResourceId": { + "shape": "String", + "documentation": "The ID of the resource.
", + "locationName": "resourceId" + }, + "ResourceType": { + "shape": "TransitGatewayAttachmentResourceType", + "documentation": "The type of resource, for example a VPC attachment.
", + "locationName": "resourceType" + }, + "Subnets": { + "shape": "SubnetAssociationList", + "documentation": "The subnets associated with the multicast domain.
", + "locationName": "subnets" + } + }, + "documentation": "Describes the multicast domain associations.
" + }, + "TransitGatewayMulticastDomainIdStringList": { + "type": "list", + "member": { + "shape": "String", + "locationName": "item" + } + }, + "TransitGatewayMulticastDomainList": { + "type": "list", + "member": { + "shape": "TransitGatewayMulticastDomain", + "locationName": "item" + } + }, + "TransitGatewayMulticastDomainState": { + "type": "string", + "enum": [ + "pending", + "available", + "deleting", + "deleted" + ] + }, + "TransitGatewayMulticastGroup": { + "type": "structure", + "members": { + "GroupIpAddress": { + "shape": "String", + "documentation": "The IP address assigned to the transit gateway multicast group.
", + "locationName": "groupIpAddress" + }, + "TransitGatewayAttachmentId": { + "shape": "String", + "documentation": "The ID of the transit gateway attachment.
", + "locationName": "transitGatewayAttachmentId" + }, + "SubnetId": { + "shape": "String", + "documentation": "The ID of the subnet.
", + "locationName": "subnetId" + }, + "ResourceId": { + "shape": "String", + "documentation": "The ID of the resource.
", + "locationName": "resourceId" + }, + "ResourceType": { + "shape": "TransitGatewayAttachmentResourceType", + "documentation": "The type of resource, for example a VPC attachment.
", + "locationName": "resourceType" + }, + "NetworkInterfaceId": { + "shape": "String", + "documentation": "The ID of the transit gateway attachment.
", + "locationName": "networkInterfaceId" + }, + "GroupMember": { + "shape": "Boolean", + "documentation": "Indicates that the resource is a transit gateway multicast group member.
", + "locationName": "groupMember" + }, + "GroupSource": { + "shape": "Boolean", + "documentation": "Indicates that the resource is a transit gateway multicast group member.
", + "locationName": "groupSource" + }, + "MemberType": { + "shape": "MembershipType", + "documentation": "The member type (for example, static
).
The source type.
", + "locationName": "sourceType" + } + }, + "documentation": "Describes the transit gateway multicast group resources.
" + }, + "TransitGatewayMulticastGroupList": { + "type": "list", + "member": { + "shape": "TransitGatewayMulticastGroup", + "locationName": "item" + } + }, + "TransitGatewayMulticastRegisteredGroupMembers": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
", + "locationName": "transitGatewayMulticastDomainId" + }, + "RegisteredNetworkInterfaceIds": { + "shape": "ValueStringList", + "documentation": "The ID of the registered network interfaces.
", + "locationName": "registeredNetworkInterfaceIds" + }, + "GroupIpAddress": { + "shape": "String", + "documentation": "The IP address assigned to the transit gateway multicast group.
", + "locationName": "groupIpAddress" + } + }, + "documentation": "Describes the registered transit gateway multicast group members.
" + }, + "TransitGatewayMulticastRegisteredGroupSources": { + "type": "structure", + "members": { + "TransitGatewayMulticastDomainId": { + "shape": "String", + "documentation": "The ID of the transit gateway multicast domain.
", + "locationName": "transitGatewayMulticastDomainId" + }, + "RegisteredNetworkInterfaceIds": { + "shape": "ValueStringList", + "documentation": "The IDs of the network interfaces members registered with the transit gateway multicast group.
", + "locationName": "registeredNetworkInterfaceIds" + }, + "GroupIpAddress": { + "shape": "String", + "documentation": "The IP address assigned to the transit gateway multicast group.
", + "locationName": "groupIpAddress" + } + }, + "documentation": "Describes the members registered with the transit gateway multicast group.
" + }, "TransitGatewayOptions": { "type": "structure", "members": { @@ -33807,10 +36230,63 @@ "shape": "DnsSupportValue", "documentation": "Indicates whether DNS support is enabled.
", "locationName": "dnsSupport" + }, + "MulticastSupport": { + "shape": "MulticastSupportValue", + "documentation": "Indicates whether multicast is enabled on the transit gateway
", + "locationName": "multicastSupport" } }, "documentation": "Describes the options for a transit gateway.
" }, + "TransitGatewayPeeringAttachment": { + "type": "structure", + "members": { + "TransitGatewayAttachmentId": { + "shape": "String", + "documentation": "The ID of the transit gateway peering attachment.
", + "locationName": "transitGatewayAttachmentId" + }, + "RequesterTgwInfo": { + "shape": "PeeringTgwInfo", + "documentation": "Information about the requester transit gateway.
", + "locationName": "requesterTgwInfo" + }, + "AccepterTgwInfo": { + "shape": "PeeringTgwInfo", + "documentation": "Information about the accepter transit gateway.
", + "locationName": "accepterTgwInfo" + }, + "Status": { + "shape": "PeeringAttachmentStatus", + "documentation": "The status of the transit gateway peering attachment.
", + "locationName": "status" + }, + "State": { + "shape": "TransitGatewayAttachmentState", + "documentation": "The state of the transit gateway peering attachment.
", + "locationName": "state" + }, + "CreationTime": { + "shape": "DateTime", + "documentation": "The time the transit gateway peering attachment was created.
", + "locationName": "creationTime" + }, + "Tags": { + "shape": "TagList", + "documentation": "The tags for the transit gateway peering attachment.
", + "locationName": "tagSet" + } + }, + "documentation": "Describes the transit gateway peering attachment.
" + }, + "TransitGatewayPeeringAttachmentList": { + "type": "list", + "member": { + "shape": "TransitGatewayPeeringAttachment", + "locationName": "item" + } + }, "TransitGatewayPropagation": { "type": "structure", "members": { @@ -33877,6 +36353,10 @@ "DnsSupport": { "shape": "DnsSupportValue", "documentation": "Enable or disable DNS support.
" + }, + "MulticastSupport": { + "shape": "MulticastSupportValue", + "documentation": "Indicates whether multicast is enabled on the transit gateway
" } }, "documentation": "Describes the options for a transit gateway.
" @@ -34026,9 +36506,6 @@ "locationName": "item" } }, - "TransitGatewayRouteTableId": { - "type": "string" - }, "TransitGatewayRouteTableIdStringList": { "type": "list", "member": { @@ -34783,6 +37260,11 @@ "documentation": "The Amazon Resource Name (ARN) of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the volume.
", "locationName": "kmsKeyId" }, + "OutpostArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", + "locationName": "outpostArn" + }, "Size": { "shape": "Integer", "documentation": "The size of the volume, in GiBs.
", @@ -35085,12 +37567,12 @@ "locationName": "eventType" }, "NotAfter": { - "shape": "DateTime", + "shape": "MillisecondDateTime", "documentation": "The latest end time of the event.
", "locationName": "notAfter" }, "NotBefore": { - "shape": "DateTime", + "shape": "MillisecondDateTime", "documentation": "The earliest start time of the event.
", "locationName": "notBefore" } @@ -35141,6 +37623,11 @@ "documentation": "The Availability Zone of the volume.
", "locationName": "availabilityZone" }, + "OutpostArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", + "locationName": "outpostArn" + }, "Events": { "shape": "VolumeStatusEventsList", "documentation": "A list of events associated with the volume.
", @@ -35540,6 +38027,11 @@ "shape": "VpcCidrBlockState", "documentation": "Information about the state of the CIDR block.
", "locationName": "ipv6CidrBlockState" + }, + "NetworkBorderGroup": { + "shape": "String", + "documentation": "The name of the location from which we advertise the IPV6 CIDR block.
", + "locationName": "networkBorderGroup" } }, "documentation": "Describes an IPv6 CIDR block associated with a VPC.
" @@ -35795,6 +38287,11 @@ "VpnConnectionOptions": { "type": "structure", "members": { + "EnableAcceleration": { + "shape": "Boolean", + "documentation": "Indicates whether acceleration is enabled for the VPN connection.
", + "locationName": "enableAcceleration" + }, "StaticRoutesOnly": { "shape": "Boolean", "documentation": "Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.
", @@ -35811,6 +38308,10 @@ "VpnConnectionOptionsSpecification": { "type": "structure", "members": { + "EnableAcceleration": { + "shape": "Boolean", + "documentation": "Indicate whether to enable acceleration for the VPN connection.
Default: false
Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true
. Use CreateVpnConnectionRoute to create a static route.
Default: false
Creates a new capacity provider. Capacity providers are associated with an Amazon ECS cluster and are used in capacity provider strategies to facilitate cluster auto scaling.
Only capacity providers using an Auto Scaling group can be created. Amazon ECS tasks on AWS Fargate use the FARGATE
and FARGATE_SPOT
capacity providers which are already created and available to all accounts in Regions supported by AWS Fargate.
Creates a new Amazon ECS cluster. By default, your account receives a default
cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster
action.
When you call the CreateCluster API operation, Amazon ECS attempts to create the service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Creates a new Amazon ECS cluster. By default, your account receives a default
cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster
action.
When you call the CreateCluster API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account so that required resources in other AWS services can be managed on your behalf. However, if the IAM user that makes the call does not have permissions to create the service-linked role, it is not created. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Deletes the specified cluster. You must deregister all container instances from this cluster before you may delete it. You can list the container instances in a cluster with ListContainerInstances and deregister them with DeregisterContainerInstance.
" @@ -338,6 +369,31 @@ ], "documentation": "Deregisters the specified task definition by family and revision. Upon deregistration, the task definition is marked as INACTIVE
. Existing tasks and services that reference an INACTIVE
task definition continue to run without disruption. Existing services that reference an INACTIVE
task definition can still scale up or down by modifying the service's desired count.
You cannot use an INACTIVE
task definition to run new tasks or create new services, and you cannot update an existing service to reference an INACTIVE
task definition. However, there may be up to a 10-minute window following deregistration where these restrictions have not yet taken effect.
At this time, INACTIVE
task definitions remain discoverable in your account indefinitely. However, this behavior is subject to change in the future, so you should not rely on INACTIVE
task definitions persisting beyond the lifecycle of any associated tasks and services.
Describes one or more of your capacity providers.
" + }, "DescribeClusters": { "name": "DescribeClusters", "http": { @@ -849,6 +905,40 @@ ], "documentation": "Create or update an attribute on an Amazon ECS resource. If the attribute does not exist, it is created. If the attribute exists, its value is replaced with the specified value. To delete an attribute, use DeleteAttributes. For more information, see Attributes in the Amazon Elastic Container Service Developer Guide.
" }, + "PutClusterCapacityProviders": { + "name": "PutClusterCapacityProviders", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "PutClusterCapacityProvidersRequest" + }, + "output": { + "shape": "PutClusterCapacityProvidersResponse" + }, + "errors": [ + { + "shape": "ServerException" + }, + { + "shape": "ClientException" + }, + { + "shape": "InvalidParameterException" + }, + { + "shape": "ClusterNotFoundException" + }, + { + "shape": "ResourceInUseException" + }, + { + "shape": "UpdateInProgressException" + } + ], + "documentation": "Modifies the available capacity providers and the default capacity provider strategy for a cluster.
You must specify both the available capacity providers and a default capacity provider strategy for the cluster. If the specified cluster has existing capacity providers associated with it, you must specify all existing capacity providers in addition to any new ones you want to add. Any existing capacity providers associated with a cluster that are omitted from a PutClusterCapacityProviders API call will be disassociated with the cluster. You can only disassociate an existing capacity provider from a cluster if it's not being used by any existing tasks.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified, then the cluster's default capacity provider strategy is used. It is recommended to define a default capacity provider strategy for your cluster, however you may specify an empty array ([]
) to bypass defining a default strategy.
The Amazon Resource Name (ARN) that identifies the Auto Scaling group.
" + }, + "managedScaling": { + "shape": "ManagedScaling", + "documentation": "The managed scaling settings for the Auto Scaling group capacity provider.
" + }, + "managedTerminationProtection": { + "shape": "ManagedTerminationProtection", + "documentation": "The managed termination protection setting to use for the Auto Scaling group capacity provider. This determines whether the Auto Scaling group has managed termination protection.
When managed termination protection is enabled, Amazon ECS prevents the Amazon EC2 instances in an Auto Scaling group that contain tasks from being terminated during a scale-in action. The Auto Scaling group and each instance in the Auto Scaling group must have instance protection from scale-in actions enabled as well. For more information, see Instance Protection in the AWS Auto Scaling User Guide.
When managed termination protection is disabled, your Amazon EC2 instances are not protected from termination when the Auto Scaling group scales in.
" + } + }, + "documentation": "The details of the Auto Scaling group for the capacity provider.
" + }, "AwsVpcConfiguration": { "type": "structure", "required": [ @@ -1507,6 +1615,93 @@ "type": "integer", "box": true }, + "CapacityProvider": { + "type": "structure", + "members": { + "capacityProviderArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) that identifies the capacity provider.
" + }, + "name": { + "shape": "String", + "documentation": "The name of the capacity provider.
" + }, + "status": { + "shape": "CapacityProviderStatus", + "documentation": "The current status of the capacity provider. Only capacity providers in an ACTIVE
state can be used in a cluster.
The Auto Scaling group settings for the capacity provider.
" + }, + "tags": { + "shape": "Tags", + "documentation": "The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The details of a capacity provider.
" + }, + "CapacityProviderField": { + "type": "string", + "enum": [ + "TAGS" + ] + }, + "CapacityProviderFieldList": { + "type": "list", + "member": { + "shape": "CapacityProviderField" + } + }, + "CapacityProviderStatus": { + "type": "string", + "enum": [ + "ACTIVE" + ] + }, + "CapacityProviderStrategy": { + "type": "list", + "member": { + "shape": "CapacityProviderStrategyItem" + } + }, + "CapacityProviderStrategyItem": { + "type": "structure", + "required": [ + "capacityProvider" + ], + "members": { + "capacityProvider": { + "shape": "String", + "documentation": "The short name or full Amazon Resource Name (ARN) of the capacity provider.
" + }, + "weight": { + "shape": "CapacityProviderStrategyItemWeight", + "documentation": "The weight value designates the relative percentage of the total number of tasks launched that should use the specified capacity provider.
For example, if you have a strategy that contains two capacity providers and both have a weight of 1
, then when the base
is satisfied, the tasks will be split evenly across the two capacity providers. Using that same logic, if you specify a weight of 1
for capacityProviderA and a weight of 4
for capacityProviderB, then for every one task that is run using capacityProviderA, four tasks would use capacityProviderB.
The base value designates how many tasks, at a minimum, to run on the specified capacity provider. Only one capacity provider in a capacity provider strategy can have a base defined.
" + } + }, + "documentation": "The details of a capacity provider strategy.
" + }, + "CapacityProviderStrategyItemBase": { + "type": "integer", + "max": 100000, + "min": 0 + }, + "CapacityProviderStrategyItemWeight": { + "type": "integer", + "max": 1000, + "min": 0 + }, + "CapacityProviders": { + "type": "list", + "member": { + "shape": "CapacityProvider" + } + }, "Cluster": { "type": "structure", "members": { @@ -1549,6 +1744,22 @@ "settings": { "shape": "ClusterSettings", "documentation": "The settings for the cluster. This parameter indicates whether CloudWatch Container Insights is enabled or disabled for a cluster.
" + }, + "capacityProviders": { + "shape": "StringList", + "documentation": "The capacity providers associated with the cluster.
" + }, + "defaultCapacityProviderStrategy": { + "shape": "CapacityProviderStrategy", + "documentation": "The default capacity provider strategy for the cluster. When services or tasks are run in the cluster with no launch type or capacity provider strategy specified, the default capacity provider strategy is used.
" + }, + "attachments": { + "shape": "Attachments", + "documentation": "The resources attached to a cluster. When using a capacity provider with a cluster, the Auto Scaling plan that is created will be returned as a cluster attachment.
" + }, + "attachmentsStatus": { + "shape": "String", + "documentation": "The status of the capacity providers associated with the cluster. The following are the states that will be returned:
The available capacity providers for the cluster are updating. This occurs when the Auto Scaling plan is provisioning or deprovisioning.
The capacity providers have successfully updated.
The capacity provider updates failed.
A regional grouping of one or more container instances on which you can run task requests. Each account receives a default cluster the first time you use the Amazon ECS service, but you may also create other clusters. Clusters may contain more than one instance type simultaneously.
" @@ -1556,6 +1767,8 @@ "ClusterField": { "type": "string", "enum": [ + "ATTACHMENTS", + "SETTINGS", "STATISTICS", "TAGS" ] @@ -1896,6 +2109,10 @@ "shape": "String", "documentation": "The EC2 instance ID of the container instance.
" }, + "capacityProviderName": { + "shape": "String", + "documentation": "The capacity provider associated with the container instance.
" + }, "version": { "shape": "Long", "documentation": "The version counter for the container instance. Every time a container instance experiences a change that triggers a CloudWatch event, the version counter is incremented. If you are replicating your Amazon ECS container instance state with CloudWatch Events, you can compare the version of a container instance reported by the Amazon ECS APIs with the version reported in CloudWatch Events for the container instance (inside the detail
object) to verify that the version in your event stream is current.
The name of the capacity provider. Up to 255 characters are allowed, including letters (upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed with \"aws
\", \"ecs
\", or \"fargate
\".
The details of the Auto Scaling group for the capacity provider.
" + }, + "tags": { + "shape": "Tags", + "documentation": "The metadata that you apply to the capacity provider to help you categorize and organize them. Each tag consists of a key and an optional value, both of which you define.
The following basic restrictions apply to tags:
Maximum number of tags per resource - 50
For each resource, each tag key must be unique, and each tag key can have only one value.
Maximum key length - 128 Unicode characters in UTF-8
Maximum value length - 256 Unicode characters in UTF-8
If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.
Tag keys and values are case-sensitive.
Do not use aws:
, AWS:
, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for AWS use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.
The full description of the new capacity provider.
" + } + } + }, "CreateClusterRequest": { "type": "structure", "members": { @@ -2083,6 +2330,14 @@ "settings": { "shape": "ClusterSettings", "documentation": "The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it will override the containerInsights
value set with PutAccountSetting or PutAccountSettingDefault.
The short name or full Amazon Resource Name (ARN) of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" + }, + "defaultCapacityProviderStrategy": { + "shape": "CapacityProviderStrategy", + "documentation": "The capacity provider strategy to use by default for the cluster.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.
A capacity provider strategy consists of one or more capacity providers along with the base
and weight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE
or UPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
" } } }, @@ -2131,7 +2386,11 @@ }, "launchType": { "shape": "LaunchType", - "documentation": "The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
" + "documentation": "The launch type on which to run your service. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
If a launchType
is specified, the capacityProviderStrategy
parameter must be omitted.
The capacity provider strategy to use for the service.
A capacity provider strategy consists of one or more capacity providers along with the base
and weight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE
or UPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted. If no capacityProviderStrategy
or launchType
is specified, the defaultCapacityProviderStrategy
for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" }, "platformVersion": { "shape": "String", @@ -2139,7 +2398,7 @@ }, "role": { "shape": "String", - "documentation": "The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc
network mode. If you specify the role
parameter, you must also specify a load balancer object with the loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc
network mode or if the service is configured to use service discovery, an external deployment controller, or multiple target groups in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar
has a path of /foo/
then you would specify /foo/bar
as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.
The name or full Amazon Resource Name (ARN) of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is only permitted if you are using a load balancer with your service and your task definition does not use the awsvpc
network mode. If you specify the role
parameter, you must also specify a load balancer object with the loadBalancers
parameter.
If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here. The service-linked role is required if your task definition uses the awsvpc
network mode or if the service is configured to use service discovery, an external deployment controller, multiple target groups, or Elastic Inference accelerators in which case you should not specify a role here. For more information, see Using Service-Linked Roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
If your specified role has a path other than /
, then you must either specify the full role ARN (this is recommended) or prefix the role name with the path. For example, if a role with the name bar
has a path of /foo/
then you would specify /foo/bar
as the role name. For more information, see Friendly Names and Paths in the IAM User Guide.
The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
" + "documentation": "The launch type that new tasks in the task set will use. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
If a launchType
is specified, the capacityProviderStrategy
parameter must be omitted.
The capacity provider strategy to use for the task set.
A capacity provider strategy consists of one or more capacity providers along with the base
and weight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE
or UPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted. If no capacityProviderStrategy
or launchType
is specified, the defaultCapacityProviderStrategy
for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" }, "platformVersion": { "shape": "String", @@ -2421,6 +2684,10 @@ "shape": "Timestamp", "documentation": "The Unix timestamp for when the service deployment was last updated.
" }, + "capacityProviderStrategy": { + "shape": "CapacityProviderStrategy", + "documentation": "The capacity provider strategy that the deployment is using.
" + }, "launchType": { "shape": "LaunchType", "documentation": "The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
" @@ -2527,6 +2794,44 @@ } } }, + "DescribeCapacityProvidersRequest": { + "type": "structure", + "members": { + "capacityProviders": { + "shape": "StringList", + "documentation": "The short name or full Amazon Resource Name (ARN) of one or more capacity providers. Up to 100
capacity providers can be described in an action.
Specifies whether or not you want to see the resource tags for the capacity provider. If TAGS
is specified, the tags are included in the response. If this field is omitted, tags are not included in the response.
The maximum number of account setting results returned by DescribeCapacityProviders
in paginated output. When this parameter is used, DescribeCapacityProviders
only returns maxResults
results in a single page along with a nextToken
response element. The remaining results of the initial request can be seen by sending another DescribeCapacityProviders
request with the returned nextToken
value. This value can be between 1 and 10. If this parameter is not used, then DescribeCapacityProviders
returns up to 10 results and a nextToken
value if applicable.
The nextToken
value returned from a previous paginated DescribeCapacityProviders
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
The list of capacity providers.
" + }, + "failures": { + "shape": "Failures", + "documentation": "Any failures associated with the call.
" + }, + "nextToken": { + "shape": "String", + "documentation": "The nextToken
value to include in a future DescribeCapacityProviders
request. When the results of a DescribeCapacityProviders
request exceed maxResults
, this value can be used to retrieve the next page of results. This value is null
when there are no more results to return.
Additional information about your clusters to be separated by launch type, including:
runningEC2TasksCount
runningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
Whether to include additional information about your clusters in the response. If this field is omitted, the attachments, statistics, and tags are not included.
If ATTACHMENTS
is specified, the attachments for the container instances or tasks within the cluster are included.
If SETTINGS
is specified, the settings for the cluster are included.
If STATISTICS
is specified, the following additional information, separated by launch type, is included:
runningEC2TasksCount
runningFargateTasksCount
pendingEC2TasksCount
pendingFargateTasksCount
activeEC2ServiceCount
activeFargateServiceCount
drainingEC2ServiceCount
drainingFargateServiceCount
If TAGS
is specified, the metadata tags associated with the cluster are included.
The options to use when configuring the log router. This field is optional and can be used to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is \"options\":{\"enable-ecs-log-metadata\":\"true|false\"}
.
The options to use when configuring the log router. This field is optional and can be used to specify a custom configuration file or to add additional metadata, such as the task, task definition, cluster, and container instance details to the log event. If specified, the syntax to use is \"options\":{\"enable-ecs-log-metadata\":\"true|false\",\"config-file-type:\"s3|file\",\"config-file-value\":\"arn:aws:s3:::mybucket/fluent.conf|filepath\"}
. For more information, see Creating a Task Definition that Uses a FireLens Configuration in the Amazon Elastic Container Service Developer Guide.
The FireLens configuration for the container. This is used to specify and configure a log router for container logs. For more information, see Custom Log Routing in the Amazon Elastic Container Service Developer Guide.
" @@ -3502,6 +3807,52 @@ "Long": { "type": "long" }, + "ManagedScaling": { + "type": "structure", + "members": { + "status": { + "shape": "ManagedScalingStatus", + "documentation": "Whether or not to enable managed scaling for the capacity provider.
" + }, + "targetCapacity": { + "shape": "ManagedScalingTargetCapacity", + "documentation": "The target capacity value for the capacity provider. The specified value must be greater than 0
and less than or equal to 100
. A value of 100
will result in the Amazon EC2 instances in your Auto Scaling group being completely utilized.
The minimum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 1
is used.
The maximum number of container instances that Amazon ECS will scale in or scale out at one time. If this parameter is omitted, the default value of 10000
is used.
The managed scaling settings for the Auto Scaling group capacity provider.
When managed scaling is enabled, Amazon ECS manages the scale-in and scale-out actions of the Auto Scaling group. Amazon ECS manages a target tracking scaling policy using an Amazon ECS-managed CloudWatch metric with the specified targetCapacity
value as the target value for the metric. For more information, see Using Managed Scaling in the Amazon Elastic Container Service Developer Guide.
If managed scaling is disabled, the user must manage the scaling of the Auto Scaling group.
" + }, + "ManagedScalingStatus": { + "type": "string", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, + "ManagedScalingStepSize": { + "type": "integer", + "max": 10000, + "min": 1 + }, + "ManagedScalingTargetCapacity": { + "type": "integer", + "max": 100, + "min": 1 + }, + "ManagedTerminationProtection": { + "type": "string", + "enum": [ + "ENABLED", + "DISABLED" + ] + }, "MountPoint": { "type": "structure", "members": { @@ -3833,6 +4184,36 @@ } } }, + "PutClusterCapacityProvidersRequest": { + "type": "structure", + "required": [ + "cluster", + "capacityProviders", + "defaultCapacityProviderStrategy" + ], + "members": { + "cluster": { + "shape": "String", + "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you do not specify a cluster, the default cluster is assumed.
" + }, + "capacityProviders": { + "shape": "StringList", + "documentation": "The short name or full Amazon Resource Name (ARN) of one or more capacity providers to associate with the cluster.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The capacity provider strategy to use by default for the cluster.
When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.
A capacity provider strategy consists of one or more capacity providers along with the base
and weight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE
or UPDATING
status can be used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The capacity provider strategy to use for the task.
A capacity provider strategy consists of one or more capacity providers along with the base
and weight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE
or UPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted. If no capacityProviderStrategy
or launchType
is specified, the defaultCapacityProviderStrategy
for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The AWS Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
" + }, "cluster": { "shape": "String", "documentation": "The short name or full Amazon Resource Name (ARN) of the cluster on which to run your task. If you do not specify a cluster, the default cluster is assumed.
" @@ -4074,7 +4459,7 @@ }, "launchType": { "shape": "LaunchType", - "documentation": "The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
" + "documentation": "The launch type on which to run your task. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
If a launchType
is specified, the capacityProviderStrategy
parameter must be omitted.
The launch type on which your service is running. If no value is specified, it will default to EC2
. Valid values include EC2
and FARGATE
. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
The capacity provider strategy associated with the service.
" + }, "platformVersion": { "shape": "String", "documentation": "The platform version on which to run your service. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
" + "documentation": "The Amazon Resource Name (ARN) of the resource to which to add tags. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
" }, "tags": { "shape": "Tags", @@ -4767,6 +5156,10 @@ "shape": "String", "documentation": "The availability zone of the task.
" }, + "capacityProviderName": { + "shape": "String", + "documentation": "The capacity provider associated with the task.
" + }, "clusterArn": { "shape": "String", "documentation": "The ARN of the cluster that hosts the task.
" @@ -5122,6 +5515,10 @@ "shape": "LaunchType", "documentation": "The launch type the tasks in the task set are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
" }, + "capacityProviderStrategy": { + "shape": "CapacityProviderStrategy", + "documentation": "The capacity provider strategy associated with the task set.
" + }, "platformVersion": { "shape": "String", "documentation": "The platform version on which the tasks in the task set are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS tasks, services, task definitions, clusters, and container instances.
" + "documentation": "The Amazon Resource Name (ARN) of the resource from which to delete tags. Currently, the supported resources are Amazon ECS capacity providers, tasks, services, task definitions, clusters, and container instances.
" }, "tagKeys": { "shape": "TagKeys", @@ -5417,17 +5814,20 @@ "shape": "String", "documentation": "The family
and revision
(family:revision
) or full ARN of the task definition to run in your service. If a revision
is not specified, the latest ACTIVE
revision is used. If you modify the task definition with UpdateService
, Amazon ECS spawns a task with the new version of the task definition and then stops an old task after the new version is running.
The capacity provider strategy to update the service to use.
If the service is using the default capacity provider strategy for the cluster, the service can be updated to use one or more capacity providers. However, when a service is using a non-default capacity provider strategy, the service cannot be updated to use the cluster's default capacity provider strategy.
" + }, "deploymentConfiguration": { "shape": "DeploymentConfiguration", "documentation": "Optional deployment parameters that control how many tasks run during the deployment and the ordering of stopping and starting tasks.
" }, "networkConfiguration": { - "shape": "NetworkConfiguration", - "documentation": "The network configuration for the service. This parameter is required for task definitions that use the awsvpc
network mode to receive their own elastic network interface, and it is not supported for other network modes. For more information, see Task Networking in the Amazon Elastic Container Service Developer Guide.
Updating a service to add a subnet to a list of existing subnets does not trigger a service deployment. For example, if your network configuration change is to keep the existing subnets and simply add another subnet to the network configuration, this does not trigger a new service deployment.
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If one is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The platform version on which your tasks in the service are running. A platform version is only specified for tasks using the Fargate launch type. If a platform version is not specified, the LATEST
platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
" + "documentation": "The period of time, in seconds, that the Amazon ECS service scheduler should ignore unhealthy Elastic Load Balancing target health checks after a task has first started. This is only valid if your service is configured to use a load balancer. If your service's tasks take a while to start and respond to Elastic Load Balancing health checks, you can specify a health check grace period of up to 2,147,483,647 seconds. During that time, the Amazon ECS service scheduler ignores the Elastic Load Balancing health check status. This grace period can prevent the ECS service scheduler from marking tasks as unhealthy and stopping them before they have time to come up.
" } } }, diff --git a/apis/ecs-2014-11-13.paginators.json b/apis/ecs-2014-11-13.paginators.json index 46cea2a6f4..10b471968e 100644 --- a/apis/ecs-2014-11-13.paginators.json +++ b/apis/ecs-2014-11-13.paginators.json @@ -1,5 +1,11 @@ { "pagination": { + "ListAttributes": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "attributes" + }, "ListClusters": { "input_token": "nextToken", "limit_key": "maxResults", diff --git a/apis/eks-2017-11-01.min.json b/apis/eks-2017-11-01.min.json index a170ead87f..33d9da3dc5 100644 --- a/apis/eks-2017-11-01.min.json +++ b/apis/eks-2017-11-01.min.json @@ -51,6 +51,47 @@ } } }, + "CreateFargateProfile": { + "http": { + "requestUri": "/clusters/{name}/fargate-profiles" + }, + "input": { + "type": "structure", + "required": [ + "fargateProfileName", + "clusterName", + "podExecutionRoleArn" + ], + "members": { + "fargateProfileName": {}, + "clusterName": { + "location": "uri", + "locationName": "name" + }, + "podExecutionRoleArn": {}, + "subnets": { + "shape": "S5" + }, + "selectors": { + "shape": "Sp" + }, + "clientRequestToken": { + "idempotencyToken": true + }, + "tags": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "members": { + "fargateProfile": { + "shape": "St" + } + } + } + }, "CreateNodegroup": { "http": { "requestUri": "/clusters/{name}/node-groups" @@ -70,7 +111,7 @@ }, "nodegroupName": {}, "scalingConfig": { - "shape": "Sp" + "shape": "Sw" }, "diskSize": { "type": "integer" @@ -83,11 +124,11 @@ }, "amiType": {}, "remoteAccess": { - "shape": "St" + "shape": "S10" }, "nodeRole": {}, "labels": { - "shape": "Su" + "shape": "S11" }, "tags": { "shape": "Sc" @@ -103,7 +144,7 @@ "type": "structure", "members": { "nodegroup": { - "shape": "Sy" + "shape": "S15" } } } @@ -134,6 +175,37 @@ } } }, + "DeleteFargateProfile": { + "http": { + "method": "DELETE", + "requestUri": "/clusters/{name}/fargate-profiles/{fargateProfileName}" + }, + "input": { + "type": "structure", + "required": [ + "clusterName", + "fargateProfileName" + ], + "members": { + "clusterName": { + "location": "uri", + "locationName": "name" + }, + "fargateProfileName": { + "location": "uri", + "locationName": "fargateProfileName" + } + } + }, + "output": { + "type": "structure", + "members": { + "fargateProfile": { + "shape": "St" + } + } + } + }, "DeleteNodegroup": { "http": { "method": "DELETE", @@ -160,7 +232,7 @@ "type": "structure", "members": { "nodegroup": { - "shape": "Sy" + "shape": "S15" } } } @@ -191,6 +263,37 @@ } } }, + "DescribeFargateProfile": { + "http": { + "method": "GET", + "requestUri": "/clusters/{name}/fargate-profiles/{fargateProfileName}" + }, + "input": { + "type": "structure", + "required": [ + "clusterName", + "fargateProfileName" + ], + "members": { + "clusterName": { + "location": "uri", + "locationName": "name" + }, + "fargateProfileName": { + "location": "uri", + "locationName": "fargateProfileName" + } + } + }, + "output": { + "type": "structure", + "members": { + "fargateProfile": { + "shape": "St" + } + } + } + }, "DescribeNodegroup": { "http": { "method": "GET", @@ -217,7 +320,7 @@ "type": "structure", "members": { "nodegroup": { - "shape": "Sy" + "shape": "S15" } } } @@ -252,7 +355,7 @@ "type": "structure", "members": { "update": { - "shape": "S1h" + "shape": "S1s" } } } @@ -286,6 +389,42 @@ } } }, + "ListFargateProfiles": { + "http": { + "method": "GET", + "requestUri": "/clusters/{name}/fargate-profiles" + }, + "input": { + "type": "structure", + "required": [ + "clusterName" + ], + "members": { + "clusterName": { + "location": "uri", + "locationName": "name" + }, + "maxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "nextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "fargateProfileNames": { + "shape": "S5" + }, + "nextToken": {} + } + } + }, "ListNodegroups": { "http": { "method": "GET", @@ -471,7 +610,7 @@ "type": "structure", "members": { "update": { - "shape": "S1h" + "shape": "S1s" } } } @@ -501,7 +640,7 @@ "type": "structure", "members": { "update": { - "shape": "S1h" + "shape": "S1s" } } } @@ -529,7 +668,7 @@ "type": "structure", "members": { "addOrUpdateLabels": { - "shape": "Su" + "shape": "S11" }, "removeLabels": { "type": "list", @@ -538,7 +677,7 @@ } }, "scalingConfig": { - "shape": "Sp" + "shape": "Sw" }, "clientRequestToken": { "idempotencyToken": true @@ -549,7 +688,7 @@ "type": "structure", "members": { "update": { - "shape": "S1h" + "shape": "S1s" } } } @@ -587,7 +726,7 @@ "type": "structure", "members": { "update": { - "shape": "S1h" + "shape": "S1s" } } } @@ -699,6 +838,42 @@ } }, "Sp": { + "type": "list", + "member": { + "type": "structure", + "members": { + "namespace": {}, + "labels": { + "type": "map", + "key": {}, + "value": {} + } + } + } + }, + "St": { + "type": "structure", + "members": { + "fargateProfileName": {}, + "fargateProfileArn": {}, + "clusterName": {}, + "createdAt": { + "type": "timestamp" + }, + "podExecutionRoleArn": {}, + "subnets": { + "shape": "S5" + }, + "selectors": { + "shape": "Sp" + }, + "status": {}, + "tags": { + "shape": "Sc" + } + } + }, + "Sw": { "type": "structure", "members": { "minSize": { @@ -712,7 +887,7 @@ } } }, - "St": { + "S10": { "type": "structure", "members": { "ec2SshKey": {}, @@ -721,12 +896,12 @@ } } }, - "Su": { + "S11": { "type": "map", "key": {}, "value": {} }, - "Sy": { + "S15": { "type": "structure", "members": { "nodegroupName": {}, @@ -742,7 +917,7 @@ }, "status": {}, "scalingConfig": { - "shape": "Sp" + "shape": "Sw" }, "instanceTypes": { "shape": "S5" @@ -751,12 +926,12 @@ "shape": "S5" }, "remoteAccess": { - "shape": "St" + "shape": "S10" }, "amiType": {}, "nodeRole": {}, "labels": { - "shape": "Su" + "shape": "S11" }, "resources": { "type": "structure", @@ -799,7 +974,7 @@ } } }, - "S1h": { + "S1s": { "type": "structure", "members": { "id": {}, diff --git a/apis/eks-2017-11-01.normal.json b/apis/eks-2017-11-01.normal.json index 8584c2c43d..5c9d62134e 100644 --- a/apis/eks-2017-11-01.normal.json +++ b/apis/eks-2017-11-01.normal.json @@ -50,6 +50,40 @@ ], "documentation": "Creates an Amazon EKS control plane.
The Amazon EKS control plane consists of control plane instances that run the Kubernetes software, such as etcd
and the API server. The control plane runs in an account managed by AWS, and the Kubernetes API is exposed via the Amazon EKS API server endpoint. Each Amazon EKS cluster control plane is single-tenant and unique and runs on its own set of Amazon EC2 instances.
The cluster control plane is provisioned across multiple Availability Zones and fronted by an Elastic Load Balancing Network Load Balancer. Amazon EKS also provisions elastic network interfaces in your VPC subnets to provide connectivity from the control plane instances to the worker nodes (for example, to support kubectl exec
, logs
, and proxy
data flows).
Amazon EKS worker nodes run in your AWS account and connect to your cluster's control plane via the Kubernetes API server endpoint and a certificate file that is created for your cluster.
You can use the endpointPublicAccess
and endpointPrivateAccess
parameters to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS Cluster Endpoint Access Control in the Amazon EKS User Guide .
You can use the logging
parameter to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster Control Plane Logs in the Amazon EKS User Guide .
CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see Amazon CloudWatch Pricing.
Cluster creation typically takes between 10 and 15 minutes. After you create an Amazon EKS cluster, you must configure your Kubernetes tooling to communicate with the API server and launch worker nodes into your cluster. For more information, see Managing Cluster Authentication and Launching Amazon EKS Worker Nodes in the Amazon EKS User Guide.
" }, + "CreateFargateProfile": { + "name": "CreateFargateProfile", + "http": { + "method": "POST", + "requestUri": "/clusters/{name}/fargate-profiles" + }, + "input": { + "shape": "CreateFargateProfileRequest" + }, + "output": { + "shape": "CreateFargateProfileResponse" + }, + "errors": [ + { + "shape": "InvalidParameterException" + }, + { + "shape": "InvalidRequestException" + }, + { + "shape": "ClientException" + }, + { + "shape": "ServerException" + }, + { + "shape": "ResourceLimitExceededException" + }, + { + "shape": "UnsupportedAvailabilityZoneException" + } + ], + "documentation": "Creates an AWS Fargate profile for your Amazon EKS cluster. You must have at least one Fargate profile in a cluster to be able to schedule pods on Fargate infrastructure.
The Fargate profile allows an administrator to declare which pods run on Fargate infrastructure and specify which pods run on which Fargate profile. This declaration is done through the profile’s selectors. Each profile can have up to five selectors that contain a namespace and labels. A namespace is required for every selector. The label field consists of multiple optional key-value pairs. Pods that match the selectors are scheduled on Fargate infrastructure. If a to-be-scheduled pod matches any of the selectors in the Fargate profile, then that pod is scheduled on Fargate infrastructure.
When you create a Fargate profile, you must specify a pod execution role to use with the pods that are scheduled with the profile. This role is added to the cluster's Kubernetes Role Based Access Control (RBAC) for authorization so that the kubelet
that is running on the Fargate infrastructure can register with your Amazon EKS cluster. This role is what allows Fargate infrastructure to appear in your cluster as nodes. The pod execution role also provides IAM permissions to the Fargate infrastructure to allow read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide.
Fargate profiles are immutable. However, you can create a new updated profile to replace an existing profile and then delete the original after the updated profile has finished creating.
If any Fargate profiles in a cluster are in the DELETING
status, you must wait for that Fargate profile to finish deleting before you can create any other profiles in that cluster.
For more information, see AWS Fargate Profile in the Amazon EKS User Guide.
" + }, "CreateNodegroup": { "name": "CreateNodegroup", "http": { @@ -116,7 +150,35 @@ "shape": "ServiceUnavailableException" } ], - "documentation": "Deletes the Amazon EKS cluster control plane.
If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide.
If you have managed node groups attached to the cluster, you must delete them first. For more information, see DeleteNodegroup.
" + "documentation": "Deletes the Amazon EKS cluster control plane.
If you have active services in your cluster that are associated with a load balancer, you must delete those services before deleting the cluster so that the load balancers are deleted properly. Otherwise, you can have orphaned resources in your VPC that prevent you from being able to delete the VPC. For more information, see Deleting a Cluster in the Amazon EKS User Guide.
If you have managed node groups or Fargate profiles attached to the cluster, you must delete them first. For more information, see DeleteNodegroup andDeleteFargateProfile.
" + }, + "DeleteFargateProfile": { + "name": "DeleteFargateProfile", + "http": { + "method": "DELETE", + "requestUri": "/clusters/{name}/fargate-profiles/{fargateProfileName}" + }, + "input": { + "shape": "DeleteFargateProfileRequest" + }, + "output": { + "shape": "DeleteFargateProfileResponse" + }, + "errors": [ + { + "shape": "InvalidParameterException" + }, + { + "shape": "ClientException" + }, + { + "shape": "ServerException" + }, + { + "shape": "ResourceNotFoundException" + } + ], + "documentation": "Deletes an AWS Fargate profile.
When you delete a Fargate profile, any pods that were scheduled onto Fargate infrastructure with the profile are deleted. If those pods match another Fargate profile, then they are scheduled on Fargate infrastructure with that profile. If they no longer match any Fargate profiles, then they are not scheduled on Fargate infrastructure.
Only one Fargate profile in a cluster can be in the DELETING
status at a time. You must wait for a Fargate profile to finish deleting before you can delete any other profiles in that cluster.
Returns descriptive information about an Amazon EKS cluster.
The API server endpoint and certificate authority data returned by this operation are required for kubelet
and kubectl
to communicate with your Kubernetes API server. For more information, see Create a kubeconfig for Amazon EKS.
The API server endpoint and certificate authority data aren't available until the cluster reaches the ACTIVE
state.
Returns descriptive information about an AWS Fargate profile.
" + }, "DescribeNodegroup": { "name": "DescribeNodegroup", "http": { @@ -267,6 +357,34 @@ ], "documentation": "Lists the Amazon EKS clusters in your AWS account in the specified Region.
" }, + "ListFargateProfiles": { + "name": "ListFargateProfiles", + "http": { + "method": "GET", + "requestUri": "/clusters/{name}/fargate-profiles" + }, + "input": { + "shape": "ListFargateProfilesRequest" + }, + "output": { + "shape": "ListFargateProfilesResponse" + }, + "errors": [ + { + "shape": "InvalidParameterException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ClientException" + }, + { + "shape": "ServerException" + } + ], + "documentation": "Lists the AWS Fargate profiles associated with the specified cluster in your AWS account in the specified Region.
" + }, "ListNodegroups": { "name": "ListNodegroups", "http": { @@ -542,10 +660,10 @@ "members": { "name": { "shape": "String", - "documentation": "The name of the AutoScaling group associated with an Amazon EKS managed node group.
" + "documentation": "The name of the Auto Scaling group associated with an Amazon EKS managed node group.
" } }, - "documentation": "An AutoScaling group that is associated with an Amazon EKS managed node group.
" + "documentation": "An Auto Scaling group that is associated with an Amazon EKS managed node group.
" }, "AutoScalingGroupList": { "type": "list", @@ -705,6 +823,56 @@ } } }, + "CreateFargateProfileRequest": { + "type": "structure", + "required": [ + "fargateProfileName", + "clusterName", + "podExecutionRoleArn" + ], + "members": { + "fargateProfileName": { + "shape": "String", + "documentation": "The name of the Fargate profile.
" + }, + "clusterName": { + "shape": "String", + "documentation": "The name of the Amazon EKS cluster to apply the Fargate profile to.
", + "location": "uri", + "locationName": "name" + }, + "podExecutionRoleArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. The pod execution role allows Fargate infrastructure to register with your cluster as a node, and it provides read access to Amazon ECR image repositories. For more information, see Pod Execution Role in the Amazon EKS User Guide.
" + }, + "subnets": { + "shape": "StringList", + "documentation": "The IDs of subnets to launch Fargate pods into. At this time, Fargate pods are not assigned public IP addresses, so only private subnets (with no direct route to an Internet Gateway) are accepted for this parameter.
" + }, + "selectors": { + "shape": "FargateProfileSelectors", + "documentation": "The selectors to match for pods to use this Fargate profile. Each selector must have an associated namespace. Optionally, you can also specify labels for a namespace. You may specify up to five selectors in a Fargate profile.
" + }, + "clientRequestToken": { + "shape": "String", + "documentation": "Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "idempotencyToken": true + }, + "tags": { + "shape": "TagMap", + "documentation": "The metadata to apply to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.
" + } + } + }, + "CreateFargateProfileResponse": { + "type": "structure", + "members": { + "fargateProfile": { + "shape": "FargateProfile", + "documentation": "The full description of your new Fargate profile.
" + } + } + }, "CreateNodegroupRequest": { "type": "structure", "required": [ @@ -726,7 +894,7 @@ }, "scalingConfig": { "shape": "NodegroupScalingConfig", - "documentation": "The scaling configuration details for the AutoScaling group that is created for your node group.
" + "documentation": "The scaling configuration details for the Auto Scaling group that is created for your node group.
" }, "diskSize": { "shape": "BoxedInteger", @@ -734,7 +902,7 @@ }, "subnets": { "shape": "StringList", - "documentation": "The subnets to use for the AutoScaling group that is created for your node group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME
with a value of shared
, where CLUSTER_NAME
is replaced with the name of your cluster.
The subnets to use for the Auto Scaling group that is created for your node group. These subnets must have the tag key kubernetes.io/cluster/CLUSTER_NAME
with a value of shared
, where CLUSTER_NAME
is replaced with the name of your cluster.
The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU
AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support; non-GPU instances should use the AL2_x86_64
AMI type, which uses the Amazon EKS-optimized Linux AMI.
The AMI type for your node group. GPU instance types should use the AL2_x86_64_GPU
AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the AL2_x86_64
AMI type, which uses the Amazon EKS-optimized Linux AMI.
The name of the Amazon EKS cluster associated with the Fargate profile to delete.
", + "location": "uri", + "locationName": "name" + }, + "fargateProfileName": { + "shape": "String", + "documentation": "The name of the Fargate profile to delete.
", + "location": "uri", + "locationName": "fargateProfileName" + } + } + }, + "DeleteFargateProfileResponse": { + "type": "structure", + "members": { + "fargateProfile": { + "shape": "FargateProfile", + "documentation": "The deleted Fargate profile.
" + } + } + }, "DeleteNodegroupRequest": { "type": "structure", "required": [ @@ -860,6 +1058,36 @@ } } }, + "DescribeFargateProfileRequest": { + "type": "structure", + "required": [ + "clusterName", + "fargateProfileName" + ], + "members": { + "clusterName": { + "shape": "String", + "documentation": "The name of the Amazon EKS cluster associated with the Fargate profile.
", + "location": "uri", + "locationName": "name" + }, + "fargateProfileName": { + "shape": "String", + "documentation": "The name of the Fargate profile to describe.
", + "location": "uri", + "locationName": "fargateProfileName" + } + } + }, + "DescribeFargateProfileResponse": { + "type": "structure", + "members": { + "fargateProfile": { + "shape": "FargateProfile", + "documentation": "The full description of your Fargate profile.
" + } + } + }, "DescribeNodegroupRequest": { "type": "structure", "required": [ @@ -966,6 +1194,93 @@ "shape": "ErrorDetail" } }, + "FargateProfile": { + "type": "structure", + "members": { + "fargateProfileName": { + "shape": "String", + "documentation": "The name of the Fargate profile.
" + }, + "fargateProfileArn": { + "shape": "String", + "documentation": "The full Amazon Resource Name (ARN) of the Fargate profile.
" + }, + "clusterName": { + "shape": "String", + "documentation": "The name of the Amazon EKS cluster that the Fargate profile belongs to.
" + }, + "createdAt": { + "shape": "Timestamp", + "documentation": "The Unix epoch timestamp in seconds for when the Fargate profile was created.
" + }, + "podExecutionRoleArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the pod execution role to use for pods that match the selectors in the Fargate profile. For more information, see Pod Execution Role in the Amazon EKS User Guide.
" + }, + "subnets": { + "shape": "StringList", + "documentation": "The IDs of subnets to launch Fargate pods into.
" + }, + "selectors": { + "shape": "FargateProfileSelectors", + "documentation": "The selectors to match for pods to use this Fargate profile.
" + }, + "status": { + "shape": "FargateProfileStatus", + "documentation": "The current status of the Fargate profile.
" + }, + "tags": { + "shape": "TagMap", + "documentation": "The metadata applied to the Fargate profile to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Fargate profile tags do not propagate to any other resources associated with the Fargate profile, such as the pods that are scheduled with it.
" + } + }, + "documentation": "An object representing an AWS Fargate profile.
" + }, + "FargateProfileLabel": { + "type": "map", + "key": { + "shape": "String" + }, + "value": { + "shape": "String" + } + }, + "FargateProfileSelector": { + "type": "structure", + "members": { + "namespace": { + "shape": "String", + "documentation": "The Kubernetes namespace that the selector should match.
" + }, + "labels": { + "shape": "FargateProfileLabel", + "documentation": "The Kubernetes labels that the selector should match. A pod must contain all of the labels that are specified in the selector for it to be considered a match.
" + } + }, + "documentation": "An object representing an AWS Fargate profile selector.
" + }, + "FargateProfileSelectors": { + "type": "list", + "member": { + "shape": "FargateProfileSelector" + } + }, + "FargateProfileStatus": { + "type": "string", + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "CREATE_FAILED", + "DELETE_FAILED" + ] + }, + "FargateProfilesRequestMaxResults": { + "type": "integer", + "box": true, + "max": 100, + "min": 1 + }, "Identity": { "type": "structure", "members": { @@ -981,7 +1296,7 @@ "members": { "code": { "shape": "NodegroupIssueCode", - "documentation": "A brief description of the error.
AutoScalingGroupNotFound: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover.
Ec2SecurityGroupNotFound: We couldn't find the cluster security group for the cluster. You must recreate your cluster.
Ec2SecurityGroupDeletionFailure: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group.
Ec2LaunchTemplateNotFound: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover.
Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the Amazon EKS-created version to recover.
IamInstanceProfileNotFound: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover.
IamNodeRoleNotFound: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover.
AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch instances.
InstanceLimitExceeded: Your AWS account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover.
InsufficientFreeAddresses: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes.
AccessDenied: Amazon EKS and or one or more of your managed nodes is unable to communicate with your cluster API server.
InternalFailure: These errors are usually caused by an Amazon EKS server-side issue.
A brief description of the error.
AutoScalingGroupNotFound: We couldn't find the Auto Scaling group associated with the managed node group. You may be able to recreate an Auto Scaling group with the same settings to recover.
Ec2SecurityGroupNotFound: We couldn't find the cluster security group for the cluster. You must recreate your cluster.
Ec2SecurityGroupDeletionFailure: We could not delete the remote access security group for your managed node group. Remove any dependencies from the security group.
Ec2LaunchTemplateNotFound: We couldn't find the Amazon EC2 launch template for your managed node group. You may be able to recreate a launch template with the same settings to recover.
Ec2LaunchTemplateVersionMismatch: The Amazon EC2 launch template version for your managed node group does not match the version that Amazon EKS created. You may be able to revert to the version that Amazon EKS created to recover.
IamInstanceProfileNotFound: We couldn't find the IAM instance profile for your managed node group. You may be able to recreate an instance profile with the same settings to recover.
IamNodeRoleNotFound: We couldn't find the IAM role for your managed node group. You may be able to recreate an IAM role with the same settings to recover.
AsgInstanceLaunchFailures: Your Auto Scaling group is experiencing failures while attempting to launch instances.
NodeCreationFailure: Your launched instances are unable to register with your Amazon EKS cluster. Common causes of this failure are insufficient worker node IAM role permissions or lack of outbound internet access for the nodes.
InstanceLimitExceeded: Your AWS account is unable to launch any more instances of the specified instance type. You may be able to request an Amazon EC2 instance limit increase to recover.
InsufficientFreeAddresses: One or more of the subnets associated with your managed node group does not have enough available IP addresses for new nodes.
AccessDenied: Amazon EKS or one or more of your managed nodes is unable to communicate with your cluster API server.
InternalFailure: These errors are usually caused by an Amazon EKS server-side issue.
The name of the Amazon EKS cluster that you would like to listFargate profiles in.
", + "location": "uri", + "locationName": "name" + }, + "maxResults": { + "shape": "FargateProfilesRequestMaxResults", + "documentation": "The maximum number of Fargate profile results returned by ListFargateProfiles
in paginated output. When you use this parameter, ListFargateProfiles
returns only maxResults
results in a single page along with a nextToken
response element. You can see the remaining results of the initial request by sending another ListFargateProfiles
request with the returned nextToken
value. This value can be between 1 and 100. If you don't use this parameter, ListFargateProfiles
returns up to 100 results and a nextToken
value if applicable.
The nextToken
value returned from a previous paginated ListFargateProfiles
request where maxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken
value.
A list of all of the Fargate profiles associated with the specified cluster.
" + }, + "nextToken": { + "shape": "String", + "documentation": "The nextToken
value to include in a future ListFargateProfiles
request. When the results of a ListFargateProfiles
request exceed maxResults
, you can use this value to retrieve the next page of results. This value is null
when there are no more results to return.
The scaling configuration details for the AutoScaling group that is associated with your node group.
" + "documentation": "The scaling configuration details for the Auto Scaling group that is associated with your node group.
" }, "instanceTypes": { "shape": "StringList", @@ -1246,7 +1600,7 @@ }, "subnets": { "shape": "StringList", - "documentation": "The subnets allowed for the AutoScaling group that is associated with your node group. These subnets must have the following tag: kubernetes.io/cluster/CLUSTER_NAME
, where CLUSTER_NAME
is replaced with the name of your cluster.
The subnets allowed for the Auto Scaling group that is associated with your node group. These subnets must have the following tag: kubernetes.io/cluster/CLUSTER_NAME
, where CLUSTER_NAME
is replaced with the name of your cluster.
The AMI type associated with your node group. GPU instance types should use the AL2_x86_64_GPU
AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support; non-GPU instances should use the AL2_x86_64
AMI type, which uses the Amazon EKS-optimized Linux AMI.
The AMI type associated with your node group. GPU instance types should use the AL2_x86_64_GPU
AMI type, which uses the Amazon EKS-optimized Linux AMI with GPU support. Non-GPU instances should use the AL2_x86_64
AMI type, which uses the Amazon EKS-optimized Linux AMI.
The resources associated with the nodegroup, such as AutoScaling groups and security groups for remote access.
" + "documentation": "The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
" }, "diskSize": { "shape": "BoxedInteger", @@ -1278,7 +1632,7 @@ }, "tags": { "shape": "TagMap", - "documentation": "The metadata applied the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.
" + "documentation": "The metadata applied to the node group to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.
" } }, "documentation": "An object representing an Amazon EKS managed node group.
" @@ -1315,14 +1669,14 @@ "members": { "autoScalingGroups": { "shape": "AutoScalingGroupList", - "documentation": "The autoscaling groups associated with the node group.
" + "documentation": "The Auto Scaling groups associated with the node group.
" }, "remoteAccessSecurityGroup": { "shape": "String", "documentation": "The remote access security group associated with the node group. This security group controls SSH access to the worker nodes.
" } }, - "documentation": "An object representing the resources associated with the nodegroup, such as AutoScaling groups and security groups for remote access.
" + "documentation": "An object representing the resources associated with the node group, such as Auto Scaling groups and security groups for remote access.
" }, "NodegroupScalingConfig": { "type": "structure", @@ -1340,7 +1694,7 @@ "documentation": "The current number of worker nodes that the managed node group should maintain.
" } }, - "documentation": "An object representing the scaling configuration details for the AutoScaling group that is associated with your node group.
" + "documentation": "An object representing the scaling configuration details for the Auto Scaling group that is associated with your node group.
" }, "NodegroupStatus": { "type": "string", @@ -1373,7 +1727,7 @@ }, "sourceSecurityGroups": { "shape": "StringList", - "documentation": "The security groups to allow SSH access (port 22) from on the worker nodes. If you specify an Amazon EC2 SSH key, but you do not specify a source security group when you create a managed node group, port 22 on the worker nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
" + "documentation": "The security groups that are allowed SSH access (port 22) to the worker nodes. If you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0). For more information, see Security Groups for Your VPC in the Amazon Virtual Private Cloud User Guide.
" } }, "documentation": "An object representing the remote access configuration for the managed node group.
" @@ -1602,7 +1956,7 @@ }, "scalingConfig": { "shape": "NodegroupScalingConfig", - "documentation": "The scaling configuration details for the AutoScaling group after the update.
" + "documentation": "The scaling configuration details for the Auto Scaling group after the update.
" }, "clientRequestToken": { "shape": "String", @@ -1648,7 +2002,7 @@ }, "force": { "shape": "Boolean", - "documentation": "Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If a previous update fails because pods could not be drained, you can force the update after it fails to terminate the old node regardless of whether or not any pods are running on the node.
" + "documentation": "Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.
" }, "clientRequestToken": { "shape": "String", @@ -1754,7 +2108,7 @@ }, "clusterSecurityGroupId": { "shape": "String", - "documentation": "The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control plane to data plane communication.
" + "documentation": "The cluster security group that was created by Amazon EKS for the cluster. Managed node groups use this security group for control-plane-to-data-plane communication.
" }, "vpcId": { "shape": "String", diff --git a/apis/eks-2017-11-01.paginators.json b/apis/eks-2017-11-01.paginators.json index 662c51e44b..6d1c327dc5 100644 --- a/apis/eks-2017-11-01.paginators.json +++ b/apis/eks-2017-11-01.paginators.json @@ -6,6 +6,12 @@ "output_token": "nextToken", "result_key": "clusters" }, + "ListFargateProfiles": { + "input_token": "nextToken", + "limit_key": "maxResults", + "output_token": "nextToken", + "result_key": "fargateProfileNames" + }, "ListNodegroups": { "input_token": "nextToken", "limit_key": "maxResults", diff --git a/apis/es-2015-01-01.min.json b/apis/es-2015-01-01.min.json index b538382b62..4ade1f0c40 100644 --- a/apis/es-2015-01-01.min.json +++ b/apis/es-2015-01-01.min.json @@ -66,32 +66,32 @@ "shape": "Sh" }, "EBSOptions": { - "shape": "Sl" + "shape": "Sm" }, "AccessPolicies": {}, "SnapshotOptions": { - "shape": "So" + "shape": "Sp" }, "VPCOptions": { - "shape": "Sp" + "shape": "Sq" }, "CognitoOptions": { - "shape": "Sr" + "shape": "Ss" }, "EncryptionAtRestOptions": { - "shape": "Sv" + "shape": "Sw" }, "NodeToNodeEncryptionOptions": { - "shape": "Sx" + "shape": "Sy" }, "AdvancedOptions": { - "shape": "Sy" + "shape": "Sz" }, "LogPublishingOptions": { - "shape": "Sz" + "shape": "S10" }, "DomainEndpointOptions": { - "shape": "S13" + "shape": "S14" } } }, @@ -99,7 +99,7 @@ "type": "structure", "members": { "DomainStatus": { - "shape": "S16" + "shape": "S17" } } } @@ -125,7 +125,7 @@ "type": "structure", "members": { "DomainStatus": { - "shape": "S16" + "shape": "S17" } } } @@ -160,7 +160,7 @@ ], "members": { "DomainStatus": { - "shape": "S16" + "shape": "S17" } } } @@ -189,7 +189,7 @@ ], "members": { "DomainConfig": { - "shape": "S1h" + "shape": "S1i" } } } @@ -219,7 +219,7 @@ "DomainStatusList": { "type": "list", "member": { - "shape": "S16" + "shape": "S17" } } } @@ -274,7 +274,7 @@ "members": { "LimitName": {}, "LimitValues": { - "shape": "S2e" + "shape": "S2f" } } } @@ -305,7 +305,7 @@ "members": { "LimitName": {}, "LimitValues": { - "shape": "S2e" + "shape": "S2f" } } } @@ -362,7 +362,7 @@ "CurrencyCode": {}, "PaymentOption": {}, "RecurringCharges": { - "shape": "S2w" + "shape": "S2x" } } } @@ -425,7 +425,7 @@ "State": {}, "PaymentOption": {}, "RecurringCharges": { - "shape": "S2w" + "shape": "S2x" } } } @@ -457,7 +457,7 @@ "members": { "SourceVersion": {}, "TargetVersions": { - "shape": "S37" + "shape": "S38" } } } @@ -638,7 +638,7 @@ "type": "structure", "members": { "ElasticsearchVersions": { - "shape": "S37" + "shape": "S38" }, "NextToken": {} } @@ -709,7 +709,7 @@ "members": { "ARN": {}, "TagKeys": { - "shape": "Sq" + "shape": "Sr" } } } @@ -754,26 +754,26 @@ "shape": "Sh" }, "EBSOptions": { - "shape": "Sl" + "shape": "Sm" }, "SnapshotOptions": { - "shape": "So" + "shape": "Sp" }, "VPCOptions": { - "shape": "Sp" + "shape": "Sq" }, "CognitoOptions": { - "shape": "Sr" + "shape": "Ss" }, "AdvancedOptions": { - "shape": "Sy" + "shape": "Sz" }, "AccessPolicies": {}, "LogPublishingOptions": { - "shape": "Sz" + "shape": "S10" }, "DomainEndpointOptions": { - "shape": "S13" + "shape": "S14" } } }, @@ -784,7 +784,7 @@ ], "members": { "DomainConfig": { - "shape": "S1h" + "shape": "S1i" } } } @@ -876,10 +876,17 @@ "DedicatedMasterType": {}, "DedicatedMasterCount": { "type": "integer" + }, + "WarmEnabled": { + "type": "boolean" + }, + "WarmType": {}, + "WarmCount": { + "type": "integer" } } }, - "Sl": { + "Sm": { "type": "structure", "members": { "EBSEnabled": { @@ -894,7 +901,7 @@ } } }, - "So": { + "Sp": { "type": "structure", "members": { "AutomatedSnapshotStartHour": { @@ -902,22 +909,22 @@ } } }, - "Sp": { + "Sq": { "type": "structure", "members": { "SubnetIds": { - "shape": "Sq" + "shape": "Sr" }, "SecurityGroupIds": { - "shape": "Sq" + "shape": "Sr" } } }, - "Sq": { + "Sr": { "type": "list", "member": {} }, - "Sr": { + "Ss": { "type": "structure", "members": { "Enabled": { @@ -928,7 +935,7 @@ "RoleArn": {} } }, - "Sv": { + "Sw": { "type": "structure", "members": { "Enabled": { @@ -937,7 +944,7 @@ "KmsKeyId": {} } }, - "Sx": { + "Sy": { "type": "structure", "members": { "Enabled": { @@ -945,12 +952,12 @@ } } }, - "Sy": { + "Sz": { "type": "map", "key": {}, "value": {} }, - "Sz": { + "S10": { "type": "map", "key": {}, "value": { @@ -963,7 +970,7 @@ } } }, - "S13": { + "S14": { "type": "structure", "members": { "EnforceHTTPS": { @@ -972,7 +979,7 @@ "TLSSecurityPolicy": {} } }, - "S16": { + "S17": { "type": "structure", "required": [ "DomainId", @@ -1007,54 +1014,54 @@ "shape": "Sh" }, "EBSOptions": { - "shape": "Sl" + "shape": "Sm" }, "AccessPolicies": {}, "SnapshotOptions": { - "shape": "So" + "shape": "Sp" }, "VPCOptions": { - "shape": "S1a" + "shape": "S1b" }, "CognitoOptions": { - "shape": "Sr" + "shape": "Ss" }, "EncryptionAtRestOptions": { - "shape": "Sv" + "shape": "Sw" }, "NodeToNodeEncryptionOptions": { - "shape": "Sx" + "shape": "Sy" }, "AdvancedOptions": { - "shape": "Sy" + "shape": "Sz" }, "LogPublishingOptions": { - "shape": "Sz" + "shape": "S10" }, "ServiceSoftwareOptions": { "shape": "Sa" }, "DomainEndpointOptions": { - "shape": "S13" + "shape": "S14" } } }, - "S1a": { + "S1b": { "type": "structure", "members": { "VPCId": {}, "SubnetIds": { - "shape": "Sq" + "shape": "Sr" }, "AvailabilityZones": { - "shape": "Sq" + "shape": "Sr" }, "SecurityGroupIds": { - "shape": "Sq" + "shape": "Sr" } } }, - "S1h": { + "S1i": { "type": "structure", "members": { "ElasticsearchVersion": { @@ -1066,7 +1073,7 @@ "members": { "Options": {}, "Status": { - "shape": "S1j" + "shape": "S1k" } } }, @@ -1081,7 +1088,7 @@ "shape": "Sh" }, "Status": { - "shape": "S1j" + "shape": "S1k" } } }, @@ -1093,10 +1100,10 @@ ], "members": { "Options": { - "shape": "Sl" + "shape": "Sm" }, "Status": { - "shape": "S1j" + "shape": "S1k" } } }, @@ -1109,7 +1116,7 @@ "members": { "Options": {}, "Status": { - "shape": "S1j" + "shape": "S1k" } } }, @@ -1121,10 +1128,10 @@ ], "members": { "Options": { - "shape": "So" + "shape": "Sp" }, "Status": { - "shape": "S1j" + "shape": "S1k" } } }, @@ -1136,10 +1143,10 @@ ], "members": { "Options": { - "shape": "S1a" + "shape": "S1b" }, "Status": { - "shape": "S1j" + "shape": "S1k" } } }, @@ -1151,10 +1158,10 @@ ], "members": { "Options": { - "shape": "Sr" + "shape": "Ss" }, "Status": { - "shape": "S1j" + "shape": "S1k" } } }, @@ -1166,10 +1173,10 @@ ], "members": { "Options": { - "shape": "Sv" + "shape": "Sw" }, "Status": { - "shape": "S1j" + "shape": "S1k" } } }, @@ -1181,10 +1188,10 @@ ], "members": { "Options": { - "shape": "Sx" + "shape": "Sy" }, "Status": { - "shape": "S1j" + "shape": "S1k" } } }, @@ -1196,10 +1203,10 @@ ], "members": { "Options": { - "shape": "Sy" + "shape": "Sz" }, "Status": { - "shape": "S1j" + "shape": "S1k" } } }, @@ -1207,10 +1214,10 @@ "type": "structure", "members": { "Options": { - "shape": "Sz" + "shape": "S10" }, "Status": { - "shape": "S1j" + "shape": "S1k" } } }, @@ -1222,16 +1229,16 @@ ], "members": { "Options": { - "shape": "S13" + "shape": "S14" }, "Status": { - "shape": "S1j" + "shape": "S1k" } } } } }, - "S1j": { + "S1k": { "type": "structure", "required": [ "CreationDate", @@ -1254,11 +1261,11 @@ } } }, - "S2e": { + "S2f": { "type": "list", "member": {} }, - "S2w": { + "S2x": { "type": "list", "member": { "type": "structure", @@ -1270,7 +1277,7 @@ } } }, - "S37": { + "S38": { "type": "list", "member": {} } diff --git a/apis/es-2015-01-01.normal.json b/apis/es-2015-01-01.normal.json index bd40532049..40f9af2a50 100644 --- a/apis/es-2015-01-01.normal.json +++ b/apis/es-2015-01-01.normal.json @@ -1287,6 +1287,8 @@ "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", + "ultrawarm1.medium.elasticsearch", + "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", @@ -1320,12 +1322,19 @@ "i3.16xlarge.elasticsearch" ] }, + "ESWarmPartitionInstanceType": { + "type": "string", + "enum": [ + "ultrawarm1.medium.elasticsearch", + "ultrawarm1.large.elasticsearch" + ] + }, "ElasticsearchClusterConfig": { "type": "structure", "members": { "InstanceType": { "shape": "ESPartitionInstanceType", - "documentation": "The instance type for an Elasticsearch cluster.
" + "documentation": "The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
" }, "InstanceCount": { "shape": "IntegerClass", @@ -1350,6 +1359,18 @@ "DedicatedMasterCount": { "shape": "IntegerClass", "documentation": "Total number of dedicated master nodes, active and on standby, for the cluster.
" + }, + "WarmEnabled": { + "shape": "Boolean", + "documentation": "True to enable warm storage.
" + }, + "WarmType": { + "shape": "ESWarmPartitionInstanceType", + "documentation": "The instance type for the Elasticsearch cluster's warm nodes.
" + }, + "WarmCount": { + "shape": "IntegerClass", + "documentation": "The number of warm nodes in the cluster.
" } }, "documentation": "Specifies the configuration for the domain cluster, such as the type and number of instances.
" @@ -1795,7 +1816,7 @@ "value": { "shape": "Limits" }, - "documentation": "Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:
Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:
Creates a batch of variables.
" + }, + "BatchGetVariable": { + "name": "BatchGetVariable", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "BatchGetVariableRequest" + }, + "output": { + "shape": "BatchGetVariableResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Gets a batch of variables.
" + }, + "CreateDetectorVersion": { + "name": "CreateDetectorVersion", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateDetectorVersionRequest" + }, + "output": { + "shape": "CreateDetectorVersionResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Creates a detector version. The detector version starts in a DRAFT
status.
Creates a version of the model using the specified model type.
" + }, + "CreateRule": { + "name": "CreateRule", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateRuleRequest" + }, + "output": { + "shape": "CreateRuleResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Creates a rule for use with the specified detector.
" + }, + "CreateVariable": { + "name": "CreateVariable", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateVariableRequest" + }, + "output": { + "shape": "CreateVariableResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Creates a variable.
" + }, + "DeleteDetectorVersion": { + "name": "DeleteDetectorVersion", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteDetectorVersionRequest" + }, + "output": { + "shape": "DeleteDetectorVersionResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Deletes the detector version.
" + }, + "DeleteEvent": { + "name": "DeleteEvent", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteEventRequest" + }, + "output": { + "shape": "DeleteEventResult" + }, + "errors": [ + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Deletes the specified event.
" + }, + "DescribeDetector": { + "name": "DescribeDetector", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeDetectorRequest" + }, + "output": { + "shape": "DescribeDetectorResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Gets all versions for a specified detector.
" + }, + "DescribeModelVersions": { + "name": "DescribeModelVersions", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeModelVersionsRequest" + }, + "output": { + "shape": "DescribeModelVersionsResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Gets all of the model versions for the specified model type or for the specified model type and model ID. You can also get details for a single, specified model version.
" + }, + "GetDetectorVersion": { + "name": "GetDetectorVersion", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetDetectorVersionRequest" + }, + "output": { + "shape": "GetDetectorVersionResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Gets a particular detector version.
" + }, + "GetDetectors": { + "name": "GetDetectors", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetDetectorsRequest" + }, + "output": { + "shape": "GetDetectorsResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Gets all of detectors. This is a paginated API. If you provide a null maxSizePerPage
, this actions retrieves a maximum of 10 records per page. If you provide a maxSizePerPage
, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetEventTypesResponse
as part of your request. A null pagination token fetches the records from the beginning.
Gets the details for one or more Amazon SageMaker models that have been imported into the service. This is a paginated API. If you provide a null maxSizePerPage
, this actions retrieves a maximum of 10 records per page. If you provide a maxSizePerPage
, the value must be between 5 and 10. To get the next page results, provide the pagination token from the GetExternalModelsResult
as part of your request. A null pagination token fetches the records from the beginning.
Gets a model version.
" + }, + "GetModels": { + "name": "GetModels", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetModelsRequest" + }, + "output": { + "shape": "GetModelsResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Gets all of the models for the AWS account, or the specified model type, or gets a single model for the specified model type, model ID combination.
" + }, + "GetOutcomes": { + "name": "GetOutcomes", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetOutcomesRequest" + }, + "output": { + "shape": "GetOutcomesResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Gets one or more outcomes. This is a paginated API. If you provide a null maxSizePerPage
, this actions retrieves a maximum of 10 records per page. If you provide a maxSizePerPage
, the value must be between 50 and 100. To get the next page results, provide the pagination token from the GetOutcomesResult
as part of your request. A null pagination token fetches the records from the beginning.
Evaluates an event against a detector version. If a version ID is not provided, the detector’s (ACTIVE
) version is used.
Gets all rules available for the specified detector.
" + }, + "GetVariables": { + "name": "GetVariables", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "GetVariablesRequest" + }, + "output": { + "shape": "GetVariablesResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Gets all of the variables or the specific variable. This is a paginated API. Providing null maxSizePerPage
results in retrieving maximum of 100 records per page. If you provide maxSizePerPage
the value must be between 50 and 100. To get the next page result, a provide a pagination token from GetVariablesResult
as part of your request. Null pagination token fetches the records from the beginning.
Creates or updates a detector.
" + }, + "PutExternalModel": { + "name": "PutExternalModel", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "PutExternalModelRequest" + }, + "output": { + "shape": "PutExternalModelResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Creates or updates an Amazon SageMaker model endpoint. You can also use this action to update the configuration of the model endpoint, including the IAM role and/or the mapped variables.
" + }, + "PutModel": { + "name": "PutModel", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "PutModelRequest" + }, + "output": { + "shape": "PutModelResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Creates or updates a model.
" + }, + "PutOutcome": { + "name": "PutOutcome", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "PutOutcomeRequest" + }, + "output": { + "shape": "PutOutcomeResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Creates or updates an outcome.
" + }, + "UpdateDetectorVersion": { + "name": "UpdateDetectorVersion", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdateDetectorVersionRequest" + }, + "output": { + "shape": "UpdateDetectorVersionResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": " Updates a detector version. The detector version attributes that you can update include models, external model endpoints, rules, and description. You can only update a DRAFT
detector version.
Updates the detector version's description. You can update the metadata for any detector version (DRAFT, ACTIVE,
or INACTIVE
).
Updates the detector version’s status. You can perform the following promotions or demotions using UpdateDetectorVersionStatus
: DRAFT
to ACTIVE
, ACTIVE
to INACTIVE
, and INACTIVE
to ACTIVE
.
Updates a model version. You can update the description and status attributes using this action. You can perform the following status updates:
Change the TRAINING_COMPLETE
status to ACTIVE
Change ACTIVE
back to TRAINING_COMPLETE
Updates a rule's metadata.
" + }, + "UpdateRuleVersion": { + "name": "UpdateRuleVersion", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdateRuleVersionRequest" + }, + "output": { + "shape": "UpdateRuleVersionResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Updates a rule version resulting in a new rule version.
" + }, + "UpdateVariable": { + "name": "UpdateVariable", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdateVariableRequest" + }, + "output": { + "shape": "UpdateVariableResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ThrottlingException" + } + ], + "documentation": "Updates a variable.
" + } + }, + "shapes": { + "BatchCreateVariableError": { + "type": "structure", + "members": { + "name": { + "shape": "string", + "documentation": "The name.
" + }, + "code": { + "shape": "integer", + "documentation": "The error code.
" + }, + "message": { + "shape": "string", + "documentation": "The error message.
" + } + }, + "documentation": "Provides the error of the batch create variable API.
" + }, + "BatchCreateVariableErrorList": { + "type": "list", + "member": { + "shape": "BatchCreateVariableError" + } + }, + "BatchCreateVariableRequest": { + "type": "structure", + "required": [ + "variableEntries" + ], + "members": { + "variableEntries": { + "shape": "VariableEntryList", + "documentation": "The list of variables for the batch create variable request.
" + } + } + }, + "BatchCreateVariableResult": { + "type": "structure", + "members": { + "errors": { + "shape": "BatchCreateVariableErrorList", + "documentation": "Provides the errors for the BatchCreateVariable
request.
The error name.
" + }, + "code": { + "shape": "integer", + "documentation": "The error code.
" + }, + "message": { + "shape": "string", + "documentation": "The error message.
" + } + }, + "documentation": "Provides the error of the batch get variable API.
" + }, + "BatchGetVariableErrorList": { + "type": "list", + "member": { + "shape": "BatchGetVariableError" + } + }, + "BatchGetVariableRequest": { + "type": "structure", + "required": [ + "names" + ], + "members": { + "names": { + "shape": "NameList", + "documentation": "The list of variable names to get.
" + } + } + }, + "BatchGetVariableResult": { + "type": "structure", + "members": { + "variables": { + "shape": "VariableList", + "documentation": "The returned variables.
" + }, + "errors": { + "shape": "BatchGetVariableErrorList", + "documentation": "The errors from the request.
" + } + } + }, + "CreateDetectorVersionRequest": { + "type": "structure", + "required": [ + "detectorId", + "rules" + ], + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The ID of the detector under which you want to create a new version.
" + }, + "description": { + "shape": "description", + "documentation": "The description of the detector version.
" + }, + "externalModelEndpoints": { + "shape": "ListOfStrings", + "documentation": "The Amazon Sagemaker model endpoints to include in the detector version.
" + }, + "rules": { + "shape": "RuleList", + "documentation": "The rules to include in the detector version.
" + }, + "modelVersions": { + "shape": "ListOfModelVersions", + "documentation": "The model versions to include in the detector version.
" + } + } + }, + "CreateDetectorVersionResult": { + "type": "structure", + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The ID for the created version's parent detector.
" + }, + "detectorVersionId": { + "shape": "nonEmptyString", + "documentation": "The ID for the created detector.
" + }, + "status": { + "shape": "DetectorVersionStatus", + "documentation": "The status of the detector version.
" + } + } + }, + "CreateModelVersionRequest": { + "type": "structure", + "required": [ + "modelId", + "modelType" + ], + "members": { + "modelId": { + "shape": "identifier", + "documentation": "The model ID.
" + }, + "modelType": { + "shape": "ModelTypeEnum", + "documentation": "The model type.
" + }, + "description": { + "shape": "description", + "documentation": "The model version description.
" + } + } + }, + "CreateModelVersionResult": { + "type": "structure", + "members": { + "modelId": { + "shape": "identifier", + "documentation": "The model ID.
" + }, + "modelType": { + "shape": "ModelTypeEnum", + "documentation": "The model type.
" + }, + "modelVersionNumber": { + "shape": "nonEmptyString", + "documentation": "The version of the model.
" + }, + "status": { + "shape": "string", + "documentation": "The model version status.
" + } + } + }, + "CreateRuleRequest": { + "type": "structure", + "required": [ + "ruleId", + "detectorId", + "expression", + "language", + "outcomes" + ], + "members": { + "ruleId": { + "shape": "identifier", + "documentation": "The rule ID.
" + }, + "detectorId": { + "shape": "identifier", + "documentation": "The detector ID for the rule's parent detector.
" + }, + "description": { + "shape": "description", + "documentation": "The rule description.
" + }, + "expression": { + "shape": "ruleExpression", + "documentation": "The rule expression.
" + }, + "language": { + "shape": "Language", + "documentation": "The language of the rule.
" + }, + "outcomes": { + "shape": "NonEmptyListOfStrings", + "documentation": "The outcome or outcomes returned when the rule expression matches.
" + } + } + }, + "CreateRuleResult": { + "type": "structure", + "members": { + "rule": { + "shape": "Rule", + "documentation": "The created rule.
" + } + } + }, + "CreateVariableRequest": { + "type": "structure", + "required": [ + "name", + "dataType", + "dataSource", + "defaultValue" + ], + "members": { + "name": { + "shape": "string", + "documentation": "The name of the variable.
" + }, + "dataType": { + "shape": "DataType", + "documentation": "The data type.
" + }, + "dataSource": { + "shape": "DataSource", + "documentation": "The source of the data.
" + }, + "defaultValue": { + "shape": "string", + "documentation": "The default value for the variable when no value is received.
" + }, + "description": { + "shape": "string", + "documentation": "The description.
" + }, + "variableType": { + "shape": "string", + "documentation": "The variable type.
" + } + } + }, + "CreateVariableResult": { + "type": "structure", + "members": {} + }, + "CsvIndexToVariableMap": { + "type": "map", + "key": { + "shape": "string" + }, + "value": { + "shape": "string" + } + }, + "DataSource": { + "type": "string", + "enum": [ + "EVENT", + "MODEL_SCORE", + "EXTERNAL_MODEL_SCORE" + ] + }, + "DataType": { + "type": "string", + "enum": [ + "STRING", + "INTEGER", + "FLOAT", + "BOOLEAN" + ] + }, + "DeleteDetectorVersionRequest": { + "type": "structure", + "required": [ + "detectorId", + "detectorVersionId" + ], + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The ID of the parent detector for the detector version to delete.
" + }, + "detectorVersionId": { + "shape": "nonEmptyString", + "documentation": "The ID of the detector version to delete.
" + } + } + }, + "DeleteDetectorVersionResult": { + "type": "structure", + "members": {} + }, + "DeleteEventRequest": { + "type": "structure", + "required": [ + "eventId" + ], + "members": { + "eventId": { + "shape": "string", + "documentation": "The ID of the event to delete.
" + } + } + }, + "DeleteEventResult": { + "type": "structure", + "members": {} + }, + "DescribeDetectorRequest": { + "type": "structure", + "required": [ + "detectorId" + ], + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The detector ID.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next token from the previous response.
" + }, + "maxResults": { + "shape": "DetectorVersionMaxResults", + "documentation": "The maximum number of results to return for the request.
" + } + } + }, + "DescribeDetectorResult": { + "type": "structure", + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The detector ID.
" + }, + "detectorVersionSummaries": { + "shape": "DetectorVersionSummaryList", + "documentation": "The status and description for each detector version.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next token to be used for subsequent requests.
" + } + } + }, + "DescribeModelVersionsRequest": { + "type": "structure", + "members": { + "modelId": { + "shape": "identifier", + "documentation": "The model ID.
" + }, + "modelVersionNumber": { + "shape": "nonEmptyString", + "documentation": "The model version.
" + }, + "modelType": { + "shape": "ModelTypeEnum", + "documentation": "The model type.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next token from the previous results.
" + }, + "maxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return.
" + } + } + }, + "DescribeModelVersionsResult": { + "type": "structure", + "members": { + "modelVersionDetails": { + "shape": "ModelVersionDetailList", + "documentation": "The model version details.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next token.
" + } + } + }, + "Detector": { + "type": "structure", + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The detector ID.
" + }, + "description": { + "shape": "description", + "documentation": "The detector description.
" + }, + "lastUpdatedTime": { + "shape": "time", + "documentation": "Timestamp of when the detector was last updated.
" + }, + "createdTime": { + "shape": "time", + "documentation": "Timestamp of when the detector was created.
" + } + }, + "documentation": "The detector.
" + }, + "DetectorList": { + "type": "list", + "member": { + "shape": "Detector" + } + }, + "DetectorVersionMaxResults": { + "type": "integer", + "box": true, + "max": 2500, + "min": 1000 + }, + "DetectorVersionStatus": { + "type": "string", + "enum": [ + "DRAFT", + "ACTIVE", + "INACTIVE" + ] + }, + "DetectorVersionSummary": { + "type": "structure", + "members": { + "detectorVersionId": { + "shape": "nonEmptyString", + "documentation": "The detector version ID.
" + }, + "status": { + "shape": "DetectorVersionStatus", + "documentation": "The detector version status.
" + }, + "description": { + "shape": "description", + "documentation": "The detector version description.
" + }, + "lastUpdatedTime": { + "shape": "time", + "documentation": "Timestamp of when the detector version was last updated.
" + } + }, + "documentation": "The summary of the detector version.
" + }, + "DetectorVersionSummaryList": { + "type": "list", + "member": { + "shape": "DetectorVersionSummary" + } + }, + "DetectorsMaxResults": { + "type": "integer", + "box": true, + "max": 10, + "min": 5 + }, + "EventAttributeMap": { + "type": "map", + "key": { + "shape": "attributeKey" + }, + "value": { + "shape": "attributeValue" + } + }, + "ExternalModel": { + "type": "structure", + "members": { + "modelEndpoint": { + "shape": "string", + "documentation": "The Amazon SageMaker model endpoints.
" + }, + "modelSource": { + "shape": "ModelSource", + "documentation": "The source of the model.
" + }, + "role": { + "shape": "Role", + "documentation": "The role used to invoke the model.
" + }, + "inputConfiguration": { + "shape": "ModelInputConfiguration", + "documentation": "The input configuration.
" + }, + "outputConfiguration": { + "shape": "ModelOutputConfiguration", + "documentation": "The output configuration.
" + }, + "modelEndpointStatus": { + "shape": "ModelEndpointStatus", + "documentation": "The Amazon Fraud Detector status for the external model endpoint
" + }, + "lastUpdatedTime": { + "shape": "time", + "documentation": "Timestamp of when the model was last updated.
" + }, + "createdTime": { + "shape": "time", + "documentation": "Timestamp of when the model was last created.
" + } + }, + "documentation": "The Amazon SageMaker model.
" + }, + "ExternalModelEndpointDataBlobMap": { + "type": "map", + "key": { + "shape": "string" + }, + "value": { + "shape": "ModelEndpointDataBlob" + }, + "sensitive": true + }, + "ExternalModelList": { + "type": "list", + "member": { + "shape": "ExternalModel" + } + }, + "ExternalModelsMaxResults": { + "type": "integer", + "box": true, + "max": 10, + "min": 5 + }, + "GetDetectorVersionRequest": { + "type": "structure", + "required": [ + "detectorId", + "detectorVersionId" + ], + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The detector ID.
" + }, + "detectorVersionId": { + "shape": "nonEmptyString", + "documentation": "The detector version ID.
" + } + } + }, + "GetDetectorVersionResult": { + "type": "structure", + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The detector ID.
" + }, + "detectorVersionId": { + "shape": "nonEmptyString", + "documentation": "The detector version ID.
" + }, + "description": { + "shape": "description", + "documentation": "The detector version description.
" + }, + "externalModelEndpoints": { + "shape": "ListOfStrings", + "documentation": "The Amazon SageMaker model endpoints included in the detector version.
" + }, + "modelVersions": { + "shape": "ListOfModelVersions", + "documentation": "The model versions included in the detector version.
" + }, + "rules": { + "shape": "RuleList", + "documentation": "The rules included in the detector version.
" + }, + "status": { + "shape": "DetectorVersionStatus", + "documentation": "The status of the detector version.
" + }, + "lastUpdatedTime": { + "shape": "time", + "documentation": "The timestamp when the detector version was last updated.
" + }, + "createdTime": { + "shape": "time", + "documentation": "The timestamp when the detector version was created.
" + } + } + }, + "GetDetectorsRequest": { + "type": "structure", + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The detector ID.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next token for the subsequent request.
" + }, + "maxResults": { + "shape": "DetectorsMaxResults", + "documentation": "The maximum number of objects to return for the request.
" + } + } + }, + "GetDetectorsResult": { + "type": "structure", + "members": { + "detectors": { + "shape": "DetectorList", + "documentation": "The detectors.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next page token.
" + } + } + }, + "GetExternalModelsRequest": { + "type": "structure", + "members": { + "modelEndpoint": { + "shape": "string", + "documentation": "The Amazon SageMaker model endpoint.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next page token for the request.
" + }, + "maxResults": { + "shape": "ExternalModelsMaxResults", + "documentation": "The maximum number of objects to return for the request.
" + } + } + }, + "GetExternalModelsResult": { + "type": "structure", + "members": { + "externalModels": { + "shape": "ExternalModelList", + "documentation": "Gets the Amazon SageMaker models.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next page token to be used in subsequent requests.
" + } + } + }, + "GetModelVersionRequest": { + "type": "structure", + "required": [ + "modelId", + "modelType", + "modelVersionNumber" + ], + "members": { + "modelId": { + "shape": "identifier", + "documentation": "The model ID.
" + }, + "modelType": { + "shape": "ModelTypeEnum", + "documentation": "The model type.
" + }, + "modelVersionNumber": { + "shape": "nonEmptyString", + "documentation": "The model version.
" + } + } + }, + "GetModelVersionResult": { + "type": "structure", + "members": { + "modelId": { + "shape": "identifier", + "documentation": "The model ID.
" + }, + "modelType": { + "shape": "ModelTypeEnum", + "documentation": "The model type.
" + }, + "modelVersionNumber": { + "shape": "nonEmptyString", + "documentation": "The model version.
" + }, + "description": { + "shape": "description", + "documentation": "The model version description.
" + }, + "status": { + "shape": "string", + "documentation": "The model version status.
" + } + } + }, + "GetModelsRequest": { + "type": "structure", + "members": { + "modelType": { + "shape": "ModelTypeEnum", + "documentation": "The model type.
" + }, + "modelId": { + "shape": "identifier", + "documentation": "The model ID.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next token for the request.
" + }, + "maxResults": { + "shape": "MaxResults", + "documentation": "The maximum results to return for the request.
" + } + } + }, + "GetModelsResult": { + "type": "structure", + "members": { + "nextToken": { + "shape": "string", + "documentation": "The next token for subsequent requests.
" + }, + "models": { + "shape": "ModelList", + "documentation": "The returned models.
" + } + } + }, + "GetOutcomesRequest": { + "type": "structure", + "members": { + "name": { + "shape": "identifier", + "documentation": "The name of the outcome or outcomes to get.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next page token for the request.
" + }, + "maxResults": { + "shape": "OutcomesMaxResults", + "documentation": "The maximum number of objects to return for the request.
" + } + } + }, + "GetOutcomesResult": { + "type": "structure", + "members": { + "outcomes": { + "shape": "OutcomeList", + "documentation": "The outcomes.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next page token for subsequent requests.
" + } + } + }, + "GetPredictionRequest": { + "type": "structure", + "required": [ + "detectorId", + "eventId" + ], + "members": { + "detectorId": { + "shape": "string", + "documentation": "The detector ID.
" + }, + "detectorVersionId": { + "shape": "string", + "documentation": "The detector version ID.
" + }, + "eventId": { + "shape": "string", + "documentation": "The unique ID used to identify the event.
" + }, + "eventAttributes": { + "shape": "EventAttributeMap", + "documentation": "Names of variables you defined in Amazon Fraud Detector to represent event data elements and their corresponding values for the event you are sending for evaluation.
" + }, + "externalModelEndpointDataBlobs": { + "shape": "ExternalModelEndpointDataBlobMap", + "documentation": "The Amazon SageMaker model endpoint input data blobs.
" + } + } + }, + "GetPredictionResult": { + "type": "structure", + "members": { + "outcomes": { + "shape": "ListOfStrings", + "documentation": "The prediction outcomes.
" + }, + "modelScores": { + "shape": "ListOfModelScores", + "documentation": "The model scores for models used in the detector version.
" + } + } + }, + "GetRulesRequest": { + "type": "structure", + "required": [ + "detectorId" + ], + "members": { + "ruleId": { + "shape": "identifier", + "documentation": "The rule ID.
" + }, + "detectorId": { + "shape": "identifier", + "documentation": "The detector ID.
" + }, + "ruleVersion": { + "shape": "nonEmptyString", + "documentation": "The rule version.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next page token.
" + }, + "maxResults": { + "shape": "RulesMaxResults", + "documentation": "The maximum number of rules to return for the request.
" + } + } + }, + "GetRulesResult": { + "type": "structure", + "members": { + "ruleDetails": { + "shape": "RuleDetailList", + "documentation": "The details of the requested rule.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next page token to be used in subsequent requests.
" + } + } + }, + "GetVariablesRequest": { + "type": "structure", + "members": { + "name": { + "shape": "string", + "documentation": "The name of the variable.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next page token of the get variable request.
" + }, + "maxResults": { + "shape": "VariablesMaxResults", + "documentation": "The max size per page determined for the get variable request.
" + } + } + }, + "GetVariablesResult": { + "type": "structure", + "members": { + "variables": { + "shape": "VariableList", + "documentation": "The names of the variables returned.
" + }, + "nextToken": { + "shape": "string", + "documentation": "The next page token to be used in subsequent requests.
" + } + } + }, + "IsOpaque": { + "type": "boolean" + }, + "JsonKeyToVariableMap": { + "type": "map", + "key": { + "shape": "string" + }, + "value": { + "shape": "string" + } + }, + "LabelMapper": { + "type": "map", + "key": { + "shape": "string" + }, + "value": { + "shape": "ListOfStrings" + } + }, + "LabelSchema": { + "type": "structure", + "required": [ + "labelKey", + "labelMapper" + ], + "members": { + "labelKey": { + "shape": "string", + "documentation": "The label key.
" + }, + "labelMapper": { + "shape": "LabelMapper", + "documentation": "The label mapper maps the Amazon Fraud Detector supported label to the appropriate source labels. For example, if \"FRAUD\"
and \"LEGIT\"
are Amazon Fraud Detector supported labels, this mapper could be: {\"FRAUD\" => [\"0\"]
, \"LEGIT\" => [\"1\"]} or {\"FRAUD\" => [\"false\"], \"LEGIT\" => [\"true\"]}
or {\"FRAUD\" => [\"fraud\", \"abuse\"], \"LEGIT\" => [\"legit\", \"safe\"]}
. The value part of the mapper is a list, because you may have multiple variants for a single Amazon Fraud Detector label.
The label schema.
" + }, + "Language": { + "type": "string", + "enum": [ + "DETECTORPL" + ] + }, + "ListOfModelScores": { + "type": "list", + "member": { + "shape": "ModelScores" + } + }, + "ListOfModelVersions": { + "type": "list", + "member": { + "shape": "ModelVersion" + } + }, + "ListOfStrings": { + "type": "list", + "member": { + "shape": "string" + } + }, + "MaxResults": { + "type": "integer", + "box": true, + "max": 10, + "min": 1 + }, + "MetricsMap": { + "type": "map", + "key": { + "shape": "string" + }, + "value": { + "shape": "string" + } + }, + "Model": { + "type": "structure", + "members": { + "modelId": { + "shape": "identifier", + "documentation": "The model ID.
" + }, + "modelType": { + "shape": "ModelTypeEnum", + "documentation": "The model type.
" + }, + "description": { + "shape": "description", + "documentation": "The model description.
" + }, + "trainingDataSource": { + "shape": "TrainingDataSource", + "documentation": "The model training data source in Amazon S3.
" + }, + "modelVariables": { + "shape": "ModelVariablesList", + "documentation": "The model input variables.
" + }, + "labelSchema": { + "shape": "LabelSchema", + "documentation": "The model label schema.
" + }, + "lastUpdatedTime": { + "shape": "time", + "documentation": "Timestamp of last time the model was updated.
" + }, + "createdTime": { + "shape": "time", + "documentation": "Timestamp of when the model was created.
" + } + }, + "documentation": "The model.
" + }, + "ModelEndpointDataBlob": { + "type": "structure", + "members": { + "byteBuffer": { + "shape": "blob", + "documentation": "The byte buffer of the Amazon SageMaker model endpoint input data blob.
" + }, + "contentType": { + "shape": "contentType", + "documentation": "The content type of the Amazon SageMaker model endpoint input data blob.
" + } + }, + "documentation": "A pre-formed Amazon SageMaker model input you can include if your detector version includes an imported Amazon SageMaker model endpoint with pass-through input configuration.
" + }, + "ModelEndpointStatus": { + "type": "string", + "enum": [ + "ASSOCIATED", + "DISSOCIATED" + ] + }, + "ModelInputConfiguration": { + "type": "structure", + "required": [ + "isOpaque" + ], + "members": { + "format": { + "shape": "ModelInputDataFormat", + "documentation": "The format of the model input configuration. The format differs depending on if it is passed through to SageMaker or constructed by Amazon Fraud Detector.
" + }, + "isOpaque": { + "shape": "IsOpaque", + "documentation": "For an opaque-model, the input to the model will be a ByteBuffer blob provided in the getPrediction request, and will be passed to SageMaker as-is. For non-opaque models, the input will be constructed by Amazon Fraud Detector based on the model-configuration.
" + }, + "jsonInputTemplate": { + "shape": "string", + "documentation": "Template for constructing the JSON input-data sent to SageMaker. At event-evaluation, the placeholders for variable names in the template will be replaced with the variable values before being sent to SageMaker.
" + }, + "csvInputTemplate": { + "shape": "string", + "documentation": "Template for constructing the CSV input-data sent to SageMaker. At event-evaluation, the placeholders for variable-names in the template will be replaced with the variable values before being sent to SageMaker.
" + } + }, + "documentation": "The model input configuration.
" + }, + "ModelInputDataFormat": { + "type": "string", + "enum": [ + "TEXT_CSV", + "APPLICATION_JSON" + ] + }, + "ModelList": { + "type": "list", + "member": { + "shape": "Model" + } + }, + "ModelOutputConfiguration": { + "type": "structure", + "required": [ + "format" + ], + "members": { + "format": { + "shape": "ModelOutputDataFormat", + "documentation": "The format of the model output configuration.
" + }, + "jsonKeyToVariableMap": { + "shape": "JsonKeyToVariableMap", + "documentation": "A map of JSON keys in response from SageMaker to the Amazon Fraud Detector variables.
" + }, + "csvIndexToVariableMap": { + "shape": "CsvIndexToVariableMap", + "documentation": "A map of CSV index values in the SageMaker response to the Amazon Fraud Detector variables.
" + } + }, + "documentation": "Provides the model output configuration.
" + }, + "ModelOutputDataFormat": { + "type": "string", + "enum": [ + "TEXT_CSV", + "APPLICATION_JSONLINES" + ] + }, + "ModelPredictionMap": { + "type": "map", + "key": { + "shape": "string" + }, + "value": { + "shape": "float" + } + }, + "ModelScores": { + "type": "structure", + "members": { + "modelVersion": { + "shape": "ModelVersion", + "documentation": "The model version.
" + }, + "scores": { + "shape": "ModelPredictionMap", + "documentation": "The model's fraud prediction scores.
" + } + }, + "documentation": "The fraud prediction scores.
" + }, + "ModelSource": { + "type": "string", + "enum": [ + "SAGEMAKER" + ] + }, + "ModelTypeEnum": { + "type": "string", + "enum": [ + "ONLINE_FRAUD_INSIGHTS" + ] + }, + "ModelVariable": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "shape": "string", + "documentation": "The model variable's name.>
" + }, + "index": { + "shape": "ModelVariableIndex", + "documentation": "The model variable's index.>
" + } + }, + "documentation": "The model variable.>
" + }, + "ModelVariableIndex": { + "type": "integer" + }, + "ModelVariablesList": { + "type": "list", + "member": { + "shape": "ModelVariable" + } + }, + "ModelVersion": { + "type": "structure", + "required": [ + "modelId", + "modelType", + "modelVersionNumber" + ], + "members": { + "modelId": { + "shape": "identifier", + "documentation": "The parent model ID.
" + }, + "modelType": { + "shape": "ModelTypeEnum", + "documentation": "The model type.
" + }, + "modelVersionNumber": { + "shape": "nonEmptyString", + "documentation": "The model version.
" + } + }, + "documentation": "The model version.
" + }, + "ModelVersionDetail": { + "type": "structure", + "members": { + "modelId": { + "shape": "identifier", + "documentation": "The model ID.
" + }, + "modelType": { + "shape": "ModelTypeEnum", + "documentation": "The model type.
" + }, + "modelVersionNumber": { + "shape": "nonEmptyString", + "documentation": "The model version.
" + }, + "description": { + "shape": "description", + "documentation": "The model description.
" + }, + "status": { + "shape": "string", + "documentation": "The model status.
" + }, + "trainingDataSource": { + "shape": "TrainingDataSource", + "documentation": "The model training data source.
" + }, + "modelVariables": { + "shape": "ModelVariablesList", + "documentation": "The model variables.
" + }, + "labelSchema": { + "shape": "LabelSchema", + "documentation": "The model label schema.
" + }, + "validationMetrics": { + "shape": "MetricsMap", + "documentation": "The model validation metrics.
" + }, + "trainingMetrics": { + "shape": "MetricsMap", + "documentation": "The model training metrics.
" + }, + "lastUpdatedTime": { + "shape": "time", + "documentation": "The timestamp when the model was last updated.
" + }, + "createdTime": { + "shape": "time", + "documentation": "The timestamp when the model was created.
" + } + }, + "documentation": "Provides the model version details.
" + }, + "ModelVersionDetailList": { + "type": "list", + "member": { + "shape": "ModelVersionDetail" + } + }, + "ModelVersionStatus": { + "type": "string", + "enum": [ + "TRAINING_IN_PROGRESS", + "TRAINING_COMPLETE", + "ACTIVATE_REQUESTED", + "ACTIVATE_IN_PROGRESS", + "ACTIVE", + "INACTIVATE_IN_PROGRESS", + "INACTIVE", + "ERROR" + ] + }, + "NameList": { + "type": "list", + "member": { + "shape": "string" + }, + "max": 100, + "min": 1 + }, + "NonEmptyListOfStrings": { + "type": "list", + "member": { + "shape": "string" + }, + "min": 1 + }, + "Outcome": { + "type": "structure", + "members": { + "name": { + "shape": "identifier", + "documentation": "The outcome name.
" + }, + "description": { + "shape": "description", + "documentation": "The outcome description.
" + }, + "lastUpdatedTime": { + "shape": "time", + "documentation": "The timestamp when the outcome was last updated.
" + }, + "createdTime": { + "shape": "time", + "documentation": "The timestamp when the outcome was created.
" + } + }, + "documentation": "The outcome.
" + }, + "OutcomeList": { + "type": "list", + "member": { + "shape": "Outcome" + } + }, + "OutcomesMaxResults": { + "type": "integer", + "box": true, + "max": 100, + "min": 50 + }, + "PutDetectorRequest": { + "type": "structure", + "required": [ + "detectorId" + ], + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The detector ID.
" + }, + "description": { + "shape": "description", + "documentation": "The description of the detector.
" + } + } + }, + "PutDetectorResult": { + "type": "structure", + "members": {} + }, + "PutExternalModelRequest": { + "type": "structure", + "required": [ + "modelEndpoint", + "modelSource", + "role", + "inputConfiguration", + "outputConfiguration", + "modelEndpointStatus" + ], + "members": { + "modelEndpoint": { + "shape": "string", + "documentation": "The model endpoints name.
" + }, + "modelSource": { + "shape": "ModelSource", + "documentation": "The source of the model.
" + }, + "role": { + "shape": "Role", + "documentation": "The IAM role used to invoke the model endpoint.
" + }, + "inputConfiguration": { + "shape": "ModelInputConfiguration", + "documentation": "The model endpoint input configuration.
" + }, + "outputConfiguration": { + "shape": "ModelOutputConfiguration", + "documentation": "The model endpoint output configuration.
" + }, + "modelEndpointStatus": { + "shape": "ModelEndpointStatus", + "documentation": "The model endpoint’s status in Amazon Fraud Detector.
" + } + } + }, + "PutExternalModelResult": { + "type": "structure", + "members": {} + }, + "PutModelRequest": { + "type": "structure", + "required": [ + "modelId", + "modelType", + "trainingDataSource", + "modelVariables", + "labelSchema" + ], + "members": { + "modelId": { + "shape": "identifier", + "documentation": "The model ID.
" + }, + "modelType": { + "shape": "ModelTypeEnum", + "documentation": "The model type.
" + }, + "description": { + "shape": "description", + "documentation": "The model description.
" + }, + "trainingDataSource": { + "shape": "TrainingDataSource", + "documentation": "The training data source location in Amazon S3.
" + }, + "modelVariables": { + "shape": "ModelVariablesList", + "documentation": "The model input variables.
" + }, + "labelSchema": { + "shape": "LabelSchema", + "documentation": "The label schema.
" + } + } + }, + "PutModelResult": { + "type": "structure", + "members": {} + }, + "PutOutcomeRequest": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "shape": "identifier", + "documentation": "The name of the outcome.
" + }, + "description": { + "shape": "description", + "documentation": "The outcome description.
" + } + } + }, + "PutOutcomeResult": { + "type": "structure", + "members": {} + }, + "Role": { + "type": "structure", + "required": [ + "arn", + "name" + ], + "members": { + "arn": { + "shape": "string", + "documentation": "The role ARN.
" + }, + "name": { + "shape": "string", + "documentation": "The role name.
" + } + }, + "documentation": "The role used to invoke external model endpoints.
" + }, + "Rule": { + "type": "structure", + "required": [ + "detectorId", + "ruleId", + "ruleVersion" + ], + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The detector for which the rule is associated.
" + }, + "ruleId": { + "shape": "identifier", + "documentation": "The rule ID.
" + }, + "ruleVersion": { + "shape": "nonEmptyString", + "documentation": "The rule version.
" + } + }, + "documentation": "A rule.
" + }, + "RuleDetail": { + "type": "structure", + "members": { + "ruleId": { + "shape": "identifier", + "documentation": "The rule ID.
" + }, + "description": { + "shape": "description", + "documentation": "The rule description.
" + }, + "detectorId": { + "shape": "identifier", + "documentation": "The detector for which the rule is associated.
" + }, + "ruleVersion": { + "shape": "nonEmptyString", + "documentation": "The rule version.
" + }, + "expression": { + "shape": "ruleExpression", + "documentation": "The rule expression.
" + }, + "language": { + "shape": "Language", + "documentation": "The rule language.
" + }, + "outcomes": { + "shape": "NonEmptyListOfStrings", + "documentation": "The rule outcomes.
" + }, + "lastUpdatedTime": { + "shape": "time", + "documentation": "Timestamp of the last time the rule was updated.
" + }, + "createdTime": { + "shape": "time", + "documentation": "The timestamp of when the rule was created.
" + } + }, + "documentation": "The details of the rule.
" + }, + "RuleDetailList": { + "type": "list", + "member": { + "shape": "RuleDetail" + } + }, + "RuleList": { + "type": "list", + "member": { + "shape": "Rule" + } + }, + "RulesMaxResults": { + "type": "integer", + "box": true, + "max": 100, + "min": 50 + }, + "TrainingDataSource": { + "type": "structure", + "required": [ + "dataLocation", + "dataAccessRoleArn" + ], + "members": { + "dataLocation": { + "shape": "s3BucketLocation", + "documentation": "The data location of the training data source.
" + }, + "dataAccessRoleArn": { + "shape": "iamRoleArn", + "documentation": "The data access role ARN for the training data source.
" + } + }, + "documentation": "The training data source.
" + }, + "UpdateDetectorVersionMetadataRequest": { + "type": "structure", + "required": [ + "detectorId", + "detectorVersionId", + "description" + ], + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The detector ID.
" + }, + "detectorVersionId": { + "shape": "nonEmptyString", + "documentation": "The detector version ID.
" + }, + "description": { + "shape": "description", + "documentation": "The description.
" + } + } + }, + "UpdateDetectorVersionMetadataResult": { + "type": "structure", + "members": {} + }, + "UpdateDetectorVersionRequest": { + "type": "structure", + "required": [ + "detectorId", + "detectorVersionId", + "externalModelEndpoints", + "rules" + ], + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The parent detector ID for the detector version you want to update.
" + }, + "detectorVersionId": { + "shape": "nonEmptyString", + "documentation": "The detector version ID.
" + }, + "externalModelEndpoints": { + "shape": "ListOfStrings", + "documentation": "The Amazon SageMaker model endpoints to include in the detector version.
" + }, + "rules": { + "shape": "RuleList", + "documentation": "The rules to include in the detector version.
" + }, + "description": { + "shape": "description", + "documentation": "The detector version description.
" + }, + "modelVersions": { + "shape": "ListOfModelVersions", + "documentation": "The model versions to include in the detector version.
" + } + } + }, + "UpdateDetectorVersionResult": { + "type": "structure", + "members": {} + }, + "UpdateDetectorVersionStatusRequest": { + "type": "structure", + "required": [ + "detectorId", + "detectorVersionId", + "status" + ], + "members": { + "detectorId": { + "shape": "identifier", + "documentation": "The detector ID.
" + }, + "detectorVersionId": { + "shape": "nonEmptyString", + "documentation": "The detector version ID.
" + }, + "status": { + "shape": "DetectorVersionStatus", + "documentation": "The new status.
" + } + } + }, + "UpdateDetectorVersionStatusResult": { + "type": "structure", + "members": {} + }, + "UpdateModelVersionRequest": { + "type": "structure", + "required": [ + "modelId", + "modelType", + "modelVersionNumber", + "description", + "status" + ], + "members": { + "modelId": { + "shape": "identifier", + "documentation": "The model ID.
" + }, + "modelType": { + "shape": "ModelTypeEnum", + "documentation": "The model type.
" + }, + "modelVersionNumber": { + "shape": "nonEmptyString", + "documentation": "The model version.
" + }, + "description": { + "shape": "description", + "documentation": "The model description.
" + }, + "status": { + "shape": "ModelVersionStatus", + "documentation": "The new model status.
" + } + } + }, + "UpdateModelVersionResult": { + "type": "structure", + "members": {} + }, + "UpdateRuleMetadataRequest": { + "type": "structure", + "required": [ + "rule", + "description" + ], + "members": { + "rule": { + "shape": "Rule", + "documentation": "The rule to update.
" + }, + "description": { + "shape": "description", + "documentation": "The rule description.
" + } + } + }, + "UpdateRuleMetadataResult": { + "type": "structure", + "members": {} + }, + "UpdateRuleVersionRequest": { + "type": "structure", + "required": [ + "rule", + "expression", + "language", + "outcomes" + ], + "members": { + "rule": { + "shape": "Rule", + "documentation": "The rule to update.
" + }, + "description": { + "shape": "description", + "documentation": "The description.
" + }, + "expression": { + "shape": "ruleExpression", + "documentation": "The rule expression.
" + }, + "language": { + "shape": "Language", + "documentation": "The language.
" + }, + "outcomes": { + "shape": "NonEmptyListOfStrings", + "documentation": "The outcomes.
" + } + } + }, + "UpdateRuleVersionResult": { + "type": "structure", + "members": { + "rule": { + "shape": "Rule", + "documentation": "The new rule version that was created.
" + } + } + }, + "UpdateVariableRequest": { + "type": "structure", + "required": [ + "name" + ], + "members": { + "name": { + "shape": "string", + "documentation": "The name of the variable.
" + }, + "defaultValue": { + "shape": "string", + "documentation": "The new default value of the variable.
" + }, + "description": { + "shape": "string", + "documentation": "The new description.
" + }, + "variableType": { + "shape": "string", + "documentation": "The variable type.
" + } + } + }, + "UpdateVariableResult": { + "type": "structure", + "members": {} + }, + "Variable": { + "type": "structure", + "members": { + "name": { + "shape": "string", + "documentation": "The name of the variable.
" + }, + "dataType": { + "shape": "DataType", + "documentation": "The data type of the variable.
" + }, + "dataSource": { + "shape": "DataSource", + "documentation": "The data source of the variable.
" + }, + "defaultValue": { + "shape": "string", + "documentation": "The default value of the variable.
" + }, + "description": { + "shape": "string", + "documentation": "The description of the variable.
" + }, + "variableType": { + "shape": "string", + "documentation": "The variable type of the variable.
" + }, + "lastUpdatedTime": { + "shape": "time", + "documentation": "The time when variable was last updated.
" + }, + "createdTime": { + "shape": "time", + "documentation": "The time when the variable was created.
" + } + }, + "documentation": "The variable.
" + }, + "VariableEntry": { + "type": "structure", + "members": { + "name": { + "shape": "string", + "documentation": "The name of the variable entry.
" + }, + "dataType": { + "shape": "string", + "documentation": "The data type of the variable entry.
" + }, + "dataSource": { + "shape": "string", + "documentation": "The data source of the variable entry.
" + }, + "defaultValue": { + "shape": "string", + "documentation": "The default value of the variable entry.
" + }, + "description": { + "shape": "string", + "documentation": "The description of the variable entry.
" + }, + "variableType": { + "shape": "string", + "documentation": "The type of the variable entry.
" + } + }, + "documentation": "The variable entry in a list.
" + }, + "VariableEntryList": { + "type": "list", + "member": { + "shape": "VariableEntry" + }, + "max": 25, + "min": 1 + }, + "VariableList": { + "type": "list", + "member": { + "shape": "Variable" + } + }, + "VariablesMaxResults": { + "type": "integer", + "box": true, + "max": 100, + "min": 50 + }, + "attributeKey": { + "type": "string", + "max": 64, + "min": 1 + }, + "attributeValue": { + "type": "string", + "max": 256, + "min": 1, + "sensitive": true + }, + "blob": { + "type": "blob" + }, + "contentType": { + "type": "string", + "max": 1024, + "min": 1 + }, + "description": { + "type": "string", + "max": 128, + "min": 1 + }, + "float": { + "type": "float" + }, + "iamRoleArn": { + "type": "string", + "max": 256, + "min": 1, + "pattern": "^arn\\:aws\\:iam\\:\\:[0-9]{12}\\:role\\/[^\\s]{2,64}$" + }, + "identifier": { + "type": "string", + "max": 64, + "min": 1, + "pattern": "^[0-9a-z_-]+$" + }, + "integer": { + "type": "integer" + }, + "nonEmptyString": { + "type": "string", + "min": 1 + }, + "ruleExpression": { + "type": "string", + "max": 4096, + "min": 1 + }, + "s3BucketLocation": { + "type": "string", + "max": 512, + "min": 1, + "pattern": "^s3:\\/\\/[^\\s]+$" + }, + "string": { + "type": "string" + }, + "time": { + "type": "string" + } + }, + "documentation": "This is the Amazon Fraud Detector API Reference. This guide is for developers who need detailed information about Amazon Fraud Detector API actions, data types, and errors. For more information about Amazon Fraud Detector features, see the Amazon Fraud Detector User Guide.
" +} \ No newline at end of file diff --git a/apis/frauddetector-2019-11-15.paginators.json b/apis/frauddetector-2019-11-15.paginators.json new file mode 100644 index 0000000000..b66f8459ad --- /dev/null +++ b/apis/frauddetector-2019-11-15.paginators.json @@ -0,0 +1,39 @@ +{ + "pagination": { + "DescribeModelVersions": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetDetectors": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetExternalModels": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetModels": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetOutcomes": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetRules": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + }, + "GetVariables": { + "input_token": "nextToken", + "output_token": "nextToken", + "limit_key": "maxResults" + } + } +} diff --git a/apis/kendra-2019-02-03.examples.json b/apis/kendra-2019-02-03.examples.json new file mode 100644 index 0000000000..0ea7e3b0bb --- /dev/null +++ b/apis/kendra-2019-02-03.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/apis/kendra-2019-02-03.min.json b/apis/kendra-2019-02-03.min.json new file mode 100644 index 0000000000..ec770605e8 --- /dev/null +++ b/apis/kendra-2019-02-03.min.json @@ -0,0 +1,1080 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-02-03", + "endpointPrefix": "kendra", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "kendra", + "serviceFullName": "AWSKendraFrontendService", + "serviceId": "kendra", + "signatureVersion": "v4", + "signingName": "kendra", + "targetPrefix": "AWSKendraFrontendService", + "uid": "kendra-2019-02-03" + }, + "operations": { + "BatchDeleteDocument": { + "input": { + "type": "structure", + "required": [ + "IndexId", + "DocumentIdList" + ], + "members": { + "IndexId": {}, + "DocumentIdList": { + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedDocuments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + } + } + } + }, + "BatchPutDocument": { + "input": { + "type": "structure", + "required": [ + "IndexId", + "Documents" + ], + "members": { + "IndexId": {}, + "RoleArn": {}, + "Documents": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {}, + "Title": {}, + "Blob": { + "type": "blob" + }, + "S3Path": { + "shape": "Sg" + }, + "Attributes": { + "shape": "Sj" + }, + "AccessControlList": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Type", + "Access" + ], + "members": { + "Name": {}, + "Type": {}, + "Access": {} + } + } + }, + "ContentType": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "FailedDocuments": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "ErrorCode": {}, + "ErrorMessage": {} + } + } + } + } + } + }, + "CreateDataSource": { + "input": { + "type": "structure", + "required": [ + "Name", + "IndexId", + "Type", + "Configuration", + "RoleArn" + ], + "members": { + "Name": {}, + "IndexId": {}, + "Type": {}, + "Configuration": { + "shape": "S14" + }, + "Description": {}, + "Schedule": {}, + "RoleArn": {} + } + }, + "output": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + } + }, + "CreateFaq": { + "input": { + "type": "structure", + "required": [ + "IndexId", + "Name", + "S3Path", + "RoleArn" + ], + "members": { + "IndexId": {}, + "Name": {}, + "Description": {}, + "S3Path": { + "shape": "Sg" + }, + "RoleArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "Id": {} + } + } + }, + "CreateIndex": { + "input": { + "type": "structure", + "required": [ + "Name", + "RoleArn" + ], + "members": { + "Name": {}, + "RoleArn": {}, + "ServerSideEncryptionConfiguration": { + "shape": "S2b" + }, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": { + "Id": {} + } + } + }, + "DeleteFaq": { + "input": { + "type": "structure", + "required": [ + "Id", + "IndexId" + ], + "members": { + "Id": {}, + "IndexId": {} + } + } + }, + "DeleteIndex": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + } + }, + "DescribeDataSource": { + "input": { + "type": "structure", + "required": [ + "Id", + "IndexId" + ], + "members": { + "Id": {}, + "IndexId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Id": {}, + "IndexId": {}, + "Name": {}, + "Type": {}, + "Configuration": { + "shape": "S14" + }, + "CreatedAt": { + "type": "timestamp" + }, + "UpdatedAt": { + "type": "timestamp" + }, + "Description": {}, + "Status": {}, + "Schedule": {}, + "RoleArn": {}, + "ErrorMessage": {} + } + } + }, + "DescribeFaq": { + "input": { + "type": "structure", + "required": [ + "Id", + "IndexId" + ], + "members": { + "Id": {}, + "IndexId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Id": {}, + "IndexId": {}, + "Name": {}, + "Description": {}, + "CreatedAt": { + "type": "timestamp" + }, + "UpdatedAt": { + "type": "timestamp" + }, + "S3Path": { + "shape": "Sg" + }, + "Status": {}, + "RoleArn": {}, + "ErrorMessage": {} + } + } + }, + "DescribeIndex": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {} + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "Id": {}, + "RoleArn": {}, + "ServerSideEncryptionConfiguration": { + "shape": "S2b" + }, + "Status": {}, + "Description": {}, + "CreatedAt": { + "type": "timestamp" + }, + "UpdatedAt": { + "type": "timestamp" + }, + "DocumentMetadataConfigurations": { + "shape": "S2p" + }, + "IndexStatistics": { + "type": "structure", + "required": [ + "FaqStatistics", + "TextDocumentStatistics" + ], + "members": { + "FaqStatistics": { + "type": "structure", + "required": [ + "IndexedQuestionAnswersCount" + ], + "members": { + "IndexedQuestionAnswersCount": { + "type": "integer" + } + } + }, + "TextDocumentStatistics": { + "type": "structure", + "required": [ + "IndexedTextDocumentsCount" + ], + "members": { + "IndexedTextDocumentsCount": { + "type": "integer" + } + } + } + } + }, + "ErrorMessage": {} + } + } + }, + "ListDataSourceSyncJobs": { + "input": { + "type": "structure", + "required": [ + "Id", + "IndexId" + ], + "members": { + "Id": {}, + "IndexId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + }, + "StartTimeFilter": { + "type": "structure", + "members": { + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + } + } + }, + "StatusFilter": {} + } + }, + "output": { + "type": "structure", + "members": { + "History": { + "type": "list", + "member": { + "type": "structure", + "members": { + "ExecutionId": {}, + "StartTime": { + "type": "timestamp" + }, + "EndTime": { + "type": "timestamp" + }, + "Status": {}, + "ErrorMessage": {}, + "ErrorCode": {}, + "DataSourceErrorCode": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListDataSources": { + "input": { + "type": "structure", + "required": [ + "IndexId" + ], + "members": { + "IndexId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "SummaryItems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Name": {}, + "Id": {}, + "Type": {}, + "CreatedAt": { + "type": "timestamp" + }, + "UpdatedAt": { + "type": "timestamp" + }, + "Status": {} + } + } + }, + "NextToken": {} + } + } + }, + "ListFaqs": { + "input": { + "type": "structure", + "required": [ + "IndexId" + ], + "members": { + "IndexId": {}, + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "NextToken": {}, + "FaqSummaryItems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Name": {}, + "Status": {}, + "CreatedAt": { + "type": "timestamp" + }, + "UpdatedAt": { + "type": "timestamp" + } + } + } + } + } + } + }, + "ListIndices": { + "input": { + "type": "structure", + "members": { + "NextToken": {}, + "MaxResults": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "IndexConfigurationSummaryItems": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "CreatedAt", + "UpdatedAt", + "Status" + ], + "members": { + "Name": {}, + "Id": {}, + "CreatedAt": { + "type": "timestamp" + }, + "UpdatedAt": { + "type": "timestamp" + }, + "Status": {} + } + } + }, + "NextToken": {} + } + } + }, + "Query": { + "input": { + "type": "structure", + "required": [ + "IndexId", + "QueryText" + ], + "members": { + "IndexId": {}, + "QueryText": {}, + "AttributeFilter": { + "shape": "S3v" + }, + "Facets": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DocumentAttributeKey": {} + } + } + }, + "RequestedDocumentAttributes": { + "type": "list", + "member": {} + }, + "QueryResultTypeFilter": {}, + "PageNumber": { + "type": "integer" + }, + "PageSize": { + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "QueryId": {}, + "ResultItems": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Id": {}, + "Type": {}, + "AdditionalAttributes": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Key", + "ValueType", + "Value" + ], + "members": { + "Key": {}, + "ValueType": {}, + "Value": { + "type": "structure", + "members": { + "TextWithHighlightsValue": { + "shape": "S4b" + } + } + } + } + } + }, + "DocumentId": {}, + "DocumentTitle": { + "shape": "S4b" + }, + "DocumentExcerpt": { + "shape": "S4b" + }, + "DocumentURI": {}, + "DocumentAttributes": { + "shape": "Sj" + } + } + } + }, + "FacetResults": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DocumentAttributeKey": {}, + "DocumentAttributeValueCountPairs": { + "type": "list", + "member": { + "type": "structure", + "members": { + "DocumentAttributeValue": { + "shape": "Sm" + }, + "Count": { + "type": "integer" + } + } + } + } + } + } + }, + "TotalNumberOfResults": { + "type": "integer" + } + } + } + }, + "StartDataSourceSyncJob": { + "input": { + "type": "structure", + "required": [ + "Id", + "IndexId" + ], + "members": { + "Id": {}, + "IndexId": {} + } + }, + "output": { + "type": "structure", + "members": { + "ExecutionId": {} + } + } + }, + "StopDataSourceSyncJob": { + "input": { + "type": "structure", + "required": [ + "Id", + "IndexId" + ], + "members": { + "Id": {}, + "IndexId": {} + } + } + }, + "SubmitFeedback": { + "input": { + "type": "structure", + "required": [ + "IndexId", + "QueryId" + ], + "members": { + "IndexId": {}, + "QueryId": {}, + "ClickFeedbackItems": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ResultId", + "ClickTime" + ], + "members": { + "ResultId": {}, + "ClickTime": { + "type": "timestamp" + } + } + } + }, + "RelevanceFeedbackItems": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "ResultId", + "RelevanceValue" + ], + "members": { + "ResultId": {}, + "RelevanceValue": {} + } + } + } + } + } + }, + "UpdateDataSource": { + "input": { + "type": "structure", + "required": [ + "Id", + "IndexId" + ], + "members": { + "Id": {}, + "Name": {}, + "IndexId": {}, + "Configuration": { + "shape": "S14" + }, + "Description": {}, + "Schedule": {}, + "RoleArn": {} + } + } + }, + "UpdateIndex": { + "input": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": {}, + "Name": {}, + "RoleArn": {}, + "Description": {}, + "DocumentMetadataConfigurationUpdates": { + "shape": "S2p" + } + } + } + } + }, + "shapes": { + "Sg": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": {}, + "Key": {} + } + }, + "Sj": { + "type": "list", + "member": { + "shape": "Sk" + } + }, + "Sk": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": {}, + "Value": { + "shape": "Sm" + } + } + }, + "Sm": { + "type": "structure", + "members": { + "StringValue": {}, + "StringListValue": { + "type": "list", + "member": {} + }, + "LongValue": { + "type": "long" + }, + "DateValue": { + "type": "timestamp" + } + } + }, + "S14": { + "type": "structure", + "members": { + "S3Configuration": { + "type": "structure", + "required": [ + "BucketName" + ], + "members": { + "BucketName": {}, + "InclusionPrefixes": { + "shape": "S16" + }, + "ExclusionPatterns": { + "shape": "S16" + }, + "DocumentsMetadataConfiguration": { + "type": "structure", + "members": { + "S3Prefix": {} + } + }, + "AccessControlListConfiguration": { + "type": "structure", + "members": { + "KeyPath": {} + } + } + } + }, + "SharePointConfiguration": { + "type": "structure", + "required": [ + "SharePointVersion", + "Urls", + "SecretArn" + ], + "members": { + "SharePointVersion": {}, + "Urls": { + "type": "list", + "member": {} + }, + "SecretArn": {}, + "CrawlAttachments": { + "type": "boolean" + }, + "VpcConfiguration": { + "shape": "S1g" + }, + "FieldMappings": { + "shape": "S1l" + } + } + }, + "DatabaseConfiguration": { + "type": "structure", + "required": [ + "DatabaseEngineType", + "ConnectionConfiguration", + "ColumnConfiguration" + ], + "members": { + "DatabaseEngineType": {}, + "ConnectionConfiguration": { + "type": "structure", + "required": [ + "DatabaseHost", + "DatabasePort", + "DatabaseName", + "TableName", + "SecretArn" + ], + "members": { + "DatabaseHost": {}, + "DatabasePort": { + "type": "integer" + }, + "DatabaseName": {}, + "TableName": {}, + "SecretArn": {} + } + }, + "VpcConfiguration": { + "shape": "S1g" + }, + "ColumnConfiguration": { + "type": "structure", + "required": [ + "DocumentIdColumnName", + "DocumentDataColumnName", + "ChangeDetectingColumns" + ], + "members": { + "DocumentIdColumnName": {}, + "DocumentDataColumnName": {}, + "DocumentTitleColumnName": {}, + "FieldMappings": { + "shape": "S1l" + }, + "ChangeDetectingColumns": { + "type": "list", + "member": {} + } + } + }, + "AclConfiguration": { + "type": "structure", + "required": [ + "AllowedGroupsColumnName" + ], + "members": { + "AllowedGroupsColumnName": {} + } + } + } + } + } + }, + "S16": { + "type": "list", + "member": {} + }, + "S1g": { + "type": "structure", + "required": [ + "SubnetIds", + "SecurityGroupIds" + ], + "members": { + "SubnetIds": { + "type": "list", + "member": {} + }, + "SecurityGroupIds": { + "type": "list", + "member": {} + } + } + }, + "S1l": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "DataSourceFieldName", + "IndexFieldName" + ], + "members": { + "DataSourceFieldName": {}, + "DateFieldFormat": {}, + "IndexFieldName": {} + } + } + }, + "S2b": { + "type": "structure", + "members": { + "KmsKeyId": { + "type": "string", + "sensitive": true + } + } + }, + "S2p": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "Name", + "Type" + ], + "members": { + "Name": {}, + "Type": {}, + "Relevance": { + "type": "structure", + "members": { + "Freshness": { + "type": "boolean" + }, + "Importance": { + "type": "integer" + }, + "Duration": {}, + "RankOrder": {}, + "ValueImportanceMap": { + "type": "map", + "key": {}, + "value": { + "type": "integer" + } + } + } + }, + "Search": { + "type": "structure", + "members": { + "Facetable": { + "type": "boolean" + }, + "Searchable": { + "type": "boolean" + }, + "Displayable": { + "type": "boolean" + } + } + } + } + } + }, + "S3v": { + "type": "structure", + "members": { + "AndAllFilters": { + "shape": "S3w" + }, + "OrAllFilters": { + "shape": "S3w" + }, + "NotFilter": { + "shape": "S3v" + }, + "EqualsTo": { + "shape": "Sk" + }, + "ContainsAll": { + "shape": "Sk" + }, + "ContainsAny": { + "shape": "Sk" + }, + "GreaterThan": { + "shape": "Sk" + }, + "GreaterThanOrEquals": { + "shape": "Sk" + }, + "LessThan": { + "shape": "Sk" + }, + "LessThanOrEquals": { + "shape": "Sk" + } + } + }, + "S3w": { + "type": "list", + "member": { + "shape": "S3v" + } + }, + "S4b": { + "type": "structure", + "members": { + "Text": {}, + "Highlights": { + "type": "list", + "member": { + "type": "structure", + "required": [ + "BeginOffset", + "EndOffset" + ], + "members": { + "BeginOffset": { + "type": "integer" + }, + "EndOffset": { + "type": "integer" + }, + "TopAnswer": { + "type": "boolean" + } + } + } + } + } + } + } +} \ No newline at end of file diff --git a/apis/kendra-2019-02-03.normal.json b/apis/kendra-2019-02-03.normal.json new file mode 100644 index 0000000000..55c0a7cda6 --- /dev/null +++ b/apis/kendra-2019-02-03.normal.json @@ -0,0 +1,2905 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-02-03", + "endpointPrefix": "kendra", + "jsonVersion": "1.1", + "protocol": "json", + "serviceAbbreviation": "kendra", + "serviceFullName": "AWSKendraFrontendService", + "serviceId": "kendra", + "signatureVersion": "v4", + "signingName": "kendra", + "targetPrefix": "AWSKendraFrontendService", + "uid": "kendra-2019-02-03" + }, + "operations": { + "BatchDeleteDocument": { + "name": "BatchDeleteDocument", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "BatchDeleteDocumentRequest" + }, + "output": { + "shape": "BatchDeleteDocumentResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.
The documents are deleted asynchronously. You can see the progress of the deletion by using AWS CloudWatch. Any error messages releated to the processing of the batch are sent to you CloudWatch log.
" + }, + "BatchPutDocument": { + "name": "BatchPutDocument", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "BatchPutDocumentRequest" + }, + "output": { + "shape": "BatchPutDocumentResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Adds one or more documents to an index.
The BatchPutDocument
operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.
The documents are indexed asynchronously. You can see the progress of the batch using AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS CloudWatch log.
" + }, + "CreateDataSource": { + "name": "CreateDataSource", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateDataSourceRequest" + }, + "output": { + "shape": "CreateDataSourceResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ResourceAlreadyExistException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Creates a data source that you use to with an Amazon Kendra index.
You specify a name, connector type and description for your data source. You can choose between an S3 connector, a SharePoint Online connector, and a database connector.
You also specify configuration information such as document metadata (author, source URI, and so on) and user context information.
CreateDataSource
is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.
Creates an new set of frequently asked question (FAQ) questions and answers.
" + }, + "CreateIndex": { + "name": "CreateIndex", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "CreateIndexRequest" + }, + "output": { + "shape": "CreateIndexResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceAlreadyExistException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the Status
field returned from a call to . The Status
field is set to ACTIVE
when the index is ready to use.
Once the index is active you can index your documents using the operation or using one of the supported data sources.
" + }, + "DeleteFaq": { + "name": "DeleteFaq", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteFaqRequest" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Removes an FAQ from an index.
" + }, + "DeleteIndex": { + "name": "DeleteIndex", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DeleteIndexRequest" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Deletes an existing Amazon Kendra index. An exception is not thrown if the index is already being deleted. While the index is being deleted, the Status
field returned by a call to the DescribeIndex operation is set to DELETING
.
Gets information about a Amazon Kendra data source.
" + }, + "DescribeFaq": { + "name": "DescribeFaq", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeFaqRequest" + }, + "output": { + "shape": "DescribeFaqResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Gets information about an FAQ list.
" + }, + "DescribeIndex": { + "name": "DescribeIndex", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "DescribeIndexRequest" + }, + "output": { + "shape": "DescribeIndexResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Describes an existing Amazon Kendra index
" + }, + "ListDataSourceSyncJobs": { + "name": "ListDataSourceSyncJobs", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListDataSourceSyncJobsRequest" + }, + "output": { + "shape": "ListDataSourceSyncJobsResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Gets statistics about synchronizing Amazon Kendra with a data source.
" + }, + "ListDataSources": { + "name": "ListDataSources", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListDataSourcesRequest" + }, + "output": { + "shape": "ListDataSourcesResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Lists the data sources that you have created.
" + }, + "ListFaqs": { + "name": "ListFaqs", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListFaqsRequest" + }, + "output": { + "shape": "ListFaqsResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Gets a list of FAQ lists associated with an index.
" + }, + "ListIndices": { + "name": "ListIndices", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "ListIndicesRequest" + }, + "output": { + "shape": "ListIndicesResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Lists the Amazon Kendra indexes that you have created.
" + }, + "Query": { + "name": "Query", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "QueryRequest" + }, + "output": { + "shape": "QueryResult" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Searches an active index. Use this API to search your documents using query. The Query
operation enables to do faceted search and to filter results based on document attributes.
It also enables you to provide user context that Amazon Kendra uses to enforce document access control in the search results.
Amazon Kendra searches your index for text content and question and answer (FAQ) content. By default the response contains three types of results.
Relevant passages
Matching FAQs
Relevant documents
You can specify that the query return only one type of result using the QueryResultTypeConfig
parameter.
Starts a synchronization job for a data source. If a synchronization job is already in progress, Amazon Kendra returns a ResourceInUseException
exception.
Stops a running synchronization job. You can't stop a scheduled synchronization job.
" + }, + "SubmitFeedback": { + "name": "SubmitFeedback", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "SubmitFeedbackRequest" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceUnavailableException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Enables you to provide feedback to Amazon Kendra to improve the performance of the service.
" + }, + "UpdateDataSource": { + "name": "UpdateDataSource", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdateDataSourceRequest" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Updates an existing Amazon Kendra data source.
" + }, + "UpdateIndex": { + "name": "UpdateIndex", + "http": { + "method": "POST", + "requestUri": "/" + }, + "input": { + "shape": "UpdateIndexRequest" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Updates an existing Amazon Kendra index.
" + } + }, + "shapes": { + "AccessControlListConfiguration": { + "type": "structure", + "members": { + "KeyPath": { + "shape": "S3ObjectKey", + "documentation": "Path to the AWS S3 bucket that contains the ACL files.
" + } + }, + "documentation": "Access Control List files for the documents in a data source.
" + }, + "AclConfiguration": { + "type": "structure", + "required": [ + "AllowedGroupsColumnName" + ], + "members": { + "AllowedGroupsColumnName": { + "shape": "ColumnName", + "documentation": "A list of groups, separated by semi-colons, that filters a query response based on user context. The document is only returned to users that are in one of the groups specified in the UserContext
field of the Query operation.
Provides information about the column that should be used for filtering the query response by groups.
" + }, + "AdditionalResultAttribute": { + "type": "structure", + "required": [ + "Key", + "ValueType", + "Value" + ], + "members": { + "Key": { + "shape": "String", + "documentation": "" + }, + "ValueType": { + "shape": "AdditionalResultAttributeValueType", + "documentation": "" + }, + "Value": { + "shape": "AdditionalResultAttributeValue", + "documentation": "" + } + }, + "documentation": "" + }, + "AdditionalResultAttributeList": { + "type": "list", + "member": { + "shape": "AdditionalResultAttribute" + } + }, + "AdditionalResultAttributeValue": { + "type": "structure", + "members": { + "TextWithHighlightsValue": { + "shape": "TextWithHighlights", + "documentation": "The text associated with the attribute and information about the highlight to apply to the text.
" + } + }, + "documentation": "An attribute returned with a document from a search.
" + }, + "AdditionalResultAttributeValueType": { + "type": "string", + "enum": [ + "TEXT_WITH_HIGHLIGHTS_VALUE" + ] + }, + "AttributeFilter": { + "type": "structure", + "members": { + "AndAllFilters": { + "shape": "AttributeFilterList", + "documentation": "Performs a logical AND
operation on all supplied filters.
Performs a logical OR
operation on all supplied filters.
Performs a logical NOT
operation on all supplied filters.
Performs an equals operation on two document attributes.
" + }, + "ContainsAll": { + "shape": "DocumentAttribute", + "documentation": "Returns true when a document contains all of the specified document attributes.
" + }, + "ContainsAny": { + "shape": "DocumentAttribute", + "documentation": "Returns true when a document contains any of the specified document attributes.
" + }, + "GreaterThan": { + "shape": "DocumentAttribute", + "documentation": "Performs a greater than operation on two document attributes. Use with a document attribute of type Integer
or Long
.
Performs a greater or equals than operation on two document attributes. Use with a document attribute of type Integer
or Long
.
Performs a less than operation on two document attributes. Use with a document attribute of type Integer
or Long
.
Performs a less than or equals operation on two document attributes. Use with a document attribute of type Integer
or Long
.
Provides filtering the query results based on document attributes.
" + }, + "AttributeFilterList": { + "type": "list", + "member": { + "shape": "AttributeFilter" + }, + "max": 5, + "min": 1 + }, + "BatchDeleteDocumentRequest": { + "type": "structure", + "required": [ + "IndexId", + "DocumentIdList" + ], + "members": { + "IndexId": { + "shape": "IndexId", + "documentation": "The identifier of the index that contains the documents to delete.
" + }, + "DocumentIdList": { + "shape": "DocumentIdList", + "documentation": "One or more identifiers for documents to delete from the index.
" + } + } + }, + "BatchDeleteDocumentResponse": { + "type": "structure", + "members": { + "FailedDocuments": { + "shape": "BatchDeleteDocumentResponseFailedDocuments", + "documentation": "A list of documents that could not be removed from the index. Each entry contains an error message that indicates why the document couldn't be removed from the index.
" + } + } + }, + "BatchDeleteDocumentResponseFailedDocument": { + "type": "structure", + "members": { + "Id": { + "shape": "DocumentId", + "documentation": "The identifier of the document that couldn't be removed from the index.
" + }, + "ErrorCode": { + "shape": "ErrorCode", + "documentation": "The error code for why the document couldn't be removed from the index.
" + }, + "ErrorMessage": { + "shape": "ErrorMessage", + "documentation": "An explanation for why the document couldn't be removed from the index.
" + } + }, + "documentation": "Provides information about documents that could not be removed from an index by the BatchDeleteDocument operation.
" + }, + "BatchDeleteDocumentResponseFailedDocuments": { + "type": "list", + "member": { + "shape": "BatchDeleteDocumentResponseFailedDocument" + } + }, + "BatchPutDocumentRequest": { + "type": "structure", + "required": [ + "IndexId", + "Documents" + ], + "members": { + "IndexId": { + "shape": "IndexId", + "documentation": "The identifier of the index to add the documents to. You need to create the index first using the CreateIndex operation.
" + }, + "RoleArn": { + "shape": "RoleArn", + "documentation": "The Amazon Resource Name (ARN) of a role that is allowed to run the BatchPutDocument
operation. For more information, see IAM Roles for Amazon Kendra.
One or more documents to add to the index.
Each document is limited to 5 Mb, the total size of the list is limited to 50 Mb.
" + } + } + }, + "BatchPutDocumentResponse": { + "type": "structure", + "members": { + "FailedDocuments": { + "shape": "BatchPutDocumentResponseFailedDocuments", + "documentation": "A list of documents that were not added to the index because the document failed a validation check. Each document contains an error message that indicates why the document couldn't be added to the index.
If there was an error adding a document to an index the error is reported in your AWS CloudWatch log.
" + } + } + }, + "BatchPutDocumentResponseFailedDocument": { + "type": "structure", + "members": { + "Id": { + "shape": "DocumentId", + "documentation": "The unique identifier of the document.
" + }, + "ErrorCode": { + "shape": "ErrorCode", + "documentation": "The type of error that caused the document to fail to be indexed.
" + }, + "ErrorMessage": { + "shape": "ErrorMessage", + "documentation": "A description of the reason why the document could not be indexed.
" + } + }, + "documentation": "Provides information about a document that could not be indexed.
" + }, + "BatchPutDocumentResponseFailedDocuments": { + "type": "list", + "member": { + "shape": "BatchPutDocumentResponseFailedDocument" + } + }, + "Blob": { + "type": "blob", + "max": 153600, + "min": 1 + }, + "Boolean": { + "type": "boolean" + }, + "ChangeDetectingColumns": { + "type": "list", + "member": { + "shape": "ColumnName" + }, + "max": 5, + "min": 1 + }, + "ClickFeedback": { + "type": "structure", + "required": [ + "ResultId", + "ClickTime" + ], + "members": { + "ResultId": { + "shape": "ResultId", + "documentation": "The unique identifier of the search result that was clicked.
" + }, + "ClickTime": { + "shape": "Timestamp", + "documentation": "The Unix timestamp of the data and time that the result was clicked.
" + } + }, + "documentation": "Gathers information about when a particular result was clicked by a user. Your application uses the SubmitFeedback operation to provide click information.
" + }, + "ClickFeedbackList": { + "type": "list", + "member": { + "shape": "ClickFeedback" + } + }, + "ColumnConfiguration": { + "type": "structure", + "required": [ + "DocumentIdColumnName", + "DocumentDataColumnName", + "ChangeDetectingColumns" + ], + "members": { + "DocumentIdColumnName": { + "shape": "ColumnName", + "documentation": "The column that provides the document's unique identifier.
" + }, + "DocumentDataColumnName": { + "shape": "ColumnName", + "documentation": "The column that contains the contents of the document.
" + }, + "DocumentTitleColumnName": { + "shape": "ColumnName", + "documentation": "The column that contains the title of the document.
" + }, + "FieldMappings": { + "shape": "DataSourceToIndexFieldMappingList", + "documentation": "An array of objects that map database column names to the corresponding fields in an index. You must first create the fields in the index using the UpdateIndex operation.
" + }, + "ChangeDetectingColumns": { + "shape": "ChangeDetectingColumns", + "documentation": "One to five columns that indicate when a document in the database has changed.
" + } + }, + "documentation": "Provides information about how Amazon Kendra should use the columns of a database in an index.
" + }, + "ColumnName": { + "type": "string", + "max": 100, + "min": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$" + }, + "ConnectionConfiguration": { + "type": "structure", + "required": [ + "DatabaseHost", + "DatabasePort", + "DatabaseName", + "TableName", + "SecretArn" + ], + "members": { + "DatabaseHost": { + "shape": "DatabaseHost", + "documentation": "The name of the host for the database. Can be either a string (host.subdomain.domain.tld) or an IPv4 or IPv6 address.
" + }, + "DatabasePort": { + "shape": "DatabasePort", + "documentation": "The port that the database uses for connections.
" + }, + "DatabaseName": { + "shape": "DatabaseName", + "documentation": "The name of the database containing the document data.
" + }, + "TableName": { + "shape": "TableName", + "documentation": "The name of the table that contains the document data.
" + }, + "SecretArn": { + "shape": "SecretArn", + "documentation": "The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Database Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
" + } + }, + "documentation": "Provides the information necessary to connect to a database.
" + }, + "ContentType": { + "type": "string", + "enum": [ + "PDF", + "HTML", + "MS_WORD", + "PLAIN_TEXT", + "PPT" + ] + }, + "CreateDataSourceRequest": { + "type": "structure", + "required": [ + "Name", + "IndexId", + "Type", + "Configuration", + "RoleArn" + ], + "members": { + "Name": { + "shape": "DataSourceName", + "documentation": "A unique name for the data source. A data source name can't be changed without deleting and recreating the data source.
" + }, + "IndexId": { + "shape": "IndexId", + "documentation": "The identifier of the index that should be associated with this data source.
" + }, + "Type": { + "shape": "DataSourceType", + "documentation": "The type of repository that contains the data source.
" + }, + "Configuration": { + "shape": "DataSourceConfiguration", + "documentation": "The connector configuration information that is required to access the repository.
" + }, + "Description": { + "shape": "Description", + "documentation": "A description for the data source.
" + }, + "Schedule": { + "shape": "ScanSchedule", + "documentation": "Sets the frequency that Amazon Kendra will check the documents in your repository and update the index. If you don't set a schedule Amazon Kendra will not periodically update the index. You can call the StartDataSourceSyncJob
operation to update the index.
The Amazon Resource Name (ARN) of a role with permission to access the data source. For more information, see IAM Roles for Amazon Kendra.
" + } + } + }, + "CreateDataSourceResponse": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "DataSourceId", + "documentation": "A unique identifier for the data source.
" + } + } + }, + "CreateFaqRequest": { + "type": "structure", + "required": [ + "IndexId", + "Name", + "S3Path", + "RoleArn" + ], + "members": { + "IndexId": { + "shape": "IndexId", + "documentation": "The identifier of the index that contains the FAQ.
" + }, + "Name": { + "shape": "FaqName", + "documentation": "The name that should be associated with the FAQ.
" + }, + "Description": { + "shape": "Description", + "documentation": "A description of the FAQ.
" + }, + "S3Path": { + "shape": "S3Path", + "documentation": "The S3 location of the FAQ input data.
" + }, + "RoleArn": { + "shape": "RoleArn", + "documentation": "The Amazon Resource Name (ARN) of a role with permission to access the S3 bucket that contains the FAQs. For more information, see IAM Roles for Amazon Kendra.
" + } + } + }, + "CreateFaqResponse": { + "type": "structure", + "members": { + "Id": { + "shape": "FaqId", + "documentation": "The unique identifier of the FAQ.
" + } + } + }, + "CreateIndexRequest": { + "type": "structure", + "required": [ + "Name", + "RoleArn" + ], + "members": { + "Name": { + "shape": "IndexName", + "documentation": "The name for the new index.
" + }, + "RoleArn": { + "shape": "RoleArn", + "documentation": "An IAM role that gives Amazon Kendra permissions to access your Amazon CloudWatch logs and metrics. This is also the role used when you use the BatchPutDocument
operation to index documents from an Amazon S3 bucket.
The identifier of the KMS key to use to encrypt data indexed by Amazon Kendra.
" + }, + "Description": { + "shape": "Description", + "documentation": "A description for the index.
" + } + } + }, + "CreateIndexResponse": { + "type": "structure", + "members": { + "Id": { + "shape": "IndexId", + "documentation": "The unique identifier of the index. Use this identifier when you query an index, set up a data source, or index a document.
" + } + } + }, + "DataSourceConfiguration": { + "type": "structure", + "members": { + "S3Configuration": { + "shape": "S3DataSourceConfiguration", + "documentation": "Provides information to create a connector for a document repository in an Amazon S3 bucket.
" + }, + "SharePointConfiguration": { + "shape": "SharePointConfiguration", + "documentation": "Provides information necessary to create a connector for a Microsoft SharePoint site.
" + }, + "DatabaseConfiguration": { + "shape": "DatabaseConfiguration", + "documentation": "Provides information necessary to create a connector for a database.
" + } + }, + "documentation": "Configuration information for a Amazon Kendra data source.
" + }, + "DataSourceDateFieldFormat": { + "type": "string", + "max": 40, + "min": 4 + }, + "DataSourceFieldName": { + "type": "string", + "max": 100, + "min": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$" + }, + "DataSourceId": { + "type": "string", + "max": 100, + "min": 1, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "DataSourceInclusionsExclusionsStrings": { + "type": "list", + "member": { + "shape": "DataSourceInclusionsExclusionsStringsMember" + }, + "max": 100, + "min": 0 + }, + "DataSourceInclusionsExclusionsStringsMember": { + "type": "string", + "max": 50, + "min": 1, + "pattern": "^\\P{C}*$" + }, + "DataSourceName": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "DataSourceStatus": { + "type": "string", + "enum": [ + "CREATING", + "DELETING", + "FAILED", + "UPDATING", + "ACTIVE" + ] + }, + "DataSourceSummary": { + "type": "structure", + "members": { + "Name": { + "shape": "DataSourceName", + "documentation": "The name of the data source.
" + }, + "Id": { + "shape": "DataSourceId", + "documentation": "The unique identifier for the data source.
" + }, + "Type": { + "shape": "DataSourceType", + "documentation": "The type of the data source.
" + }, + "CreatedAt": { + "shape": "Timestamp", + "documentation": "The UNIX datetime that the data source was created.
" + }, + "UpdatedAt": { + "shape": "Timestamp", + "documentation": "The UNIX datetime that the data source was lasted updated.
" + }, + "Status": { + "shape": "DataSourceStatus", + "documentation": "The status of the data source. When the status is ATIVE
the data source is ready to use.
Summary information for a Amazon Kendra data source. Returned in a call to .
" + }, + "DataSourceSummaryList": { + "type": "list", + "member": { + "shape": "DataSourceSummary" + } + }, + "DataSourceSyncJob": { + "type": "structure", + "members": { + "ExecutionId": { + "shape": "String", + "documentation": "A unique identifier for the synchronization job.
" + }, + "StartTime": { + "shape": "Timestamp", + "documentation": "The UNIX datetime that the synchronization job was started.
" + }, + "EndTime": { + "shape": "Timestamp", + "documentation": "The UNIX datetime that the synchronization job was completed.
" + }, + "Status": { + "shape": "DataSourceSyncJobStatus", + "documentation": "The execution status of the synchronization job. When the Status
field is set to SUCCEEDED
, the synchronization job is done. If the status code is set to FAILED
, the ErrorCode
and ErrorMessage
fields give you the reason for the failure.
If the Status
field is set to ERROR
, the ErrorMessage
field contains a description of the error that caused the synchronization to fail.
If the Status
field is set to FAILED
, the ErrorCode
field contains a the reason that the synchronization failed.
If the reason that the synchronization failed is due to an error with the underlying data source, this field contains a code that identifies the error.
" + } + }, + "documentation": "Provides information about a synchronization job.
" + }, + "DataSourceSyncJobHistoryList": { + "type": "list", + "member": { + "shape": "DataSourceSyncJob" + } + }, + "DataSourceSyncJobStatus": { + "type": "string", + "enum": [ + "FAILED", + "SUCCEEDED", + "SYNCING", + "INCOMPLETE", + "STOPPING", + "ABORTED" + ] + }, + "DataSourceToIndexFieldMapping": { + "type": "structure", + "required": [ + "DataSourceFieldName", + "IndexFieldName" + ], + "members": { + "DataSourceFieldName": { + "shape": "DataSourceFieldName", + "documentation": "The name of the column or attribute in the data source.
" + }, + "DateFieldFormat": { + "shape": "DataSourceDateFieldFormat", + "documentation": "The type of data stored in the column or attribute.
" + }, + "IndexFieldName": { + "shape": "IndexFieldName", + "documentation": "The name of the field in the index.
" + } + }, + "documentation": "Maps a column or attribute in the data source to an index field. You must first create the fields in the index using the UpdateIndex operation.
" + }, + "DataSourceToIndexFieldMappingList": { + "type": "list", + "member": { + "shape": "DataSourceToIndexFieldMapping" + }, + "max": 100, + "min": 1 + }, + "DataSourceType": { + "type": "string", + "enum": [ + "S3", + "SHAREPOINT", + "DATABASE" + ] + }, + "DataSourceVpcConfiguration": { + "type": "structure", + "required": [ + "SubnetIds", + "SecurityGroupIds" + ], + "members": { + "SubnetIds": { + "shape": "SubnetIdList", + "documentation": "A list of identifiers for subnets within your Amazon VPC. The subnets should be able to connect to each other in the VPC, and they should have outgoing access to the Internet through a NAT device.
" + }, + "SecurityGroupIds": { + "shape": "SecurityGroupIdList", + "documentation": "A list of identifiers of security groups within your Amazon VPC. The security groups should enable Amazon Kendra to connect to the data source.
" + } + }, + "documentation": "Provides information for connecting to an Amazon VPC.
" + }, + "DatabaseConfiguration": { + "type": "structure", + "required": [ + "DatabaseEngineType", + "ConnectionConfiguration", + "ColumnConfiguration" + ], + "members": { + "DatabaseEngineType": { + "shape": "DatabaseEngineType", + "documentation": "The type of database engine that runs the database.
" + }, + "ConnectionConfiguration": { + "shape": "ConnectionConfiguration", + "documentation": "The information necessary to connect to a database.
" + }, + "VpcConfiguration": { + "shape": "DataSourceVpcConfiguration" + }, + "ColumnConfiguration": { + "shape": "ColumnConfiguration", + "documentation": "Information about where the index should get the document information from the database.
" + }, + "AclConfiguration": { + "shape": "AclConfiguration", + "documentation": "Information about the database column that provides information for user context filtering.
" + } + }, + "documentation": "Provides the information necessary to connect a database to an index.
" + }, + "DatabaseEngineType": { + "type": "string", + "enum": [ + "RDS_AURORA_MYSQL", + "RDS_AURORA_POSTGRESQL", + "RDS_MYSQL", + "RDS_POSTGRESQL" + ] + }, + "DatabaseHost": { + "type": "string", + "max": 253, + "min": 1 + }, + "DatabaseName": { + "type": "string", + "max": 100, + "min": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$" + }, + "DatabasePort": { + "type": "integer", + "max": 65535, + "min": 1 + }, + "DeleteFaqRequest": { + "type": "structure", + "required": [ + "Id", + "IndexId" + ], + "members": { + "Id": { + "shape": "FaqId", + "documentation": "The identifier of the FAQ to remove.
" + }, + "IndexId": { + "shape": "IndexId", + "documentation": "The index to remove the FAQ from.
" + } + } + }, + "DeleteIndexRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "IndexId", + "documentation": "The identifier of the index to delete.
" + } + } + }, + "DescribeDataSourceRequest": { + "type": "structure", + "required": [ + "Id", + "IndexId" + ], + "members": { + "Id": { + "shape": "DataSourceId", + "documentation": "The unique identifier of the data source to describe.
" + }, + "IndexId": { + "shape": "IndexId", + "documentation": "The identifier of the index that contains the data source.
" + } + } + }, + "DescribeDataSourceResponse": { + "type": "structure", + "members": { + "Id": { + "shape": "DataSourceId", + "documentation": "The identifier of the data source.
" + }, + "IndexId": { + "shape": "IndexId", + "documentation": "The identifier of the index that contains the data source.
" + }, + "Name": { + "shape": "DataSourceName", + "documentation": "The name that you gave the data source when it was created.
" + }, + "Type": { + "shape": "DataSourceType", + "documentation": "The type of the data source.
" + }, + "Configuration": { + "shape": "DataSourceConfiguration", + "documentation": "Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.
" + }, + "CreatedAt": { + "shape": "Timestamp", + "documentation": "The Unix timestamp of when the data source was created.
" + }, + "UpdatedAt": { + "shape": "Timestamp", + "documentation": "The Unix timestamp of when the data source was last updated.
" + }, + "Description": { + "shape": "Description", + "documentation": "The description of the data source.
" + }, + "Status": { + "shape": "DataSourceStatus", + "documentation": "The current status of the data source. When the status is ACTIVE
the data source is ready to use. When the status is FAILED
, the ErrorMessage
field contains the reason that the data source failed.
The schedule that Amazon Kendra will update the data source.
" + }, + "RoleArn": { + "shape": "RoleArn", + "documentation": "The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
" + }, + "ErrorMessage": { + "shape": "ErrorMessage", + "documentation": "When the Status
field value is FAILED
, the ErrorMessage
field contains a description of the error that caused the data source to fail.
The unique identifier of the FAQ.
" + }, + "IndexId": { + "shape": "IndexId", + "documentation": "The identifier of the index that contains the FAQ.
" + } + } + }, + "DescribeFaqResponse": { + "type": "structure", + "members": { + "Id": { + "shape": "FaqId", + "documentation": "The identifier of the FAQ.
" + }, + "IndexId": { + "shape": "IndexId", + "documentation": "The identifier of the index that contains the FAQ.
" + }, + "Name": { + "shape": "FaqName", + "documentation": "The name that you gave the FAQ when it was created.
" + }, + "Description": { + "shape": "Description", + "documentation": "The description of the FAQ that you provided when it was created.
" + }, + "CreatedAt": { + "shape": "Timestamp", + "documentation": "The date and time that the FAQ was created.
" + }, + "UpdatedAt": { + "shape": "Timestamp", + "documentation": "The date and time that the FAQ was last updated.
" + }, + "S3Path": { + "shape": "S3Path" + }, + "Status": { + "shape": "FaqStatus", + "documentation": "The status of the FAQ. It is ready to use when the status is ACTIVE
.
The Amazon Resource Name (ARN) of the role that provides access to the S3 bucket containing the input files for the FAQ.
" + }, + "ErrorMessage": { + "shape": "ErrorMessage", + "documentation": "If the Status
field is FAILED
, the ErrorMessage
field contains the reason why the FAQ failed.
The name of the index to describe.
" + } + } + }, + "DescribeIndexResponse": { + "type": "structure", + "members": { + "Name": { + "shape": "IndexName", + "documentation": "The name of the index.
" + }, + "Id": { + "shape": "IndexId", + "documentation": "the name of the index.
" + }, + "RoleArn": { + "shape": "RoleArn", + "documentation": "The Amazon Resource Name (ARN) of the IAM role that gives Amazon Kendra permission to write to your Amazon Cloudwatch logs.
" + }, + "ServerSideEncryptionConfiguration": { + "shape": "ServerSideEncryptionConfiguration", + "documentation": "The identifier of the KMS key used to encrypt your data.
" + }, + "Status": { + "shape": "IndexStatus", + "documentation": "The current status of the index. When the value is ACTIVE
, the index is ready for use. If the Status
field value is FAILED
, the ErrorMessage
field contains a message that explains why.
The description of the index.
" + }, + "CreatedAt": { + "shape": "Timestamp", + "documentation": "The Unix datetime that the index was created.
" + }, + "UpdatedAt": { + "shape": "Timestamp", + "documentation": "The Unix datetime that the index was last updated.
" + }, + "DocumentMetadataConfigurations": { + "shape": "DocumentMetadataConfigurationList", + "documentation": "Configuration settings for any metadata applied to the documents in the index.
" + }, + "IndexStatistics": { + "shape": "IndexStatistics", + "documentation": "Provides information about the number of FAQ questions and answers and the number of text documents indexed.
" + }, + "ErrorMessage": { + "shape": "ErrorMessage", + "documentation": "When th eStatus
field value is FAILED
, the ErrorMessage
field contains a message that explains why.
A unique identifier of the document in the index.
" + }, + "Title": { + "shape": "Title", + "documentation": "The title of the document.
" + }, + "Blob": { + "shape": "Blob", + "documentation": "The contents of the document as a base-64 encoded string.
" + }, + "S3Path": { + "shape": "S3Path" + }, + "Attributes": { + "shape": "DocumentAttributeList", + "documentation": "Custom attributes to apply to the document. Use the custom attributes to provide additional information for searching, to provide facets for refining searches, and to provide additional information in the query response.
" + }, + "AccessControlList": { + "shape": "PrincipalList", + "documentation": "Information to use for user context filtering.
" + }, + "ContentType": { + "shape": "ContentType", + "documentation": "The file type of the document in the Blob
field.
A document in an index.
" + }, + "DocumentAttribute": { + "type": "structure", + "required": [ + "Key", + "Value" + ], + "members": { + "Key": { + "shape": "DocumentAttributeKey", + "documentation": "The identifier for the attribute.
" + }, + "Value": { + "shape": "DocumentAttributeValue", + "documentation": "The value of the attribute.
" + } + }, + "documentation": "A custom attribute value assigned to a document.
" + }, + "DocumentAttributeKey": { + "type": "string", + "max": 200, + "min": 1, + "pattern": "[a-zA-Z0-9_][a-zA-Z0-9_-]*" + }, + "DocumentAttributeKeyList": { + "type": "list", + "member": { + "shape": "DocumentAttributeKey" + }, + "max": 100, + "min": 1 + }, + "DocumentAttributeList": { + "type": "list", + "member": { + "shape": "DocumentAttribute" + }, + "max": 100, + "min": 1 + }, + "DocumentAttributeStringListValue": { + "type": "list", + "member": { + "shape": "String" + }, + "max": 5, + "min": 1 + }, + "DocumentAttributeStringValue": { + "type": "string", + "max": 2048, + "min": 1, + "pattern": "^\\P{C}*$" + }, + "DocumentAttributeValue": { + "type": "structure", + "members": { + "StringValue": { + "shape": "DocumentAttributeStringValue", + "documentation": "A string, such as \"department\".
" + }, + "StringListValue": { + "shape": "DocumentAttributeStringListValue", + "documentation": "A list of strings.
" + }, + "LongValue": { + "shape": "Long", + "documentation": "A long integer value.
" + }, + "DateValue": { + "shape": "Timestamp", + "documentation": "A date value expressed as seconds from the Unix epoch.
" + } + }, + "documentation": "The value of a custom document attribute. You can only provide one value for a custom attribute.
" + }, + "DocumentAttributeValueCountPair": { + "type": "structure", + "members": { + "DocumentAttributeValue": { + "shape": "DocumentAttributeValue", + "documentation": "The value of the attribute. For example, \"HR.\"
" + }, + "Count": { + "shape": "Integer", + "documentation": "The number of documents in the response that have the attribute value for the key.
" + } + }, + "documentation": "Provides the count of documents that match a particular attribute when doing a faceted search.
" + }, + "DocumentAttributeValueCountPairList": { + "type": "list", + "member": { + "shape": "DocumentAttributeValueCountPair" + } + }, + "DocumentAttributeValueType": { + "type": "string", + "enum": [ + "STRING_VALUE", + "STRING_LIST_VALUE", + "LONG_VALUE", + "DATE_VALUE" + ] + }, + "DocumentId": { + "type": "string", + "max": 2048, + "min": 1 + }, + "DocumentIdList": { + "type": "list", + "member": { + "shape": "DocumentId" + }, + "max": 10, + "min": 1 + }, + "DocumentList": { + "type": "list", + "member": { + "shape": "Document" + }, + "max": 10, + "min": 1 + }, + "DocumentMetadataBoolean": { + "type": "boolean" + }, + "DocumentMetadataConfiguration": { + "type": "structure", + "required": [ + "Name", + "Type" + ], + "members": { + "Name": { + "shape": "DocumentMetadataConfigurationName", + "documentation": "The name of the index field.
" + }, + "Type": { + "shape": "DocumentAttributeValueType", + "documentation": "The data type of the index field.
" + }, + "Relevance": { + "shape": "Relevance", + "documentation": "Provides manual tuning parameters to determine how the field affects the search results.
" + }, + "Search": { + "shape": "Search", + "documentation": "Provides information about how the field is used during a search.
" + } + }, + "documentation": "Specifies the properties of a custom index field.
" + }, + "DocumentMetadataConfigurationList": { + "type": "list", + "member": { + "shape": "DocumentMetadataConfiguration" + }, + "max": 500, + "min": 0 + }, + "DocumentMetadataConfigurationName": { + "type": "string", + "max": 30, + "min": 1 + }, + "DocumentsMetadataConfiguration": { + "type": "structure", + "members": { + "S3Prefix": { + "shape": "S3ObjectKey", + "documentation": "A prefix used to filter metadata configuration files in the AWS S3 bucket. The S3 bucket might contain multiple metadata files. Use S3Prefix
to include only the desired metadata files.
Document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.
" + }, + "Duration": { + "type": "string", + "max": 10, + "min": 1, + "pattern": "[0-9]+[s]" + }, + "ErrorCode": { + "type": "string", + "enum": [ + "InternalError", + "InvalidRequest" + ] + }, + "ErrorMessage": { + "type": "string", + "max": 2048, + "min": 1, + "pattern": "^\\P{C}*$" + }, + "Facet": { + "type": "structure", + "members": { + "DocumentAttributeKey": { + "shape": "DocumentAttributeKey", + "documentation": "The unique key for the document attribute.
" + } + }, + "documentation": "Information a document attribute
" + }, + "FacetList": { + "type": "list", + "member": { + "shape": "Facet" + } + }, + "FacetResult": { + "type": "structure", + "members": { + "DocumentAttributeKey": { + "shape": "DocumentAttributeKey", + "documentation": "The key for the facet values. This is the same as the DocumentAttributeKey
provided in the query.
An array of key/value pairs, where the key is the value of the attribute and the count is the number of documents that share the key value.
" + } + }, + "documentation": "The facet values for the documents in the response.
" + }, + "FacetResultList": { + "type": "list", + "member": { + "shape": "FacetResult" + } + }, + "FaqId": { + "type": "string", + "max": 100, + "min": 1, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "FaqName": { + "type": "string", + "max": 100, + "min": 1, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "FaqStatistics": { + "type": "structure", + "required": [ + "IndexedQuestionAnswersCount" + ], + "members": { + "IndexedQuestionAnswersCount": { + "shape": "IndexedQuestionAnswersCount", + "documentation": "The total number of FAQ questions and answers contained in the index.
" + } + }, + "documentation": "Provides statistical information about the FAQ questions and answers contained in an index.
" + }, + "FaqStatus": { + "type": "string", + "enum": [ + "CREATING", + "UPDATING", + "ACTIVE", + "DELETING", + "FAILED" + ] + }, + "FaqSummary": { + "type": "structure", + "members": { + "Id": { + "shape": "FaqId", + "documentation": "The unique identifier of the FAQ.
" + }, + "Name": { + "shape": "FaqName", + "documentation": "The name that you assigned the FAQ when you created or updated the FAQ.
" + }, + "Status": { + "shape": "FaqStatus", + "documentation": "The current status of the FAQ. When the status is ACTIVE
the FAQ is ready for use.
The UNIX datetime that the FAQ was added to the index.
" + }, + "UpdatedAt": { + "shape": "Timestamp", + "documentation": "The UNIX datetime that the FAQ was last updated.
" + } + }, + "documentation": "Provides information about a frequently asked questions and answer contained in an index.
" + }, + "FaqSummaryItems": { + "type": "list", + "member": { + "shape": "FaqSummary" + } + }, + "Highlight": { + "type": "structure", + "required": [ + "BeginOffset", + "EndOffset" + ], + "members": { + "BeginOffset": { + "shape": "Integer", + "documentation": "The zero-based location in the response string where the highlight starts.
" + }, + "EndOffset": { + "shape": "Integer", + "documentation": "The zero-based location in the response string where the highlight ends.
" + }, + "TopAnswer": { + "shape": "Boolean", + "documentation": "Indicates whether the response is the best response. True if this is the best response; otherwise, false.
" + } + }, + "documentation": "Provides information that you can use to highlight a search result so that your users can quickly identify terms in the response.
" + }, + "HighlightList": { + "type": "list", + "member": { + "shape": "Highlight" + } + }, + "Importance": { + "type": "integer", + "max": 10, + "min": 1 + }, + "IndexConfigurationSummary": { + "type": "structure", + "required": [ + "CreatedAt", + "UpdatedAt", + "Status" + ], + "members": { + "Name": { + "shape": "IndexName", + "documentation": "The name of the index.
" + }, + "Id": { + "shape": "IndexId", + "documentation": "A unique identifier for the index. Use this to identify the index when you are using operations such as Query
, DescribeIndex
, UpdateIndex
, and DeleteIndex
.
The Unix timestamp when the index was created.
" + }, + "UpdatedAt": { + "shape": "Timestamp", + "documentation": "The Unix timestamp when the index was last updated by the UpdateIndex
operation.
The current status of the index. When the status is ACTIVE
, the index is ready to search.
A summary of information about an index.
" + }, + "IndexConfigurationSummaryList": { + "type": "list", + "member": { + "shape": "IndexConfigurationSummary" + } + }, + "IndexFieldName": { + "type": "string", + "max": 30, + "min": 1, + "pattern": "^\\P{C}*$" + }, + "IndexId": { + "type": "string", + "max": 36, + "min": 36, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9-]*" + }, + "IndexName": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": "[a-zA-Z0-9][a-zA-Z0-9_-]*" + }, + "IndexStatistics": { + "type": "structure", + "required": [ + "FaqStatistics", + "TextDocumentStatistics" + ], + "members": { + "FaqStatistics": { + "shape": "FaqStatistics", + "documentation": "The number of question and answer topics in the index.
" + }, + "TextDocumentStatistics": { + "shape": "TextDocumentStatistics", + "documentation": "The number of text documents indexed.
" + } + }, + "documentation": "Provides information about the number of documents and the number of questions and answers in an index.
" + }, + "IndexStatus": { + "type": "string", + "enum": [ + "CREATING", + "ACTIVE", + "DELETING", + "FAILED", + "SYSTEM_UPDATING" + ] + }, + "IndexedQuestionAnswersCount": { + "type": "integer", + "min": 0 + }, + "IndexedTextDocumentsCount": { + "type": "integer", + "min": 0 + }, + "Integer": { + "type": "integer" + }, + "KmsKeyId": { + "type": "string", + "max": 2048, + "min": 1, + "sensitive": true + }, + "ListDataSourceSyncJobsRequest": { + "type": "structure", + "required": [ + "Id", + "IndexId" + ], + "members": { + "Id": { + "shape": "DataSourceId", + "documentation": "The identifier of the data source.
" + }, + "IndexId": { + "shape": "IndexId", + "documentation": "The identifier of the index that contains the data source.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "If the result of the previous request to GetDataSourceSyncJobHistory
was truncated, include the NextToken
to fetch the next set of jobs.
The maximum number of synchronization jobs to return in the response. If there are fewer results in the list, this response contains only the actual results.
" + }, + "StartTimeFilter": { + "shape": "TimeRange", + "documentation": "When specified, the synchronization jobs returned in the list are limited to jobs between the specified dates.
" + }, + "StatusFilter": { + "shape": "DataSourceSyncJobStatus", + "documentation": "When specified, only returns synchronization jobs with the Status
field equal to the specified status.
A history of synchronization jobs for the data source.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "The GetDataSourceSyncJobHistory
operation returns a page of vocabularies at a time. The maximum size of the page is set by the MaxResults
parameter. If there are more jobs in the list than the page size, Amazon Kendra returns the NextPage token. Include the token in the next request to the GetDataSourceSyncJobHistory
operation to return in the next page of jobs.
The identifier of the index that contains the data source.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of data sources (DataSourceSummaryItems
).
The maximum number of data sources to return.
" + } + } + }, + "ListDataSourcesResponse": { + "type": "structure", + "members": { + "SummaryItems": { + "shape": "DataSourceSummaryList", + "documentation": "An array of summary information for one or more data sources.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of data sources.
" + } + } + }, + "ListFaqsRequest": { + "type": "structure", + "required": [ + "IndexId" + ], + "members": { + "IndexId": { + "shape": "IndexId", + "documentation": "The index that contains the FAQ lists.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "If the result of the previous request to ListFaqs
was truncated, include the NextToken
to fetch the next set of FAQs.
The maximum number of FAQs to return in the response. If there are fewer results in the list, this response contains only the actual results.
" + } + } + }, + "ListFaqsResponse": { + "type": "structure", + "members": { + "NextToken": { + "shape": "NextToken", + "documentation": "The ListFaqs
operation returns a page of FAQs at a time. The maximum size of the page is set by the MaxResults
parameter. If there are more jobs in the list than the page size, Amazon Kendra returns the NextPage
token. Include the token in the next request to the ListFaqs
operation to return the next page of FAQs.
information about the FAQs associated with the specified index.
" + } + } + }, + "ListIndicesRequest": { + "type": "structure", + "members": { + "NextToken": { + "shape": "NextToken", + "documentation": "If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of indexes (DataSourceSummaryItems
).
The maximum number of data sources to return.
" + } + } + }, + "ListIndicesResponse": { + "type": "structure", + "members": { + "IndexConfigurationSummaryItems": { + "shape": "IndexConfigurationSummaryList", + "documentation": "An array of summary information for one or more indexes.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of indexes.
" + } + } + }, + "Long": { + "type": "long" + }, + "MaxResultsIntegerForListDataSourceSyncJobsRequest": { + "type": "integer", + "max": 10, + "min": 1 + }, + "MaxResultsIntegerForListDataSourcesRequest": { + "type": "integer", + "max": 100, + "min": 1 + }, + "MaxResultsIntegerForListFaqsRequest": { + "type": "integer", + "max": 100, + "min": 1 + }, + "MaxResultsIntegerForListIndicesRequest": { + "type": "integer", + "max": 100, + "min": 1 + }, + "NextToken": { + "type": "string", + "max": 800, + "min": 1 + }, + "Order": { + "type": "string", + "enum": [ + "ASCENDING", + "DESCENDING" + ] + }, + "Principal": { + "type": "structure", + "required": [ + "Name", + "Type", + "Access" + ], + "members": { + "Name": { + "shape": "PrincipalName", + "documentation": "The name of the user or group.
" + }, + "Type": { + "shape": "PrincipalType", + "documentation": "The type of principal.
" + }, + "Access": { + "shape": "ReadAccessType", + "documentation": "Whether to allow or deny access to the principal.
" + } + }, + "documentation": "Provides user and group information for document access filtering.
" + }, + "PrincipalList": { + "type": "list", + "member": { + "shape": "Principal" + }, + "max": 200, + "min": 1 + }, + "PrincipalName": { + "type": "string", + "max": 200, + "min": 1, + "pattern": "^[^'/\\[\\]:=,;?*\\\\\\u0022\\u003C\\u003E]*$" + }, + "PrincipalType": { + "type": "string", + "enum": [ + "USER", + "GROUP" + ] + }, + "QueryId": { + "type": "string", + "max": 36, + "min": 1 + }, + "QueryRequest": { + "type": "structure", + "required": [ + "IndexId", + "QueryText" + ], + "members": { + "IndexId": { + "shape": "IndexId", + "documentation": "The unique identifier of the index to search. The identifier is returned in the response from the operation.
" + }, + "QueryText": { + "shape": "QueryText", + "documentation": "The text to search for.
" + }, + "AttributeFilter": { + "shape": "AttributeFilter", + "documentation": "Enables filtered searches based on document attributes. You can only provide one attribute filter; however, the AndAllFilters
, NotFilter
, and OrAllFilters
parameters contain a list of other filters.
The AttributeFilter
parameter enables you to create a set of filtering rules that a document must satisfy to be included in the query results.
An array of documents attributes. Amazon Kendra returns a count for each attribute key specified. You can use this information to help narrow the search for your user.
" + }, + "RequestedDocumentAttributes": { + "shape": "DocumentAttributeKeyList", + "documentation": "An array of document attributes to include in the response. No other document attributes are included in the response. By default all document attributes are included in the response.
" + }, + "QueryResultTypeFilter": { + "shape": "QueryResultType", + "documentation": "Sets the type of query. Only results for the specified query type are returned.
" + }, + "PageNumber": { + "shape": "Integer", + "documentation": "Query results are returned in pages the size of the PageSize
parameter. By default, Amazon Kendra returns the first page of results. Use this parameter to get result pages after the first one.
Sets the number of results that are returned in each page of results. The default page size is 100.
" + } + } + }, + "QueryResult": { + "type": "structure", + "members": { + "QueryId": { + "shape": "QueryId", + "documentation": "The unique identifier for the search. You use QueryId
to identify the search when using the feedback API.
The results of the search.
" + }, + "FacetResults": { + "shape": "FacetResultList", + "documentation": "Contains the facet results. A FacetResult
contains the counts for each attribute key that was specified in the Facets
input parameter.
The number of items returned by the search. Use this to determine when you have requested the last set of results.
" + } + } + }, + "QueryResultItem": { + "type": "structure", + "members": { + "Id": { + "shape": "ResultId", + "documentation": "The unique identifier for the query result.
" + }, + "Type": { + "shape": "QueryResultType", + "documentation": "The type of document.
" + }, + "AdditionalAttributes": { + "shape": "AdditionalResultAttributeList", + "documentation": "" + }, + "DocumentId": { + "shape": "DocumentId", + "documentation": "The unique identifier for the document.
" + }, + "DocumentTitle": { + "shape": "TextWithHighlights", + "documentation": "The title of the document. Contains the text of the title and information for highlighting the relevant terms in the title.
" + }, + "DocumentExcerpt": { + "shape": "TextWithHighlights", + "documentation": "An extract of the text in the document. Contains information about highlighting the relevant terms in the excerpt.
" + }, + "DocumentURI": { + "shape": "Url", + "documentation": "The URI of the original location of the document.
" + }, + "DocumentAttributes": { + "shape": "DocumentAttributeList", + "documentation": "An array of document attributes for the document that the query result maps to. For example, the document author (Author) or the source URI (SourceUri) of the document.
" + } + }, + "documentation": "A single query result.
A query result contains information about a document returned by the query. This includes the original location of the document, a list of attributes assigned to the document, and relevant text from the document that satisfies the query.
" + }, + "QueryResultItemList": { + "type": "list", + "member": { + "shape": "QueryResultItem" + } + }, + "QueryResultType": { + "type": "string", + "enum": [ + "DOCUMENT", + "QUESTION_ANSWER", + "ANSWER" + ] + }, + "QueryText": { + "type": "string", + "max": 1000, + "min": 1, + "pattern": "^\\P{C}*$" + }, + "ReadAccessType": { + "type": "string", + "enum": [ + "ALLOW", + "DENY" + ] + }, + "Relevance": { + "type": "structure", + "members": { + "Freshness": { + "shape": "DocumentMetadataBoolean", + "documentation": "Indicates that this field determines how \"fresh\" a document is. For example, if document 1 was created on November 5, and document 2 was created on October 31, document 1 is \"fresher\" than document 2. You can only set the Freshness
field on one DATE
type field. Only applies to DATE
fields.
The relative importance of the field in the search. Larger numbers provide more of a boost than smaller numbers.
" + }, + "Duration": { + "shape": "Duration", + "documentation": "Specifies the time period that the boost applies to. For example, to make the boost apply to documents with the field value within the last month, you would use \"2628000s\". Once the field value is beyond the specified range, the effect of the boost drops off. The higher the importance, the faster the effect drops off. If you don't specify a value, the default is 3 months. The value of the field is a numeric string followed by the character \"s\", for example \"86400s\" for one day, or \"604800s\" for one week.
Only applies to DATE
fields.
Determines how values should be interpreted.
When the RankOrder
field is ASCENDING
, higher numbers are better. For example, a document with a rating score of 10 is higher ranking than a document with a rating score of 1.
When the RankOrder
field is DESCENDING
, lower numbers are better. For example, in a task tracking application, a priority 1 task is more important than a priority 5 task.
Only applies to LONG
and DOUBLE
fields.
A list of values that should be given a different boost when they appear in the result list. For example, if you are boosting a field called \"department,\" query terms that match the department field are boosted in the result. However, you can add entries from the department field to boost documents with those values higher.
For example, you can add entries to the map with names of departments. If you add \"HR\",5 and \"Legal\",3 those departments are given special attention when they appear in the metadata of a document. When those terms appear they are given the specified importance instead of the regular importance for the boost.
" + } + }, + "documentation": "Provides information for manually tuning the relevance of a field in a search. When a query includes terms that match the field, the results are given a boost in the response based on these tuning parameters.
" + }, + "RelevanceFeedback": { + "type": "structure", + "required": [ + "ResultId", + "RelevanceValue" + ], + "members": { + "ResultId": { + "shape": "ResultId", + "documentation": "The unique identifier of the search result that the user provided relevance feedback for.
" + }, + "RelevanceValue": { + "shape": "RelevanceType", + "documentation": "Whether to document was relevant or not relevant to the search.
" + } + }, + "documentation": "Provides feedback on how relevant a document is to a search. Your application uses the SubmitFeedback operation to provide relevance information.
" + }, + "RelevanceFeedbackList": { + "type": "list", + "member": { + "shape": "RelevanceFeedback" + } + }, + "RelevanceType": { + "type": "string", + "enum": [ + "RELEVANT", + "NOT_RELEVANT" + ] + }, + "ResultId": { + "type": "string", + "max": 73, + "min": 1 + }, + "RoleArn": { + "type": "string", + "max": 1284, + "min": 1, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" + }, + "S3BucketName": { + "type": "string", + "max": 63, + "min": 3, + "pattern": "[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9]" + }, + "S3DataSourceConfiguration": { + "type": "structure", + "required": [ + "BucketName" + ], + "members": { + "BucketName": { + "shape": "S3BucketName", + "documentation": "The name of the bucket that contains the documents.
" + }, + "InclusionPrefixes": { + "shape": "DataSourceInclusionsExclusionsStrings", + "documentation": "A list of S3 prefixes for the documents that should be included in the index.
" + }, + "ExclusionPatterns": { + "shape": "DataSourceInclusionsExclusionsStrings", + "documentation": "A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix also matches an exclusion pattern, the document is not indexed.
For more information about glob patterns, see glob (programming) in Wikipedia.
" + }, + "DocumentsMetadataConfiguration": { + "shape": "DocumentsMetadataConfiguration" + }, + "AccessControlListConfiguration": { + "shape": "AccessControlListConfiguration", + "documentation": "Provides the path to the S3 bucket that contains the user context filtering files for the data source.
" + } + }, + "documentation": "Provides configuration information for a data source to index documents in an Amazon S3 bucket.
" + }, + "S3ObjectKey": { + "type": "string", + "max": 1024, + "min": 1, + "pattern": "^\\P{C}*$" + }, + "S3Path": { + "type": "structure", + "required": [ + "Bucket", + "Key" + ], + "members": { + "Bucket": { + "shape": "S3BucketName", + "documentation": "The name of the S3 bucket that contains the file.
" + }, + "Key": { + "shape": "S3ObjectKey", + "documentation": "The name of the file.
" + } + }, + "documentation": "Information required to find a specific file in an Amazon S3 bucket.
" + }, + "ScanSchedule": { + "type": "string" + }, + "Search": { + "type": "structure", + "members": { + "Facetable": { + "shape": "Boolean", + "documentation": "Indicates that the field can be used to create search facets, a count of results for each value in the field. The default is false
.
Determines whether the field is used in the search. If the Searchable
field is true
, you can use relevance tuning to manually tune how Amazon Kendra weights the field in the search. The default is true
for string fields and false
for number and date fields.
Determines whether the field is returned in the query response. The default is true
.
Provides information about how a custom index field is used during a search.
" + }, + "SecretArn": { + "type": "string", + "max": 1284, + "min": 1, + "pattern": "arn:[a-z0-9-\\.]{1,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[^/].{0,1023}" + }, + "SecurityGroupIdList": { + "type": "list", + "member": { + "shape": "VpcSecurityGroupId" + }, + "max": 10, + "min": 1 + }, + "ServerSideEncryptionConfiguration": { + "type": "structure", + "members": { + "KmsKeyId": { + "shape": "KmsKeyId", + "documentation": "The identifier of the KMS key.
" + } + }, + "documentation": "Provides the identifier of the KMS key used to encrypt data indexed by Amazon Kendra.
" + }, + "SharePointConfiguration": { + "type": "structure", + "required": [ + "SharePointVersion", + "Urls", + "SecretArn" + ], + "members": { + "SharePointVersion": { + "shape": "SharePointVersion", + "documentation": "The version of Microsoft SharePoint that you are using as a data source.
" + }, + "Urls": { + "shape": "SharePointUrlList", + "documentation": "The URLs of the Microsoft SharePoint site that contains the documents that should be indexed.
" + }, + "SecretArn": { + "shape": "SecretArn", + "documentation": "The Amazon Resource Name (ARN) of credentials stored in AWS Secrets Manager. The credentials should be a user/password pair. For more information, see Using a Microsoft SharePoint Data Source. For more information about AWS Secrets Manager, see What Is AWS Secrets Manager in the AWS Secrets Manager user guide.
" + }, + "CrawlAttachments": { + "shape": "Boolean", + "documentation": " TRUE
to include attachments to documents stored in your Microsoft SharePoint site in the index; otherwise, FALSE
.
A list of DataSourceToIndexFieldMapping
objects that map Microsoft SharePoint attributes to custom fields in the Amazon Kendra index. You must first create the index fields using the operation before you map SharePoint attributes. For more information, see Mapping Data Source Fields.
Provides configuration information for connecting to a Microsoft SharePoint data source.
" + }, + "SharePointUrlList": { + "type": "list", + "member": { + "shape": "Url" + }, + "max": 100, + "min": 1 + }, + "SharePointVersion": { + "type": "string", + "enum": [ + "SHAREPOINT_ONLINE" + ] + }, + "StartDataSourceSyncJobRequest": { + "type": "structure", + "required": [ + "Id", + "IndexId" + ], + "members": { + "Id": { + "shape": "DataSourceId", + "documentation": "The identifier of the data source to synchronize.
" + }, + "IndexId": { + "shape": "IndexId", + "documentation": "The identifier of the index that contains the data source.
" + } + } + }, + "StartDataSourceSyncJobResponse": { + "type": "structure", + "members": { + "ExecutionId": { + "shape": "String", + "documentation": "Identifies a particular synchronization job.
" + } + } + }, + "StopDataSourceSyncJobRequest": { + "type": "structure", + "required": [ + "Id", + "IndexId" + ], + "members": { + "Id": { + "shape": "DataSourceId", + "documentation": "The identifier of the data source for which to stop the synchronization jobs.
" + }, + "IndexId": { + "shape": "IndexId", + "documentation": "The identifier of the index that contains the data source.
" + } + } + }, + "String": { + "type": "string", + "max": 2048, + "min": 1 + }, + "SubmitFeedbackRequest": { + "type": "structure", + "required": [ + "IndexId", + "QueryId" + ], + "members": { + "IndexId": { + "shape": "IndexId", + "documentation": "The identifier of the index that was queried.
" + }, + "QueryId": { + "shape": "QueryId", + "documentation": "The identifier of the specific query for which you are submitting feedback. The query ID is returned in the response to the operation.
" + }, + "ClickFeedbackItems": { + "shape": "ClickFeedbackList", + "documentation": "Tells Amazon Kendra that a particular search result link was chosen by the user.
" + }, + "RelevanceFeedbackItems": { + "shape": "RelevanceFeedbackList", + "documentation": "Provides Amazon Kendra with relevant or not relevant feedback for whether a particular item was relevant to the search.
" + } + } + }, + "SubnetId": { + "type": "string", + "max": 200, + "min": 1, + "pattern": "[\\-0-9a-zA-Z]+" + }, + "SubnetIdList": { + "type": "list", + "member": { + "shape": "SubnetId" + }, + "max": 6, + "min": 1 + }, + "TableName": { + "type": "string", + "max": 100, + "min": 1, + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*$" + }, + "TextDocumentStatistics": { + "type": "structure", + "required": [ + "IndexedTextDocumentsCount" + ], + "members": { + "IndexedTextDocumentsCount": { + "shape": "IndexedTextDocumentsCount", + "documentation": "The number of text documents indexed.
" + } + }, + "documentation": "Provides information about text documents indexed in an index.
" + }, + "TextWithHighlights": { + "type": "structure", + "members": { + "Text": { + "shape": "String", + "documentation": "The text to display to the user.
" + }, + "Highlights": { + "shape": "HighlightList", + "documentation": "The beginning and end of the text that should be highlighted.
" + } + }, + "documentation": "Provides text and information about where to highlight the text.
" + }, + "TimeRange": { + "type": "structure", + "members": { + "StartTime": { + "shape": "Timestamp", + "documentation": "The UNIX datetime of the beginning of the time range.
" + }, + "EndTime": { + "shape": "Timestamp", + "documentation": "The UNIX datetime of the end of the time range.
" + } + }, + "documentation": "Provides a range of time.
" + }, + "Timestamp": { + "type": "timestamp" + }, + "Title": { + "type": "string", + "max": 1024, + "min": 1 + }, + "UpdateDataSourceRequest": { + "type": "structure", + "required": [ + "Id", + "IndexId" + ], + "members": { + "Id": { + "shape": "DataSourceId", + "documentation": "The unique identifier of the data source to update.
" + }, + "Name": { + "shape": "DataSourceName", + "documentation": "The name of the data source to update. The name of the data source can't be updated. To rename a data source you must delete the data source and re-create it.
" + }, + "IndexId": { + "shape": "IndexId", + "documentation": "The identifier of the index that contains the data source to update.
" + }, + "Configuration": { + "shape": "DataSourceConfiguration" + }, + "Description": { + "shape": "Description", + "documentation": "The new description for the data source.
" + }, + "Schedule": { + "shape": "ScanSchedule", + "documentation": "The new update schedule for the data source.
" + }, + "RoleArn": { + "shape": "RoleArn", + "documentation": "The Amazon Resource Name (ARN) of the new role to use when the data source is accessing resources on your behalf.
" + } + } + }, + "UpdateIndexRequest": { + "type": "structure", + "required": [ + "Id" + ], + "members": { + "Id": { + "shape": "IndexId", + "documentation": "The identifier of the index to update.
" + }, + "Name": { + "shape": "IndexName", + "documentation": "The name of the index to update.
" + }, + "RoleArn": { + "shape": "RoleArn", + "documentation": "A new IAM role that gives Amazon Kendra permission to access your Amazon CloudWatch logs.
" + }, + "Description": { + "shape": "Description", + "documentation": "A new description for the index.
" + }, + "DocumentMetadataConfigurationUpdates": { + "shape": "DocumentMetadataConfigurationList", + "documentation": "The document metadata to update.
" + } + } + }, + "Url": { + "type": "string", + "max": 2048, + "min": 1, + "pattern": "^(https?|ftp|file):\\/\\/(.*)" + }, + "ValueImportanceMap": { + "type": "map", + "key": { + "shape": "ValueImportanceMapKey" + }, + "value": { + "shape": "Importance" + } + }, + "ValueImportanceMapKey": { + "type": "string", + "max": 50, + "min": 1 + }, + "VpcSecurityGroupId": { + "type": "string", + "max": 200, + "min": 1, + "pattern": "[-0-9a-zA-Z]+" + } + }, + "documentation": "Amazon Kendra is a service for indexing large document sets.
" +} \ No newline at end of file diff --git a/apis/kendra-2019-02-03.paginators.json b/apis/kendra-2019-02-03.paginators.json new file mode 100644 index 0000000000..2170bfc57c --- /dev/null +++ b/apis/kendra-2019-02-03.paginators.json @@ -0,0 +1,19 @@ +{ + "pagination": { + "ListDataSourceSyncJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListDataSources": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListIndices": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/apis/metadata.json b/apis/metadata.json index 6ec41d7cdb..a9bf62def8 100644 --- a/apis/metadata.json +++ b/apis/metadata.json @@ -822,5 +822,32 @@ }, "accessanalyzer": { "name": "AccessAnalyzer" + }, + "codegurureviewer": { + "prefix": "codeguru-reviewer", + "name": "CodeGuruReviewer" + }, + "codeguruprofiler": { + "name": "CodeGuruProfiler" + }, + "computeoptimizer": { + "prefix": "compute-optimizer", + "name": "ComputeOptimizer" + }, + "frauddetector": { + "name": "FraudDetector" + }, + "kendra": { + "name": "Kendra" + }, + "networkmanager": { + "name": "NetworkManager" + }, + "outposts": { + "name": "Outposts" + }, + "augmentedairuntime": { + "prefix": "sagemaker-a2i-runtime", + "name": "AugmentedAIRuntime" } } \ No newline at end of file diff --git a/apis/networkmanager-2019-07-05.examples.json b/apis/networkmanager-2019-07-05.examples.json new file mode 100644 index 0000000000..0ea7e3b0bb --- /dev/null +++ b/apis/networkmanager-2019-07-05.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/apis/networkmanager-2019-07-05.min.json b/apis/networkmanager-2019-07-05.min.json new file mode 100644 index 0000000000..490b2665c9 --- /dev/null +++ b/apis/networkmanager-2019-07-05.min.json @@ -0,0 +1,1135 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-07-05", + "endpointPrefix": "networkmanager", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "NetworkManager", + "serviceFullName": "AWS Network Manager", + "serviceId": "NetworkManager", + "signatureVersion": "v4", + "signingName": "networkmanager", + "uid": "networkmanager-2019-07-05" + }, + "operations": { + "AssociateCustomerGateway": { + "http": { + "requestUri": "/global-networks/{globalNetworkId}/customer-gateway-associations" + }, + "input": { + "type": "structure", + "required": [ + "CustomerGatewayArn", + "GlobalNetworkId", + "DeviceId" + ], + "members": { + "CustomerGatewayArn": {}, + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceId": {}, + "LinkId": {} + } + }, + "output": { + "type": "structure", + "members": { + "CustomerGatewayAssociation": { + "shape": "S4" + } + } + } + }, + "AssociateLink": { + "http": { + "requestUri": "/global-networks/{globalNetworkId}/link-associations" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "DeviceId", + "LinkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceId": {}, + "LinkId": {} + } + }, + "output": { + "type": "structure", + "members": { + "LinkAssociation": { + "shape": "S8" + } + } + } + }, + "CreateDevice": { + "http": { + "requestUri": "/global-networks/{globalNetworkId}/devices" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "Description": {}, + "Type": {}, + "Vendor": {}, + "Model": {}, + "SerialNumber": {}, + "Location": { + "shape": "Sb" + }, + "SiteId": {}, + "Tags": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "members": { + "Device": { + "shape": "Sh" + } + } + } + }, + "CreateGlobalNetwork": { + "http": { + "requestUri": "/global-networks" + }, + "input": { + "type": "structure", + "members": { + "Description": {}, + "Tags": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "members": { + "GlobalNetwork": { + "shape": "Sm" + } + } + } + }, + "CreateLink": { + "http": { + "requestUri": "/global-networks/{globalNetworkId}/links" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "Bandwidth", + "SiteId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "Description": {}, + "Type": {}, + "Bandwidth": { + "shape": "Sp" + }, + "Provider": {}, + "SiteId": {}, + "Tags": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "members": { + "Link": { + "shape": "Ss" + } + } + } + }, + "CreateSite": { + "http": { + "requestUri": "/global-networks/{globalNetworkId}/sites" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "Description": {}, + "Location": { + "shape": "Sb" + }, + "Tags": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "members": { + "Site": { + "shape": "Sw" + } + } + } + }, + "DeleteDevice": { + "http": { + "method": "DELETE", + "requestUri": "/global-networks/{globalNetworkId}/devices/{deviceId}" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "DeviceId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceId": { + "location": "uri", + "locationName": "deviceId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Device": { + "shape": "Sh" + } + } + } + }, + "DeleteGlobalNetwork": { + "http": { + "method": "DELETE", + "requestUri": "/global-networks/{globalNetworkId}" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + } + } + }, + "output": { + "type": "structure", + "members": { + "GlobalNetwork": { + "shape": "Sm" + } + } + } + }, + "DeleteLink": { + "http": { + "method": "DELETE", + "requestUri": "/global-networks/{globalNetworkId}/links/{linkId}" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "LinkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "LinkId": { + "location": "uri", + "locationName": "linkId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Link": { + "shape": "Ss" + } + } + } + }, + "DeleteSite": { + "http": { + "method": "DELETE", + "requestUri": "/global-networks/{globalNetworkId}/sites/{siteId}" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "SiteId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "SiteId": { + "location": "uri", + "locationName": "siteId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Site": { + "shape": "Sw" + } + } + } + }, + "DeregisterTransitGateway": { + "http": { + "method": "DELETE", + "requestUri": "/global-networks/{globalNetworkId}/transit-gateway-registrations/{transitGatewayArn}" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "TransitGatewayArn" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "TransitGatewayArn": { + "location": "uri", + "locationName": "transitGatewayArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayRegistration": { + "shape": "S18" + } + } + } + }, + "DescribeGlobalNetworks": { + "http": { + "method": "GET", + "requestUri": "/global-networks" + }, + "input": { + "type": "structure", + "members": { + "GlobalNetworkIds": { + "shape": "S1c", + "location": "querystring", + "locationName": "globalNetworkIds" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "GlobalNetworks": { + "type": "list", + "member": { + "shape": "Sm" + } + }, + "NextToken": {} + } + } + }, + "DisassociateCustomerGateway": { + "http": { + "method": "DELETE", + "requestUri": "/global-networks/{globalNetworkId}/customer-gateway-associations/{customerGatewayArn}" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "CustomerGatewayArn" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "CustomerGatewayArn": { + "location": "uri", + "locationName": "customerGatewayArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "CustomerGatewayAssociation": { + "shape": "S4" + } + } + } + }, + "DisassociateLink": { + "http": { + "method": "DELETE", + "requestUri": "/global-networks/{globalNetworkId}/link-associations" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "DeviceId", + "LinkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceId": { + "location": "querystring", + "locationName": "deviceId" + }, + "LinkId": { + "location": "querystring", + "locationName": "linkId" + } + } + }, + "output": { + "type": "structure", + "members": { + "LinkAssociation": { + "shape": "S8" + } + } + } + }, + "GetCustomerGatewayAssociations": { + "http": { + "method": "GET", + "requestUri": "/global-networks/{globalNetworkId}/customer-gateway-associations" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "CustomerGatewayArns": { + "shape": "S1c", + "location": "querystring", + "locationName": "customerGatewayArns" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "CustomerGatewayAssociations": { + "type": "list", + "member": { + "shape": "S4" + } + }, + "NextToken": {} + } + } + }, + "GetDevices": { + "http": { + "method": "GET", + "requestUri": "/global-networks/{globalNetworkId}/devices" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceIds": { + "shape": "S1c", + "location": "querystring", + "locationName": "deviceIds" + }, + "SiteId": { + "location": "querystring", + "locationName": "siteId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Devices": { + "type": "list", + "member": { + "shape": "Sh" + } + }, + "NextToken": {} + } + } + }, + "GetLinkAssociations": { + "http": { + "method": "GET", + "requestUri": "/global-networks/{globalNetworkId}/link-associations" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceId": { + "location": "querystring", + "locationName": "deviceId" + }, + "LinkId": { + "location": "querystring", + "locationName": "linkId" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "LinkAssociations": { + "type": "list", + "member": { + "shape": "S8" + } + }, + "NextToken": {} + } + } + }, + "GetLinks": { + "http": { + "method": "GET", + "requestUri": "/global-networks/{globalNetworkId}/links" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "LinkIds": { + "shape": "S1c", + "location": "querystring", + "locationName": "linkIds" + }, + "SiteId": { + "location": "querystring", + "locationName": "siteId" + }, + "Type": { + "location": "querystring", + "locationName": "type" + }, + "Provider": { + "location": "querystring", + "locationName": "provider" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Links": { + "type": "list", + "member": { + "shape": "Ss" + } + }, + "NextToken": {} + } + } + }, + "GetSites": { + "http": { + "method": "GET", + "requestUri": "/global-networks/{globalNetworkId}/sites" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "SiteIds": { + "shape": "S1c", + "location": "querystring", + "locationName": "siteIds" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "Sites": { + "type": "list", + "member": { + "shape": "Sw" + } + }, + "NextToken": {} + } + } + }, + "GetTransitGatewayRegistrations": { + "http": { + "method": "GET", + "requestUri": "/global-networks/{globalNetworkId}/transit-gateway-registrations" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "TransitGatewayArns": { + "shape": "S1c", + "location": "querystring", + "locationName": "transitGatewayArns" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayRegistrations": { + "type": "list", + "member": { + "shape": "S18" + } + }, + "NextToken": {} + } + } + }, + "ListTagsForResource": { + "http": { + "method": "GET", + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + } + } + }, + "output": { + "type": "structure", + "members": { + "TagList": { + "shape": "Sc" + } + } + } + }, + "RegisterTransitGateway": { + "http": { + "requestUri": "/global-networks/{globalNetworkId}/transit-gateway-registrations" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "TransitGatewayArn" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "TransitGatewayArn": {} + } + }, + "output": { + "type": "structure", + "members": { + "TransitGatewayRegistration": { + "shape": "S18" + } + } + } + }, + "TagResource": { + "http": { + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "Tags": { + "shape": "Sc" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UntagResource": { + "http": { + "method": "DELETE", + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": { + "location": "uri", + "locationName": "resourceArn" + }, + "TagKeys": { + "location": "querystring", + "locationName": "tagKeys", + "type": "list", + "member": {} + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "UpdateDevice": { + "http": { + "method": "PATCH", + "requestUri": "/global-networks/{globalNetworkId}/devices/{deviceId}" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "DeviceId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceId": { + "location": "uri", + "locationName": "deviceId" + }, + "Description": {}, + "Type": {}, + "Vendor": {}, + "Model": {}, + "SerialNumber": {}, + "Location": { + "shape": "Sb" + }, + "SiteId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Device": { + "shape": "Sh" + } + } + } + }, + "UpdateGlobalNetwork": { + "http": { + "method": "PATCH", + "requestUri": "/global-networks/{globalNetworkId}" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "Description": {} + } + }, + "output": { + "type": "structure", + "members": { + "GlobalNetwork": { + "shape": "Sm" + } + } + } + }, + "UpdateLink": { + "http": { + "method": "PATCH", + "requestUri": "/global-networks/{globalNetworkId}/links/{linkId}" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "LinkId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "LinkId": { + "location": "uri", + "locationName": "linkId" + }, + "Description": {}, + "Type": {}, + "Bandwidth": { + "shape": "Sp" + }, + "Provider": {} + } + }, + "output": { + "type": "structure", + "members": { + "Link": { + "shape": "Ss" + } + } + } + }, + "UpdateSite": { + "http": { + "method": "PATCH", + "requestUri": "/global-networks/{globalNetworkId}/sites/{siteId}" + }, + "input": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "SiteId" + ], + "members": { + "GlobalNetworkId": { + "location": "uri", + "locationName": "globalNetworkId" + }, + "SiteId": { + "location": "uri", + "locationName": "siteId" + }, + "Description": {}, + "Location": { + "shape": "Sb" + } + } + }, + "output": { + "type": "structure", + "members": { + "Site": { + "shape": "Sw" + } + } + } + } + }, + "shapes": { + "S4": { + "type": "structure", + "members": { + "CustomerGatewayArn": {}, + "GlobalNetworkId": {}, + "DeviceId": {}, + "LinkId": {}, + "State": {} + } + }, + "S8": { + "type": "structure", + "members": { + "GlobalNetworkId": {}, + "DeviceId": {}, + "LinkId": {}, + "LinkAssociationState": {} + } + }, + "Sb": { + "type": "structure", + "members": { + "Address": {}, + "Latitude": {}, + "Longitude": {} + } + }, + "Sc": { + "type": "list", + "member": { + "type": "structure", + "members": { + "Key": {}, + "Value": {} + } + } + }, + "Sh": { + "type": "structure", + "members": { + "DeviceId": {}, + "DeviceArn": {}, + "GlobalNetworkId": {}, + "Description": {}, + "Type": {}, + "Vendor": {}, + "Model": {}, + "SerialNumber": {}, + "Location": { + "shape": "Sb" + }, + "SiteId": {}, + "CreatedAt": { + "type": "timestamp" + }, + "State": {}, + "Tags": { + "shape": "Sc" + } + } + }, + "Sm": { + "type": "structure", + "members": { + "GlobalNetworkId": {}, + "GlobalNetworkArn": {}, + "Description": {}, + "CreatedAt": { + "type": "timestamp" + }, + "State": {}, + "Tags": { + "shape": "Sc" + } + } + }, + "Sp": { + "type": "structure", + "members": { + "UploadSpeed": { + "type": "integer" + }, + "DownloadSpeed": { + "type": "integer" + } + } + }, + "Ss": { + "type": "structure", + "members": { + "LinkId": {}, + "LinkArn": {}, + "GlobalNetworkId": {}, + "SiteId": {}, + "Description": {}, + "Type": {}, + "Bandwidth": { + "shape": "Sp" + }, + "Provider": {}, + "CreatedAt": { + "type": "timestamp" + }, + "State": {}, + "Tags": { + "shape": "Sc" + } + } + }, + "Sw": { + "type": "structure", + "members": { + "SiteId": {}, + "SiteArn": {}, + "GlobalNetworkId": {}, + "Description": {}, + "Location": { + "shape": "Sb" + }, + "CreatedAt": { + "type": "timestamp" + }, + "State": {}, + "Tags": { + "shape": "Sc" + } + } + }, + "S18": { + "type": "structure", + "members": { + "GlobalNetworkId": {}, + "TransitGatewayArn": {}, + "State": { + "type": "structure", + "members": { + "Code": {}, + "Message": {} + } + } + } + }, + "S1c": { + "type": "list", + "member": {} + } + } +} \ No newline at end of file diff --git a/apis/networkmanager-2019-07-05.normal.json b/apis/networkmanager-2019-07-05.normal.json new file mode 100644 index 0000000000..0ea5954199 --- /dev/null +++ b/apis/networkmanager-2019-07-05.normal.json @@ -0,0 +1,2465 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-07-05", + "endpointPrefix": "networkmanager", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "NetworkManager", + "serviceFullName": "AWS Network Manager", + "serviceId": "NetworkManager", + "signatureVersion": "v4", + "signingName": "networkmanager", + "uid": "networkmanager-2019-07-05" + }, + "operations": { + "AssociateCustomerGateway": { + "name": "AssociateCustomerGateway", + "http": { + "method": "POST", + "requestUri": "/global-networks/{globalNetworkId}/customer-gateway-associations" + }, + "input": { + "shape": "AssociateCustomerGatewayRequest" + }, + "output": { + "shape": "AssociateCustomerGatewayResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device.
You can only associate customer gateways that are connected to a VPN attachment on a transit gateway. The transit gateway must be registered in your global network. When you register a transit gateway, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id
.
You cannot associate a customer gateway with more than one device and link.
" + }, + "AssociateLink": { + "name": "AssociateLink", + "http": { + "method": "POST", + "requestUri": "/global-networks/{globalNetworkId}/link-associations" + }, + "input": { + "shape": "AssociateLinkRequest" + }, + "output": { + "shape": "AssociateLinkResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Associates a link to a device. A device can be associated to multiple links and a link can be associated to multiple devices. The device and link must be in the same global network and the same site.
" + }, + "CreateDevice": { + "name": "CreateDevice", + "http": { + "method": "POST", + "requestUri": "/global-networks/{globalNetworkId}/devices" + }, + "input": { + "shape": "CreateDeviceRequest" + }, + "output": { + "shape": "CreateDeviceResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.
" + }, + "CreateGlobalNetwork": { + "name": "CreateGlobalNetwork", + "http": { + "method": "POST", + "requestUri": "/global-networks" + }, + "input": { + "shape": "CreateGlobalNetworkRequest" + }, + "output": { + "shape": "CreateGlobalNetworkResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Creates a new, empty global network.
" + }, + "CreateLink": { + "name": "CreateLink", + "http": { + "method": "POST", + "requestUri": "/global-networks/{globalNetworkId}/links" + }, + "input": { + "shape": "CreateLinkRequest" + }, + "output": { + "shape": "CreateLinkResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Creates a new link for a specified site.
" + }, + "CreateSite": { + "name": "CreateSite", + "http": { + "method": "POST", + "requestUri": "/global-networks/{globalNetworkId}/sites" + }, + "input": { + "shape": "CreateSiteRequest" + }, + "output": { + "shape": "CreateSiteResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Creates a new site in a global network.
" + }, + "DeleteDevice": { + "name": "DeleteDevice", + "http": { + "method": "DELETE", + "requestUri": "/global-networks/{globalNetworkId}/devices/{deviceId}" + }, + "input": { + "shape": "DeleteDeviceRequest" + }, + "output": { + "shape": "DeleteDeviceResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Deletes an existing device. You must first disassociate the device from any links and customer gateways.
" + }, + "DeleteGlobalNetwork": { + "name": "DeleteGlobalNetwork", + "http": { + "method": "DELETE", + "requestUri": "/global-networks/{globalNetworkId}" + }, + "input": { + "shape": "DeleteGlobalNetworkRequest" + }, + "output": { + "shape": "DeleteGlobalNetworkResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Deletes an existing global network. You must first delete all global network objects (devices, links, and sites) and deregister all transit gateways.
" + }, + "DeleteLink": { + "name": "DeleteLink", + "http": { + "method": "DELETE", + "requestUri": "/global-networks/{globalNetworkId}/links/{linkId}" + }, + "input": { + "shape": "DeleteLinkRequest" + }, + "output": { + "shape": "DeleteLinkResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Deletes an existing link. You must first disassociate the link from any devices and customer gateways.
" + }, + "DeleteSite": { + "name": "DeleteSite", + "http": { + "method": "DELETE", + "requestUri": "/global-networks/{globalNetworkId}/sites/{siteId}" + }, + "input": { + "shape": "DeleteSiteRequest" + }, + "output": { + "shape": "DeleteSiteResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Deletes an existing site. The site cannot be associated with any device or link.
" + }, + "DeregisterTransitGateway": { + "name": "DeregisterTransitGateway", + "http": { + "method": "DELETE", + "requestUri": "/global-networks/{globalNetworkId}/transit-gateway-registrations/{transitGatewayArn}" + }, + "input": { + "shape": "DeregisterTransitGatewayRequest" + }, + "output": { + "shape": "DeregisterTransitGatewayResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Deregisters a transit gateway from your global network. This action does not delete your transit gateway, or modify any of its attachments. This action removes any customer gateway associations.
" + }, + "DescribeGlobalNetworks": { + "name": "DescribeGlobalNetworks", + "http": { + "method": "GET", + "requestUri": "/global-networks" + }, + "input": { + "shape": "DescribeGlobalNetworksRequest" + }, + "output": { + "shape": "DescribeGlobalNetworksResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Describes one or more global networks. By default, all global networks are described. To describe the objects in your global network, you must use the appropriate Get*
action. For example, to list the transit gateways in your global network, use GetTransitGatewayRegistrations.
Disassociates a customer gateway from a device and a link.
" + }, + "DisassociateLink": { + "name": "DisassociateLink", + "http": { + "method": "DELETE", + "requestUri": "/global-networks/{globalNetworkId}/link-associations" + }, + "input": { + "shape": "DisassociateLinkRequest" + }, + "output": { + "shape": "DisassociateLinkResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.
" + }, + "GetCustomerGatewayAssociations": { + "name": "GetCustomerGatewayAssociations", + "http": { + "method": "GET", + "requestUri": "/global-networks/{globalNetworkId}/customer-gateway-associations" + }, + "input": { + "shape": "GetCustomerGatewayAssociationsRequest" + }, + "output": { + "shape": "GetCustomerGatewayAssociationsResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Gets the association information for customer gateways that are associated with devices and links in your global network.
" + }, + "GetDevices": { + "name": "GetDevices", + "http": { + "method": "GET", + "requestUri": "/global-networks/{globalNetworkId}/devices" + }, + "input": { + "shape": "GetDevicesRequest" + }, + "output": { + "shape": "GetDevicesResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Gets information about one or more of your devices in a global network.
" + }, + "GetLinkAssociations": { + "name": "GetLinkAssociations", + "http": { + "method": "GET", + "requestUri": "/global-networks/{globalNetworkId}/link-associations" + }, + "input": { + "shape": "GetLinkAssociationsRequest" + }, + "output": { + "shape": "GetLinkAssociationsResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.
" + }, + "GetLinks": { + "name": "GetLinks", + "http": { + "method": "GET", + "requestUri": "/global-networks/{globalNetworkId}/links" + }, + "input": { + "shape": "GetLinksRequest" + }, + "output": { + "shape": "GetLinksResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Gets information about one or more links in a specified global network.
If you specify the site ID, you cannot specify the type or provider in the same request. You can specify the type and provider in the same request.
" + }, + "GetSites": { + "name": "GetSites", + "http": { + "method": "GET", + "requestUri": "/global-networks/{globalNetworkId}/sites" + }, + "input": { + "shape": "GetSitesRequest" + }, + "output": { + "shape": "GetSitesResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Gets information about one or more of your sites in a global network.
" + }, + "GetTransitGatewayRegistrations": { + "name": "GetTransitGatewayRegistrations", + "http": { + "method": "GET", + "requestUri": "/global-networks/{globalNetworkId}/transit-gateway-registrations" + }, + "input": { + "shape": "GetTransitGatewayRegistrationsRequest" + }, + "output": { + "shape": "GetTransitGatewayRegistrationsResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Gets information about the transit gateway registrations in a specified global network.
" + }, + "ListTagsForResource": { + "name": "ListTagsForResource", + "http": { + "method": "GET", + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "shape": "ListTagsForResourceRequest" + }, + "output": { + "shape": "ListTagsForResourceResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Lists the tags for a specified resource.
" + }, + "RegisterTransitGateway": { + "name": "RegisterTransitGateway", + "http": { + "method": "POST", + "requestUri": "/global-networks/{globalNetworkId}/transit-gateway-registrations" + }, + "input": { + "shape": "RegisterTransitGatewayRequest" + }, + "output": { + "shape": "RegisterTransitGatewayResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Registers a transit gateway in your global network. The transit gateway can be in any AWS Region, but it must be owned by the same AWS account that owns the global network. You cannot register a transit gateway in more than one global network.
" + }, + "TagResource": { + "name": "TagResource", + "http": { + "method": "POST", + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "shape": "TagResourceRequest" + }, + "output": { + "shape": "TagResourceResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Tags a specified resource.
" + }, + "UntagResource": { + "name": "UntagResource", + "http": { + "method": "DELETE", + "requestUri": "/tags/{resourceArn}" + }, + "input": { + "shape": "UntagResourceRequest" + }, + "output": { + "shape": "UntagResourceResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Removes tags from a specified resource.
" + }, + "UpdateDevice": { + "name": "UpdateDevice", + "http": { + "method": "PATCH", + "requestUri": "/global-networks/{globalNetworkId}/devices/{deviceId}" + }, + "input": { + "shape": "UpdateDeviceRequest" + }, + "output": { + "shape": "UpdateDeviceResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.
" + }, + "UpdateGlobalNetwork": { + "name": "UpdateGlobalNetwork", + "http": { + "method": "PATCH", + "requestUri": "/global-networks/{globalNetworkId}" + }, + "input": { + "shape": "UpdateGlobalNetworkRequest" + }, + "output": { + "shape": "UpdateGlobalNetworkResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Updates an existing global network. To remove information for any of the parameters, specify an empty string.
" + }, + "UpdateLink": { + "name": "UpdateLink", + "http": { + "method": "PATCH", + "requestUri": "/global-networks/{globalNetworkId}/links/{linkId}" + }, + "input": { + "shape": "UpdateLinkRequest" + }, + "output": { + "shape": "UpdateLinkResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.
" + }, + "UpdateSite": { + "name": "UpdateSite", + "http": { + "method": "PATCH", + "requestUri": "/global-networks/{globalNetworkId}/sites/{siteId}" + }, + "input": { + "shape": "UpdateSiteRequest" + }, + "output": { + "shape": "UpdateSiteResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ConflictException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.
" + } + }, + "shapes": { + "AssociateCustomerGatewayRequest": { + "type": "structure", + "required": [ + "CustomerGatewayArn", + "GlobalNetworkId", + "DeviceId" + ], + "members": { + "CustomerGatewayArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.
" + }, + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceId": { + "shape": "String", + "documentation": "The ID of the device.
" + }, + "LinkId": { + "shape": "String", + "documentation": "The ID of the link.
" + } + } + }, + "AssociateCustomerGatewayResponse": { + "type": "structure", + "members": { + "CustomerGatewayAssociation": { + "shape": "CustomerGatewayAssociation", + "documentation": "The customer gateway association.
" + } + } + }, + "AssociateLinkRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "DeviceId", + "LinkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceId": { + "shape": "String", + "documentation": "The ID of the device.
" + }, + "LinkId": { + "shape": "String", + "documentation": "The ID of the link.
" + } + } + }, + "AssociateLinkResponse": { + "type": "structure", + "members": { + "LinkAssociation": { + "shape": "LinkAssociation", + "documentation": "The link association.
" + } + } + }, + "Bandwidth": { + "type": "structure", + "members": { + "UploadSpeed": { + "shape": "Integer", + "documentation": "Upload speed in Mbps.
" + }, + "DownloadSpeed": { + "shape": "Integer", + "documentation": "Download speed in Mbps.
" + } + }, + "documentation": "Describes bandwidth information.
" + }, + "CreateDeviceRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "Description": { + "shape": "String", + "documentation": "A description of the device.
Length Constraints: Maximum length of 256 characters.
" + }, + "Type": { + "shape": "String", + "documentation": "The type of the device.
" + }, + "Vendor": { + "shape": "String", + "documentation": "The vendor of the device.
Length Constraints: Maximum length of 128 characters.
" + }, + "Model": { + "shape": "String", + "documentation": "The model of the device.
Length Constraints: Maximum length of 128 characters.
" + }, + "SerialNumber": { + "shape": "String", + "documentation": "The serial number of the device.
Length Constraints: Maximum length of 128 characters.
" + }, + "Location": { + "shape": "Location", + "documentation": "The location of the device.
" + }, + "SiteId": { + "shape": "String", + "documentation": "The ID of the site.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "The tags to apply to the resource during creation.
" + } + } + }, + "CreateDeviceResponse": { + "type": "structure", + "members": { + "Device": { + "shape": "Device", + "documentation": "Information about the device.
" + } + } + }, + "CreateGlobalNetworkRequest": { + "type": "structure", + "members": { + "Description": { + "shape": "String", + "documentation": "A description of the global network.
Length Constraints: Maximum length of 256 characters.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "The tags to apply to the resource during creation.
" + } + } + }, + "CreateGlobalNetworkResponse": { + "type": "structure", + "members": { + "GlobalNetwork": { + "shape": "GlobalNetwork", + "documentation": "Information about the global network object.
" + } + } + }, + "CreateLinkRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "Bandwidth", + "SiteId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "Description": { + "shape": "String", + "documentation": "A description of the link.
Length Constraints: Maximum length of 256 characters.
" + }, + "Type": { + "shape": "String", + "documentation": "The type of the link.
Constraints: Cannot include the following characters: | \\ ^
Length Constraints: Maximum length of 128 characters.
" + }, + "Bandwidth": { + "shape": "Bandwidth", + "documentation": "The upload speed and download speed in Mbps.
" + }, + "Provider": { + "shape": "String", + "documentation": "The provider of the link.
Constraints: Cannot include the following characters: | \\ ^
Length Constraints: Maximum length of 128 characters.
" + }, + "SiteId": { + "shape": "String", + "documentation": "The ID of the site.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "The tags to apply to the resource during creation.
" + } + } + }, + "CreateLinkResponse": { + "type": "structure", + "members": { + "Link": { + "shape": "Link", + "documentation": "Information about the link.
" + } + } + }, + "CreateSiteRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "Description": { + "shape": "String", + "documentation": "A description of your site.
Length Constraints: Maximum length of 256 characters.
" + }, + "Location": { + "shape": "Location", + "documentation": "The site location. This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.
Address
: The physical address of the site.
Latitude
: The latitude of the site.
Longitude
: The longitude of the site.
The tags to apply to the resource during creation.
" + } + } + }, + "CreateSiteResponse": { + "type": "structure", + "members": { + "Site": { + "shape": "Site", + "documentation": "Information about the site.
" + } + } + }, + "CustomerGatewayAssociation": { + "type": "structure", + "members": { + "CustomerGatewayArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the customer gateway.
" + }, + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
" + }, + "DeviceId": { + "shape": "String", + "documentation": "The ID of the device.
" + }, + "LinkId": { + "shape": "String", + "documentation": "The ID of the link.
" + }, + "State": { + "shape": "CustomerGatewayAssociationState", + "documentation": "The association state.
" + } + }, + "documentation": "Describes the association between a customer gateway, a device, and a link.
" + }, + "CustomerGatewayAssociationList": { + "type": "list", + "member": { + "shape": "CustomerGatewayAssociation" + } + }, + "CustomerGatewayAssociationState": { + "type": "string", + "enum": [ + "PENDING", + "AVAILABLE", + "DELETING", + "DELETED" + ] + }, + "DateTime": { + "type": "timestamp" + }, + "DeleteDeviceRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "DeviceId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceId": { + "shape": "String", + "documentation": "The ID of the device.
", + "location": "uri", + "locationName": "deviceId" + } + } + }, + "DeleteDeviceResponse": { + "type": "structure", + "members": { + "Device": { + "shape": "Device", + "documentation": "Information about the device.
" + } + } + }, + "DeleteGlobalNetworkRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + } + } + }, + "DeleteGlobalNetworkResponse": { + "type": "structure", + "members": { + "GlobalNetwork": { + "shape": "GlobalNetwork", + "documentation": "Information about the global network.
" + } + } + }, + "DeleteLinkRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "LinkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "LinkId": { + "shape": "String", + "documentation": "The ID of the link.
", + "location": "uri", + "locationName": "linkId" + } + } + }, + "DeleteLinkResponse": { + "type": "structure", + "members": { + "Link": { + "shape": "Link", + "documentation": "Information about the link.
" + } + } + }, + "DeleteSiteRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "SiteId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "SiteId": { + "shape": "String", + "documentation": "The ID of the site.
", + "location": "uri", + "locationName": "siteId" + } + } + }, + "DeleteSiteResponse": { + "type": "structure", + "members": { + "Site": { + "shape": "Site", + "documentation": "Information about the site.
" + } + } + }, + "DeregisterTransitGatewayRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "TransitGatewayArn" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "TransitGatewayArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the transit gateway.
", + "location": "uri", + "locationName": "transitGatewayArn" + } + } + }, + "DeregisterTransitGatewayResponse": { + "type": "structure", + "members": { + "TransitGatewayRegistration": { + "shape": "TransitGatewayRegistration", + "documentation": "The transit gateway registration information.
" + } + } + }, + "DescribeGlobalNetworksRequest": { + "type": "structure", + "members": { + "GlobalNetworkIds": { + "shape": "StringList", + "documentation": "The IDs of one or more global networks. The maximum is 10.
", + "location": "querystring", + "locationName": "globalNetworkIds" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return.
", + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "DescribeGlobalNetworksResponse": { + "type": "structure", + "members": { + "GlobalNetworks": { + "shape": "GlobalNetworkList", + "documentation": "Information about the global networks.
" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
" + } + } + }, + "Device": { + "type": "structure", + "members": { + "DeviceId": { + "shape": "String", + "documentation": "The ID of the device.
" + }, + "DeviceArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the device.
" + }, + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
" + }, + "Description": { + "shape": "String", + "documentation": "The description of the device.
" + }, + "Type": { + "shape": "String", + "documentation": "The device type.
" + }, + "Vendor": { + "shape": "String", + "documentation": "The device vendor.
" + }, + "Model": { + "shape": "String", + "documentation": "The device model.
" + }, + "SerialNumber": { + "shape": "String", + "documentation": "The device serial number.
" + }, + "Location": { + "shape": "Location", + "documentation": "The site location.
" + }, + "SiteId": { + "shape": "String", + "documentation": "The site ID.
" + }, + "CreatedAt": { + "shape": "DateTime", + "documentation": "The date and time that the site was created.
" + }, + "State": { + "shape": "DeviceState", + "documentation": "The device state.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "The tags for the device.
" + } + }, + "documentation": "Describes a device.
" + }, + "DeviceList": { + "type": "list", + "member": { + "shape": "Device" + } + }, + "DeviceState": { + "type": "string", + "enum": [ + "PENDING", + "AVAILABLE", + "DELETING", + "UPDATING" + ] + }, + "DisassociateCustomerGatewayRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "CustomerGatewayArn" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "CustomerGatewayArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the customer gateway. For more information, see Resources Defined by Amazon EC2.
", + "location": "uri", + "locationName": "customerGatewayArn" + } + } + }, + "DisassociateCustomerGatewayResponse": { + "type": "structure", + "members": { + "CustomerGatewayAssociation": { + "shape": "CustomerGatewayAssociation", + "documentation": "Information about the customer gateway association.
" + } + } + }, + "DisassociateLinkRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "DeviceId", + "LinkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceId": { + "shape": "String", + "documentation": "The ID of the device.
", + "location": "querystring", + "locationName": "deviceId" + }, + "LinkId": { + "shape": "String", + "documentation": "The ID of the link.
", + "location": "querystring", + "locationName": "linkId" + } + } + }, + "DisassociateLinkResponse": { + "type": "structure", + "members": { + "LinkAssociation": { + "shape": "LinkAssociation", + "documentation": "Information about the link association.
" + } + } + }, + "GetCustomerGatewayAssociationsRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "CustomerGatewayArns": { + "shape": "StringList", + "documentation": "One or more customer gateway Amazon Resource Names (ARNs). For more information, see Resources Defined by Amazon EC2. The maximum is 10.
", + "location": "querystring", + "locationName": "customerGatewayArns" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return.
", + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "GetCustomerGatewayAssociationsResponse": { + "type": "structure", + "members": { + "CustomerGatewayAssociations": { + "shape": "CustomerGatewayAssociationList", + "documentation": "The customer gateway associations.
" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
" + } + } + }, + "GetDevicesRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceIds": { + "shape": "StringList", + "documentation": "One or more device IDs. The maximum is 10.
", + "location": "querystring", + "locationName": "deviceIds" + }, + "SiteId": { + "shape": "String", + "documentation": "The ID of the site.
", + "location": "querystring", + "locationName": "siteId" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return.
", + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "GetDevicesResponse": { + "type": "structure", + "members": { + "Devices": { + "shape": "DeviceList", + "documentation": "The devices.
" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
" + } + } + }, + "GetLinkAssociationsRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceId": { + "shape": "String", + "documentation": "The ID of the device.
", + "location": "querystring", + "locationName": "deviceId" + }, + "LinkId": { + "shape": "String", + "documentation": "The ID of the link.
", + "location": "querystring", + "locationName": "linkId" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return.
", + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "GetLinkAssociationsResponse": { + "type": "structure", + "members": { + "LinkAssociations": { + "shape": "LinkAssociationList", + "documentation": "The link associations.
" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
" + } + } + }, + "GetLinksRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "LinkIds": { + "shape": "StringList", + "documentation": "One or more link IDs. The maximum is 10.
", + "location": "querystring", + "locationName": "linkIds" + }, + "SiteId": { + "shape": "String", + "documentation": "The ID of the site.
", + "location": "querystring", + "locationName": "siteId" + }, + "Type": { + "shape": "String", + "documentation": "The link type.
", + "location": "querystring", + "locationName": "type" + }, + "Provider": { + "shape": "String", + "documentation": "The link provider.
", + "location": "querystring", + "locationName": "provider" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return.
", + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "GetLinksResponse": { + "type": "structure", + "members": { + "Links": { + "shape": "LinkList", + "documentation": "The links.
" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
" + } + } + }, + "GetSitesRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "SiteIds": { + "shape": "StringList", + "documentation": "One or more site IDs. The maximum is 10.
", + "location": "querystring", + "locationName": "siteIds" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return.
", + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "GetSitesResponse": { + "type": "structure", + "members": { + "Sites": { + "shape": "SiteList", + "documentation": "The sites.
" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
" + } + } + }, + "GetTransitGatewayRegistrationsRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "TransitGatewayArns": { + "shape": "StringList", + "documentation": "The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.
", + "location": "querystring", + "locationName": "transitGatewayArns" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The maximum number of results to return.
", + "location": "querystring", + "locationName": "maxResults" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
", + "location": "querystring", + "locationName": "nextToken" + } + } + }, + "GetTransitGatewayRegistrationsResponse": { + "type": "structure", + "members": { + "TransitGatewayRegistrations": { + "shape": "TransitGatewayRegistrationList", + "documentation": "The transit gateway registrations.
" + }, + "NextToken": { + "shape": "String", + "documentation": "The token for the next page of results.
" + } + } + }, + "GlobalNetwork": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
" + }, + "GlobalNetworkArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the global network.
" + }, + "Description": { + "shape": "String", + "documentation": "The description of the global network.
" + }, + "CreatedAt": { + "shape": "DateTime", + "documentation": "The date and time that the global network was created.
" + }, + "State": { + "shape": "GlobalNetworkState", + "documentation": "The state of the global network.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "The tags for the global network.
" + } + }, + "documentation": "Describes a global network.
" + }, + "GlobalNetworkList": { + "type": "list", + "member": { + "shape": "GlobalNetwork" + } + }, + "GlobalNetworkState": { + "type": "string", + "enum": [ + "PENDING", + "AVAILABLE", + "DELETING", + "UPDATING" + ] + }, + "Integer": { + "type": "integer" + }, + "Link": { + "type": "structure", + "members": { + "LinkId": { + "shape": "String", + "documentation": "The ID of the link.
" + }, + "LinkArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the link.
" + }, + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
" + }, + "SiteId": { + "shape": "String", + "documentation": "The ID of the site.
" + }, + "Description": { + "shape": "String", + "documentation": "The description of the link.
" + }, + "Type": { + "shape": "String", + "documentation": "The type of the link.
" + }, + "Bandwidth": { + "shape": "Bandwidth", + "documentation": "The bandwidth for the link.
" + }, + "Provider": { + "shape": "String", + "documentation": "The provider of the link.
" + }, + "CreatedAt": { + "shape": "DateTime", + "documentation": "The date and time that the link was created.
" + }, + "State": { + "shape": "LinkState", + "documentation": "The state of the link.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "The tags for the link.
" + } + }, + "documentation": "Describes a link.
" + }, + "LinkAssociation": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
" + }, + "DeviceId": { + "shape": "String", + "documentation": "The device ID for the link association.
" + }, + "LinkId": { + "shape": "String", + "documentation": "The ID of the link.
" + }, + "LinkAssociationState": { + "shape": "LinkAssociationState", + "documentation": "The state of the association.
" + } + }, + "documentation": "Describes the association between a device and a link.
" + }, + "LinkAssociationList": { + "type": "list", + "member": { + "shape": "LinkAssociation" + } + }, + "LinkAssociationState": { + "type": "string", + "enum": [ + "PENDING", + "AVAILABLE", + "DELETING", + "DELETED" + ] + }, + "LinkList": { + "type": "list", + "member": { + "shape": "Link" + } + }, + "LinkState": { + "type": "string", + "enum": [ + "PENDING", + "AVAILABLE", + "DELETING", + "UPDATING" + ] + }, + "ListTagsForResourceRequest": { + "type": "structure", + "required": [ + "ResourceArn" + ], + "members": { + "ResourceArn": { + "shape": "ResourceARN", + "documentation": "The Amazon Resource Name (ARN) of the resource.
", + "location": "uri", + "locationName": "resourceArn" + } + } + }, + "ListTagsForResourceResponse": { + "type": "structure", + "members": { + "TagList": { + "shape": "TagList", + "documentation": "The list of tags.
" + } + } + }, + "Location": { + "type": "structure", + "members": { + "Address": { + "shape": "String", + "documentation": "The physical address.
" + }, + "Latitude": { + "shape": "String", + "documentation": "The latitude.
" + }, + "Longitude": { + "shape": "String", + "documentation": "The longitude.
" + } + }, + "documentation": "Describes a location.
" + }, + "MaxResults": { + "type": "integer", + "max": 500, + "min": 1 + }, + "RegisterTransitGatewayRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "TransitGatewayArn" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "TransitGatewayArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the transit gateway. For more information, see Resources Defined by Amazon EC2.
" + } + } + }, + "RegisterTransitGatewayResponse": { + "type": "structure", + "members": { + "TransitGatewayRegistration": { + "shape": "TransitGatewayRegistration", + "documentation": "Information about the transit gateway registration.
" + } + } + }, + "ResourceARN": { + "type": "string" + }, + "Site": { + "type": "structure", + "members": { + "SiteId": { + "shape": "String", + "documentation": "The ID of the site.
" + }, + "SiteArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the site.
" + }, + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
" + }, + "Description": { + "shape": "String", + "documentation": "The description of the site.
" + }, + "Location": { + "shape": "Location", + "documentation": "The location of the site.
" + }, + "CreatedAt": { + "shape": "DateTime", + "documentation": "The date and time that the site was created.
" + }, + "State": { + "shape": "SiteState", + "documentation": "The state of the site.
" + }, + "Tags": { + "shape": "TagList", + "documentation": "The tags for the site.
" + } + }, + "documentation": "Describes a site.
" + }, + "SiteList": { + "type": "list", + "member": { + "shape": "Site" + } + }, + "SiteState": { + "type": "string", + "enum": [ + "PENDING", + "AVAILABLE", + "DELETING", + "UPDATING" + ] + }, + "String": { + "type": "string" + }, + "StringList": { + "type": "list", + "member": { + "shape": "String" + } + }, + "Tag": { + "type": "structure", + "members": { + "Key": { + "shape": "TagKey", + "documentation": "The tag key.
Length Constraints: Maximum length of 128 characters.
" + }, + "Value": { + "shape": "TagValue", + "documentation": "The tag value.
Length Constraints: Maximum length of 256 characters.
" + } + }, + "documentation": "Describes a tag.
" + }, + "TagKey": { + "type": "string" + }, + "TagKeyList": { + "type": "list", + "member": { + "shape": "TagKey" + } + }, + "TagList": { + "type": "list", + "member": { + "shape": "Tag" + } + }, + "TagResourceRequest": { + "type": "structure", + "required": [ + "ResourceArn", + "Tags" + ], + "members": { + "ResourceArn": { + "shape": "ResourceARN", + "documentation": "The Amazon Resource Name (ARN) of the resource.
", + "location": "uri", + "locationName": "resourceArn" + }, + "Tags": { + "shape": "TagList", + "documentation": "The tags to apply to the specified resource.
" + } + } + }, + "TagResourceResponse": { + "type": "structure", + "members": {} + }, + "TagValue": { + "type": "string" + }, + "TransitGatewayRegistration": { + "type": "structure", + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
" + }, + "TransitGatewayArn": { + "shape": "String", + "documentation": "The Amazon Resource Name (ARN) of the transit gateway.
" + }, + "State": { + "shape": "TransitGatewayRegistrationStateReason", + "documentation": "The state of the transit gateway registration.
" + } + }, + "documentation": "Describes the registration of a transit gateway to a global network.
" + }, + "TransitGatewayRegistrationList": { + "type": "list", + "member": { + "shape": "TransitGatewayRegistration" + } + }, + "TransitGatewayRegistrationState": { + "type": "string", + "enum": [ + "PENDING", + "AVAILABLE", + "DELETING", + "DELETED", + "FAILED" + ] + }, + "TransitGatewayRegistrationStateReason": { + "type": "structure", + "members": { + "Code": { + "shape": "TransitGatewayRegistrationState", + "documentation": "The code for the state reason.
" + }, + "Message": { + "shape": "String", + "documentation": "The message for the state reason.
" + } + }, + "documentation": "Describes the status of a transit gateway registration.
" + }, + "UntagResourceRequest": { + "type": "structure", + "required": [ + "ResourceArn", + "TagKeys" + ], + "members": { + "ResourceArn": { + "shape": "ResourceARN", + "documentation": "The Amazon Resource Name (ARN) of the resource.
", + "location": "uri", + "locationName": "resourceArn" + }, + "TagKeys": { + "shape": "TagKeyList", + "documentation": "The tag keys to remove from the specified resource.
", + "location": "querystring", + "locationName": "tagKeys" + } + } + }, + "UntagResourceResponse": { + "type": "structure", + "members": {} + }, + "UpdateDeviceRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "DeviceId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "DeviceId": { + "shape": "String", + "documentation": "The ID of the device.
", + "location": "uri", + "locationName": "deviceId" + }, + "Description": { + "shape": "String", + "documentation": "A description of the device.
Length Constraints: Maximum length of 256 characters.
" + }, + "Type": { + "shape": "String", + "documentation": "The type of the device.
" + }, + "Vendor": { + "shape": "String", + "documentation": "The vendor of the device.
Length Constraints: Maximum length of 128 characters.
" + }, + "Model": { + "shape": "String", + "documentation": "The model of the device.
Length Constraints: Maximum length of 128 characters.
" + }, + "SerialNumber": { + "shape": "String", + "documentation": "The serial number of the device.
Length Constraints: Maximum length of 128 characters.
" + }, + "Location": { + "shape": "Location" + }, + "SiteId": { + "shape": "String", + "documentation": "The ID of the site.
" + } + } + }, + "UpdateDeviceResponse": { + "type": "structure", + "members": { + "Device": { + "shape": "Device", + "documentation": "Information about the device.
" + } + } + }, + "UpdateGlobalNetworkRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of your global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "Description": { + "shape": "String", + "documentation": "A description of the global network.
Length Constraints: Maximum length of 256 characters.
" + } + } + }, + "UpdateGlobalNetworkResponse": { + "type": "structure", + "members": { + "GlobalNetwork": { + "shape": "GlobalNetwork", + "documentation": "Information about the global network object.
" + } + } + }, + "UpdateLinkRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "LinkId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "LinkId": { + "shape": "String", + "documentation": "The ID of the link.
", + "location": "uri", + "locationName": "linkId" + }, + "Description": { + "shape": "String", + "documentation": "A description of the link.
Length Constraints: Maximum length of 256 characters.
" + }, + "Type": { + "shape": "String", + "documentation": "The type of the link.
Length Constraints: Maximum length of 128 characters.
" + }, + "Bandwidth": { + "shape": "Bandwidth", + "documentation": "The upload and download speed in Mbps.
" + }, + "Provider": { + "shape": "String", + "documentation": "The provider of the link.
Length Constraints: Maximum length of 128 characters.
" + } + } + }, + "UpdateLinkResponse": { + "type": "structure", + "members": { + "Link": { + "shape": "Link", + "documentation": "Information about the link.
" + } + } + }, + "UpdateSiteRequest": { + "type": "structure", + "required": [ + "GlobalNetworkId", + "SiteId" + ], + "members": { + "GlobalNetworkId": { + "shape": "String", + "documentation": "The ID of the global network.
", + "location": "uri", + "locationName": "globalNetworkId" + }, + "SiteId": { + "shape": "String", + "documentation": "The ID of your site.
", + "location": "uri", + "locationName": "siteId" + }, + "Description": { + "shape": "String", + "documentation": "A description of your site.
Length Constraints: Maximum length of 256 characters.
" + }, + "Location": { + "shape": "Location", + "documentation": "The site location:
Address
: The physical address of the site.
Latitude
: The latitude of the site.
Longitude
: The longitude of the site.
Information about the site.
" + } + } + } + }, + "documentation": "Transit Gateway Network Manager (Network Manager) enables you to create a global network, in which you can monitor your AWS and on-premises networks that are built around transit gateways.
" +} \ No newline at end of file diff --git a/apis/networkmanager-2019-07-05.paginators.json b/apis/networkmanager-2019-07-05.paginators.json new file mode 100644 index 0000000000..37b8fedd68 --- /dev/null +++ b/apis/networkmanager-2019-07-05.paginators.json @@ -0,0 +1,46 @@ +{ + "pagination": { + "DescribeGlobalNetworks": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "GlobalNetworks" + }, + "GetCustomerGatewayAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "CustomerGatewayAssociations" + }, + "GetDevices": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Devices" + }, + "GetLinkAssociations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "LinkAssociations" + }, + "GetLinks": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Links" + }, + "GetSites": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "Sites" + }, + "GetTransitGatewayRegistrations": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "TransitGatewayRegistrations" + } + } +} diff --git a/apis/outposts-2019-12-03.examples.json b/apis/outposts-2019-12-03.examples.json new file mode 100644 index 0000000000..0ea7e3b0bb --- /dev/null +++ b/apis/outposts-2019-12-03.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/apis/outposts-2019-12-03.min.json b/apis/outposts-2019-12-03.min.json new file mode 100644 index 0000000000..9d5ec2f5f6 --- /dev/null +++ b/apis/outposts-2019-12-03.min.json @@ -0,0 +1,199 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-12-03", + "endpointPrefix": "outposts", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "Outposts", + "serviceFullName": "AWS Outposts", + "serviceId": "Outposts", + "signatureVersion": "v4", + "signingName": "outposts", + "uid": "outposts-2019-12-03" + }, + "operations": { + "CreateOutpost": { + "http": { + "requestUri": "/outposts" + }, + "input": { + "type": "structure", + "required": [ + "SiteId" + ], + "members": { + "Name": {}, + "Description": {}, + "SiteId": {}, + "AvailabilityZone": {}, + "AvailabilityZoneId": {} + } + }, + "output": { + "type": "structure", + "members": { + "Outpost": { + "shape": "S8" + } + } + } + }, + "GetOutpost": { + "http": { + "method": "GET", + "requestUri": "/outposts/{OutpostId}" + }, + "input": { + "type": "structure", + "required": [ + "OutpostId" + ], + "members": { + "OutpostId": { + "location": "uri", + "locationName": "OutpostId" + } + } + }, + "output": { + "type": "structure", + "members": { + "Outpost": { + "shape": "S8" + } + } + } + }, + "GetOutpostInstanceTypes": { + "http": { + "method": "GET", + "requestUri": "/outposts/{OutpostId}/instanceTypes" + }, + "input": { + "type": "structure", + "required": [ + "OutpostId" + ], + "members": { + "OutpostId": { + "location": "uri", + "locationName": "OutpostId" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "InstanceTypes": { + "type": "list", + "member": { + "type": "structure", + "members": { + "InstanceType": {} + } + } + }, + "NextToken": {}, + "OutpostId": {}, + "OutpostArn": {} + } + } + }, + "ListOutposts": { + "http": { + "method": "GET", + "requestUri": "/outposts" + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Outposts": { + "type": "list", + "member": { + "shape": "S8" + } + }, + "NextToken": {} + } + } + }, + "ListSites": { + "http": { + "method": "GET", + "requestUri": "/sites" + }, + "input": { + "type": "structure", + "members": { + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "Sites": { + "type": "list", + "member": { + "type": "structure", + "members": { + "SiteId": {}, + "AccountId": {}, + "Name": {}, + "Description": {} + } + } + }, + "NextToken": {} + } + } + } + }, + "shapes": { + "S8": { + "type": "structure", + "members": { + "OutpostId": {}, + "OwnerId": {}, + "OutpostArn": {}, + "SiteId": {}, + "Name": {}, + "Description": {}, + "LifeCycleStatus": {}, + "AvailabilityZone": {}, + "AvailabilityZoneId": {} + } + } + } +} \ No newline at end of file diff --git a/apis/outposts-2019-12-03.normal.json b/apis/outposts-2019-12-03.normal.json new file mode 100644 index 0000000000..778ee4030d --- /dev/null +++ b/apis/outposts-2019-12-03.normal.json @@ -0,0 +1,480 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-12-03", + "endpointPrefix": "outposts", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceAbbreviation": "Outposts", + "serviceFullName": "AWS Outposts", + "serviceId": "Outposts", + "signatureVersion": "v4", + "signingName": "outposts", + "uid": "outposts-2019-12-03" + }, + "operations": { + "CreateOutpost": { + "name": "CreateOutpost", + "http": { + "method": "POST", + "requestUri": "/outposts" + }, + "input": { + "shape": "CreateOutpostInput" + }, + "output": { + "shape": "CreateOutpostOutput" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + }, + { + "shape": "ServiceQuotaExceededException" + } + ], + "documentation": "Creates an Outpost.
" + }, + "GetOutpost": { + "name": "GetOutpost", + "http": { + "method": "GET", + "requestUri": "/outposts/{OutpostId}" + }, + "input": { + "shape": "GetOutpostInput" + }, + "output": { + "shape": "GetOutpostOutput" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Gets information about the specified Outpost.
" + }, + "GetOutpostInstanceTypes": { + "name": "GetOutpostInstanceTypes", + "http": { + "method": "GET", + "requestUri": "/outposts/{OutpostId}/instanceTypes" + }, + "input": { + "shape": "GetOutpostInstanceTypesInput" + }, + "output": { + "shape": "GetOutpostInstanceTypesOutput" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "NotFoundException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Lists the instance types for the specified Outpost.
" + }, + "ListOutposts": { + "name": "ListOutposts", + "http": { + "method": "GET", + "requestUri": "/outposts" + }, + "input": { + "shape": "ListOutpostsInput" + }, + "output": { + "shape": "ListOutpostsOutput" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "List the Outposts for your AWS account.
" + }, + "ListSites": { + "name": "ListSites", + "http": { + "method": "GET", + "requestUri": "/sites" + }, + "input": { + "shape": "ListSitesInput" + }, + "output": { + "shape": "ListSitesOutput" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "AccessDeniedException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Lists the sites for the specified AWS account.
" + } + }, + "shapes": { + "AccountId": { + "type": "string", + "documentation": "The ID of the AWS account.
", + "max": 12, + "min": 12 + }, + "AvailabilityZone": { + "type": "string", + "documentation": "The Availability Zone.
", + "max": 1000, + "min": 1, + "pattern": "[a-z\\d-]+" + }, + "AvailabilityZoneId": { + "type": "string", + "documentation": "The ID of the Availability Zone.
", + "max": 255, + "min": 1, + "pattern": "[a-z]+[0-9]+-az[0-9]+" + }, + "CreateOutpostInput": { + "type": "structure", + "required": [ + "SiteId" + ], + "members": { + "Name": { + "shape": "OutpostName" + }, + "Description": { + "shape": "OutpostDescription" + }, + "SiteId": { + "shape": "SiteId" + }, + "AvailabilityZone": { + "shape": "AvailabilityZone" + }, + "AvailabilityZoneId": { + "shape": "AvailabilityZoneId" + } + } + }, + "CreateOutpostOutput": { + "type": "structure", + "members": { + "Outpost": { + "shape": "Outpost" + } + } + }, + "GetOutpostInput": { + "type": "structure", + "required": [ + "OutpostId" + ], + "members": { + "OutpostId": { + "shape": "OutpostId", + "location": "uri", + "locationName": "OutpostId" + } + } + }, + "GetOutpostInstanceTypesInput": { + "type": "structure", + "required": [ + "OutpostId" + ], + "members": { + "OutpostId": { + "shape": "OutpostId", + "location": "uri", + "locationName": "OutpostId" + }, + "NextToken": { + "shape": "Token", + "location": "querystring", + "locationName": "NextToken" + }, + "MaxResults": { + "shape": "MaxResults1000", + "location": "querystring", + "locationName": "MaxResults" + } + } + }, + "GetOutpostInstanceTypesOutput": { + "type": "structure", + "members": { + "InstanceTypes": { + "shape": "InstanceTypeListDefinition" + }, + "NextToken": { + "shape": "Token" + }, + "OutpostId": { + "shape": "OutpostId" + }, + "OutpostArn": { + "shape": "OutpostArn" + } + } + }, + "GetOutpostOutput": { + "type": "structure", + "members": { + "Outpost": { + "shape": "Outpost" + } + } + }, + "InstanceType": { + "type": "string", + "documentation": "The instance type.
" + }, + "InstanceTypeItem": { + "type": "structure", + "members": { + "InstanceType": { + "shape": "InstanceType" + } + }, + "documentation": "Information about an instance type.
" + }, + "InstanceTypeListDefinition": { + "type": "list", + "member": { + "shape": "InstanceTypeItem" + }, + "documentation": "Information about the instance types.
" + }, + "LifeCycleStatus": { + "type": "string", + "documentation": "The life cycle status.
" + }, + "ListOutpostsInput": { + "type": "structure", + "members": { + "NextToken": { + "shape": "Token", + "location": "querystring", + "locationName": "NextToken" + }, + "MaxResults": { + "shape": "MaxResults1000", + "location": "querystring", + "locationName": "MaxResults" + } + } + }, + "ListOutpostsOutput": { + "type": "structure", + "members": { + "Outposts": { + "shape": "outpostListDefinition" + }, + "NextToken": { + "shape": "Token" + } + } + }, + "ListSitesInput": { + "type": "structure", + "members": { + "NextToken": { + "shape": "Token", + "location": "querystring", + "locationName": "NextToken" + }, + "MaxResults": { + "shape": "MaxResults1000", + "location": "querystring", + "locationName": "MaxResults" + } + } + }, + "ListSitesOutput": { + "type": "structure", + "members": { + "Sites": { + "shape": "siteListDefinition" + }, + "NextToken": { + "shape": "Token" + } + } + }, + "MaxResults1000": { + "type": "integer", + "documentation": "The maximum page size.
", + "box": true, + "max": 1000, + "min": 1 + }, + "Outpost": { + "type": "structure", + "members": { + "OutpostId": { + "shape": "OutpostId" + }, + "OwnerId": { + "shape": "OwnerId" + }, + "OutpostArn": { + "shape": "OutpostArn" + }, + "SiteId": { + "shape": "SiteId" + }, + "Name": { + "shape": "OutpostName" + }, + "Description": { + "shape": "OutpostDescription" + }, + "LifeCycleStatus": { + "shape": "LifeCycleStatus" + }, + "AvailabilityZone": { + "shape": "AvailabilityZone" + }, + "AvailabilityZoneId": { + "shape": "AvailabilityZoneId" + } + }, + "documentation": "Information about an Outpost.
" + }, + "OutpostArn": { + "type": "string", + "documentation": "The Amazon Resource Name (ARN) of the Outpost.
", + "max": 255, + "min": 1, + "pattern": "^arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/op-[a-f0-9]{17}$" + }, + "OutpostDescription": { + "type": "string", + "documentation": "The Outpost description.
", + "max": 1000, + "min": 1, + "pattern": "^[\\S ]+$" + }, + "OutpostId": { + "type": "string", + "documentation": "The ID of the Outpost.
", + "max": 180, + "min": 1, + "pattern": "^(arn:aws([a-z-]+)?:outposts:[a-z\\d-]+:\\d{12}:outpost/)?op-[a-f0-9]{17}$" + }, + "OutpostName": { + "type": "string", + "documentation": "The name of the Outpost.
", + "max": 255, + "min": 1, + "pattern": "^[\\S ]+$" + }, + "OwnerId": { + "type": "string", + "documentation": "The AWS account ID of the Outpost owner.
", + "max": 12, + "min": 12, + "pattern": "\\d{12}" + }, + "Site": { + "type": "structure", + "members": { + "SiteId": { + "shape": "SiteId" + }, + "AccountId": { + "shape": "AccountId" + }, + "Name": { + "shape": "SiteName" + }, + "Description": { + "shape": "SiteDescription" + } + }, + "documentation": "Information about a site.
" + }, + "SiteDescription": { + "type": "string", + "documentation": "The description of the site.
", + "max": 1000, + "min": 1, + "pattern": "^[\\S ]+$" + }, + "SiteId": { + "type": "string", + "documentation": "The ID of the site.
", + "max": 255, + "min": 1, + "pattern": "os-[a-f0-9]{17}" + }, + "SiteName": { + "type": "string", + "documentation": "The name of the site.
", + "max": 1000, + "min": 1, + "pattern": "^[\\S ]+$" + }, + "Token": { + "type": "string", + "documentation": "The pagination token.
", + "max": 1005, + "min": 1, + "pattern": ".*\\S.*" + }, + "outpostListDefinition": { + "type": "list", + "member": { + "shape": "Outpost" + }, + "documentation": "Information about the Outposts.
" + }, + "siteListDefinition": { + "type": "list", + "member": { + "shape": "Site" + }, + "documentation": "Information about the sites.
" + } + }, + "documentation": "AWS Outposts is a fully-managed service that extends AWS infrastructure, APIs, and tools to customer premises. By providing local access to AWS-managed infrastructure, AWS Outposts enables customers to build and run applications on premises using the same programming interfaces as in AWS Regions, while using local compute and storage resources for lower latency and local data processing needs.
" +} \ No newline at end of file diff --git a/apis/outposts-2019-12-03.paginators.json b/apis/outposts-2019-12-03.paginators.json new file mode 100644 index 0000000000..a22e9d094c --- /dev/null +++ b/apis/outposts-2019-12-03.paginators.json @@ -0,0 +1,14 @@ +{ + "pagination": { + "ListOutposts": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListSites": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/apis/s3-2006-03-01.examples.json b/apis/s3-2006-03-01.examples.json index 9a43ef6dab..2abdd37ad4 100644 --- a/apis/s3-2006-03-01.examples.json +++ b/apis/s3-2006-03-01.examples.json @@ -84,13 +84,10 @@ "CreateBucket": [ { "input": { - "Bucket": "examplebucket", - "CreateBucketConfiguration": { - "LocationConstraint": "eu-west-1" - } + "Bucket": "examplebucket" }, "output": { - "Location": "http://examplebucket.s3.amazonaws.com/" + "Location": "/examplebucket" }, "comments": { "input": { @@ -98,16 +95,19 @@ "output": { } }, - "description": "The following example creates a bucket. The request specifies an AWS region where to create the bucket.", - "id": "to-create-a-bucket-in-a-specific-region-1483399072992", - "title": "To create a bucket in a specific region" + "description": "The following example creates a bucket.", + "id": "to-create-a-bucket--1472851826060", + "title": "To create a bucket " }, { "input": { - "Bucket": "examplebucket" + "Bucket": "examplebucket", + "CreateBucketConfiguration": { + "LocationConstraint": "eu-west-1" + } }, "output": { - "Location": "/examplebucket" + "Location": "http://examplebucket.s3.amazonaws.com/" }, "comments": { "input": { @@ -115,9 +115,9 @@ "output": { } }, - "description": "The following example creates a bucket.", - "id": "to-create-a-bucket--1472851826060", - "title": "To create a bucket " + "description": "The following example creates a bucket. The request specifies an AWS region where to create the bucket.", + "id": "to-create-a-bucket-in-a-specific-region-1483399072992", + "title": "To create a bucket in a specific region" } ], "CreateMultipartUpload": [ @@ -292,10 +292,11 @@ { "input": { "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "HappyFace.jpg", + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" }, "output": { - "VersionId": "null" + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" }, "comments": { "input": { @@ -303,18 +304,17 @@ "output": { } }, - "description": "The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.", - "id": "to-remove-tag-set-from-an-object-1483145342862", - "title": "To remove tag set from an object" + "description": "The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.", + "id": "to-remove-tag-set-from-an-object-version-1483145285913", + "title": "To remove tag set from an object version" }, { "input": { "Bucket": "examplebucket", - "Key": "HappyFace.jpg", - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + "Key": "HappyFace.jpg" }, "output": { - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + "VersionId": "null" }, "comments": { "input": { @@ -322,9 +322,9 @@ "output": { } }, - "description": "The following example removes tag set associated with the specified object version. The request specifies both the object key and object version.", - "id": "to-remove-tag-set-from-an-object-version-1483145285913", - "title": "To remove tag set from an object version" + "description": "The following example removes tag set associated with the specified object. If the bucket is versioning enabled, the operation removes tag set from the latest object version.", + "id": "to-remove-tag-set-from-an-object-1483145342862", + "title": "To remove tag set from an object" } ], "DeleteObjects": [ @@ -334,12 +334,10 @@ "Delete": { "Objects": [ { - "Key": "HappyFace.jpg", - "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" + "Key": "objectkey1" }, { - "Key": "HappyFace.jpg", - "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" + "Key": "objectkey2" } ], "Quiet": false @@ -348,12 +346,14 @@ "output": { "Deleted": [ { - "Key": "HappyFace.jpg", - "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" + "DeleteMarker": "true", + "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F", + "Key": "objectkey1" }, { - "Key": "HappyFace.jpg", - "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" + "DeleteMarker": "true", + "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt", + "Key": "objectkey2" } ] }, @@ -363,9 +363,9 @@ "output": { } }, - "description": "The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.", - "id": "to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737", - "title": "To delete multiple object versions from a versioned bucket" + "description": "The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.", + "id": "to-delete-multiple-objects-from-a-versioned-bucket-1483146248805", + "title": "To delete multiple objects from a versioned bucket" }, { "input": { @@ -373,10 +373,12 @@ "Delete": { "Objects": [ { - "Key": "objectkey1" + "Key": "HappyFace.jpg", + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" }, { - "Key": "objectkey2" + "Key": "HappyFace.jpg", + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" } ], "Quiet": false @@ -385,14 +387,12 @@ "output": { "Deleted": [ { - "DeleteMarker": "true", - "DeleteMarkerVersionId": "A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F", - "Key": "objectkey1" + "Key": "HappyFace.jpg", + "VersionId": "yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd" }, { - "DeleteMarker": "true", - "DeleteMarkerVersionId": "iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt", - "Key": "objectkey2" + "Key": "HappyFace.jpg", + "VersionId": "2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b" } ] }, @@ -402,9 +402,9 @@ "output": { } }, - "description": "The following example deletes objects from a bucket. The bucket is versioned, and the request does not specify the object version to delete. In this case, all versions remain in the bucket and S3 adds a delete marker.", - "id": "to-delete-multiple-objects-from-a-versioned-bucket-1483146248805", - "title": "To delete multiple objects from a versioned bucket" + "description": "The following example deletes objects from a bucket. The request specifies object versions. S3 deletes specific object versions and returns the key and versions of deleted objects in the response.", + "id": "to-delete-multiple-object-versions-from-a-versioned-bucket-1483147087737", + "title": "To delete multiple object versions from a versioned bucket" } ], "GetBucketCors": [ @@ -1567,13 +1567,16 @@ "PutObject": [ { "input": { - "Body": "filetoupload", + "Body": "HappyFace.jpg", "Bucket": "examplebucket", - "Key": "objectkey" + "Key": "HappyFace.jpg", + "ServerSideEncryption": "AES256", + "StorageClass": "STANDARD_IA" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ" + "ServerSideEncryption": "AES256", + "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp" }, "comments": { "input": { @@ -1581,9 +1584,9 @@ "output": { } }, - "description": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-create-an-object-1483147613675", - "title": "To create an object." + "description": "The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.", + "id": "to-upload-an-object-(specify-optional-headers)", + "title": "To upload an object (specify optional headers)" }, { "input": { @@ -1611,13 +1614,14 @@ "Body": "filetoupload", "Bucket": "examplebucket", "Key": "exampleobject", - "ServerSideEncryption": "AES256", - "Tagging": "key1=value1&key2=value2" + "Metadata": { + "metadata1": "value1", + "metadata2": "value2" + } }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "ServerSideEncryption": "AES256", - "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt" + "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0" }, "comments": { "input": { @@ -1625,19 +1629,19 @@ "output": { } }, - "description": "The following example uploads and object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831", - "title": "To upload an object and specify server-side encryption and object tags" + "description": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-object-and-specify-user-defined-metadata-1483396974757", + "title": "To upload object and specify user-defined metadata" }, { "input": { - "Body": "HappyFace.jpg", + "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "objectkey" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk" + "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ" }, "comments": { "input": { @@ -1645,20 +1649,19 @@ "output": { } }, - "description": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", - "id": "to-upload-an-object-1481760101010", - "title": "To upload an object" + "description": "The following example creates an object. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-create-an-object-1483147613675", + "title": "To create an object." }, { "input": { - "ACL": "authenticated-read", - "Body": "filetoupload", + "Body": "HappyFace.jpg", "Bucket": "examplebucket", - "Key": "exampleobject" + "Key": "HappyFace.jpg" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr" + "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk" }, "comments": { "input": { @@ -1666,22 +1669,20 @@ "output": { } }, - "description": "The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-upload-an-object-and-specify-canned-acl-1483397779571", - "title": "To upload an object and specify canned ACL." + "description": "The following example uploads an object to a versioning-enabled bucket. The source file is specified using Windows file syntax. S3 returns VersionId of the newly created object.", + "id": "to-upload-an-object-1481760101010", + "title": "To upload an object" }, { "input": { - "Body": "HappyFace.jpg", + "ACL": "authenticated-read", + "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "HappyFace.jpg", - "ServerSideEncryption": "AES256", - "StorageClass": "STANDARD_IA" + "Key": "exampleobject" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "ServerSideEncryption": "AES256", - "VersionId": "CG612hodqujkf8FaaNfp8U..FIhLROcp" + "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr" }, "comments": { "input": { @@ -1689,23 +1690,22 @@ "output": { } }, - "description": "The following example uploads an object. The request specifies optional request headers to directs S3 to use specific storage class and use server-side encryption.", - "id": "to-upload-an-object-(specify-optional-headers)", - "title": "To upload an object (specify optional headers)" + "description": "The following example uploads and object. The request specifies optional canned ACL (access control list) to all READ access to authenticated users. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-an-object-and-specify-canned-acl-1483397779571", + "title": "To upload an object and specify canned ACL." }, { "input": { "Body": "filetoupload", "Bucket": "examplebucket", "Key": "exampleobject", - "Metadata": { - "metadata1": "value1", - "metadata2": "value2" - } + "ServerSideEncryption": "AES256", + "Tagging": "key1=value1&key2=value2" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "pSKidl4pHBiNwukdbcPXAIs.sshFFOc0" + "ServerSideEncryption": "AES256", + "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt" }, "comments": { "input": { @@ -1713,9 +1713,9 @@ "output": { } }, - "description": "The following example creates an object. The request also specifies optional metadata. If the bucket is versioning enabled, S3 returns version ID in response.", - "id": "to-upload-object-and-specify-user-defined-metadata-1483396974757", - "title": "To upload object and specify user-defined metadata" + "description": "The following example uploads and object. The request specifies the optional server-side encryption option. The request also specifies optional object tags. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-upload-an-object-and-specify-server-side-encryption-and-object-tags-1483398331831", + "title": "To upload an object and specify server-side encryption and object tags" } ], "PutObjectAcl": [ diff --git a/apis/s3-2006-03-01.normal.json b/apis/s3-2006-03-01.normal.json index 4e6bed64f0..d8b2c63830 100644 --- a/apis/s3-2006-03-01.normal.json +++ b/apis/s3-2006-03-01.normal.json @@ -32,7 +32,7 @@ } ], "documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html", - "documentation": "This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.
To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts operation and ensure the parts list is empty.
For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
The following operations are related to AbortMultipartUpload
This operation aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts.
To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts operation and ensure that the parts list is empty.
For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
The following operations are related to AbortMultipartUpload
:
Completes a multipart upload by assembling previously uploaded parts.
You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure the parts list is complete, this operation concatenates the parts you provide in the list. For each part in the list, you must provide the part number and the ETag
value, returned after that part was uploaded.
Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends whitespace characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.
Note that if CompleteMultipartUpload
fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.
For more information on multipart uploads, see Uploading Objects Using Multipart Upload.
For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
GetBucketLifecycle
has the following special errors:
Error code: EntityTooSmall
Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.
400 Bad Request
Error code: InvalidPart
Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.
400 Bad Request
Error code: InvalidPartOrder
Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.
400 Bad Request
Error code: NoSuchUpload
Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
404 Not Found
The following operations are related to DeleteBucketMetricsConfiguration
:
Completes a multipart upload by assembling previously uploaded parts.
You first initiate the multipart upload and then upload all parts using the UploadPart operation. After successfully uploading all relevant parts of an upload, you call this operation to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This operation concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the ETag
value, returned after that part was uploaded.
Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded.
Note that if CompleteMultipartUpload
fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices.
For more information about multipart uploads, see Uploading Objects Using Multipart Upload.
For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
GetBucketLifecycle
has the following special errors:
Error code: EntityTooSmall
Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part.
400 Bad Request
Error code: InvalidPart
Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.
400 Bad Request
Error code: InvalidPartOrder
Description: The list of parts was not in ascending order. The parts list must be specified in order by part number.
400 Bad Request
Error code: NoSuchUpload
Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
404 Not Found
The following operations are related to DeleteBucketMetricsConfiguration
:
Creates a copy of an object that is already stored in Amazon S3.
You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic operation using this API. However, for copying an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For conceptual information, see Copy Object Using the REST Multipart Upload API.
When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.
Amazon S3 Transfer Acceleration does not support cross-region copies. If you request a cross-region copy using a Transfer Acceleration endpoint, you get a 400 Bad Request
error. For more information about transfer acceleration, see Transfer Acceleration.
All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.
To only copy an object under certain conditions, such as whether the Etag matches or whether the object was modified before or after a specified date, use the request parameters x-amz-copy-source-if-match
, x-amz-copy-source-if-none-match
, x-amz-copy-source-if-unmodified-since
, or x-amz-copy-source-if-modified-since
.
All headers with the x-amz- prefix, including x-amz-copy-source, must be signed.
You can use this operation to change the storage class of an object that is already stored in Amazon S3 using the StorageClass parameter. For more information, see Storage Classes.
The source object that you are copying can be encrypted or unencrypted. If the source object is encrypted, it can be encrypted by server-side encryption using AWS-managed encryption keys or by using a customer-provided encryption key. When copying an object, you can request that Amazon S3 encrypt the target object by using either the AWS-managed encryption keys or by using your own encryption key. You can do this regardless of the form of server-side encryption that was used to encrypt the source, or even if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption.
A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy operation starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK response. This means that a 200 OK
response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.
If the copy is successful, you receive a response with information about the copied object.
If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.
Consider the following when using request headers:
Consideration 1 – If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data:
x-amz-copy-source-if-match condition evaluates to true
x-amz-copy-source-if-unmodified-since condition evaluates to false
Consideration 2 – If both of the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed response code:
x-amz-copy-source-if-none-match condition evaluates to false
x-amz-copy-source-if-modified-since condition evaluates to true
The copy request charge is based on the storage class and Region you specify for the destination object. For pricing information, see Amazon S3 Pricing.
Following are other considerations when using CopyObject
:
By default, x-amz-copy-source
identifies the current version of an object to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object was deleted.) To copy a different version, use the versionId
subresource.
If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id response header in the response.
If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.
If the source object's storage class is GLACIER, then you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see .
When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
Specify a canned ACL with the x-amz-acl
request header. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
To encrypt the target object, you must provide the appropriate encryption-related request headers. The one you use depends on whether you want to use AWS-managed encryption keys or provide your own encryption key.
To encrypt the target object using server-side encryption with an AWS-managed encryption key, provide the following request headers, as appropriate.
x-amz-server-side​-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side- encryption-aws-kms-key-id, Amazon S3 uses the AWS managed customer master key (CMK) in KMS to protect the data.
All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.
For more information on Server-Side Encryption with CMKs stored in Amazon KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in KMS.
To encrypt the target object using server-side encryption with an encryption key that you provide, use the following headers.
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
If the source object is encrypted using server-side encryption with customer-provided encryption keys, you must use the following headers.
x-amz-copy-source​-server-side​-encryption​-customer-algorithm
x-amz-copy-source​-server-side​-encryption​-customer-key
x-amz-copy-source-​server-side​-encryption​-customer-key-MD5
For more information on Server-Side Encryption with CMKs stored in Amazon KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon KMS.
You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the Access Control List (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:
Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly use:
x-amz-grant-read
x-amz-grant-write
x-amz-grant-read-acp
x-amz-grant-write-acp
x-amz-grant-full-control
You specify each grantee as a type=value pair, where the type is one of the following:
emailAddress – if the value specified is the email address of an AWS account
id – if the value specified is the canonical user ID of an AWS account
uri – if you are granting permissions to a predefined group
For example, the following x-amz-grant-read header grants the AWS accounts identified by email addresses permissions to read object data and its metadata:
x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"
The following operation are related to CopyObject
For more information, see Copying Objects.
", + "documentation": "Creates a copy of an object that is already stored in Amazon S3.
You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic operation using this API. However, for copying an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API.
When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.
Amazon S3 transfer acceleration does not support cross-region copies. If you request a cross-region copy using a transfer acceleration endpoint, you get a 400 Bad Request
error. For more information about transfer acceleration, see Transfer Acceleration.
All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.
To only copy an object under certain conditions, such as whether the Etag
matches or whether the object was modified before or after a specified date, use the request parameters x-amz-copy-source-if-match
, x-amz-copy-source-if-none-match
, x-amz-copy-source-if-unmodified-since
, or x-amz-copy-source-if-modified-since
.
All headers with the x-amz-
prefix, including x-amz-copy-source
, must be signed.
You can use this operation to change the storage class of an object that is already stored in Amazon S3 using the StorageClass
parameter. For more information, see Storage Classes.
The source object that you are copying can be encrypted or unencrypted. If the source object is encrypted, it can be encrypted by server-side encryption using AWS managed encryption keys or by using a customer-provided encryption key. When copying an object, you can request that Amazon S3 encrypt the target object by using either the AWS managed encryption keys or by using your own encryption key. You can do this regardless of the form of server-side encryption that was used to encrypt the source, or even if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption.
A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy operation starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK
response. This means that a 200 OK
response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.
If the copy is successful, you receive a response with information about the copied object.
If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.
Consider the following when using request headers:
Consideration 1 – If both the x-amz-copy-source-if-match
and x-amz-copy-source-if-unmodified-since
headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the data:
x-amz-copy-source-if-match
condition evaluates to true
x-amz-copy-source-if-unmodified-since
condition evaluates to false
Consideration 2 – If both of the x-amz-copy-source-if-none-match
and x-amz-copy-source-if-modified-since
headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed
response code:
x-amz-copy-source-if-none-match
condition evaluates to false
x-amz-copy-source-if-modified-since
condition evaluates to true
The copy request charge is based on the storage class and Region you specify for the destination object. For pricing information, see Amazon S3 Pricing.
Following are other considerations when using CopyObject
:
By default, x-amz-copy-source
identifies the current version of an object to copy. (If the current version is a delete marker, Amazon S3 behaves as if the object was deleted.) To copy a different version, use the versionId
subresource.
If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id
response header in the response.
If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.
If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see .
When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
Specify a canned ACL with the x-amz-acl
request header. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
To encrypt the target object, you must provide the appropriate encryption-related request headers. The one you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key.
To encrypt the target object using server-side encryption with an AWS managed encryption key, provide the following request headers, as appropriate.
x-amz-server-side​-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify x-amz-server-side-encryption:aws:kms
but don't provide x-amz-server-side- encryption-aws-kms-key-id
, Amazon S3 uses the AWS managed customer master key (CMK) in AWS KMS to protect the data.
All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in KMS.
To encrypt the target object using server-side encryption with an encryption key that you provide, use the following headers.
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
If the source object is encrypted using server-side encryption with customer-provided encryption keys, you must use the following headers.
x-amz-copy-source​-server-side​-encryption​-customer-algorithm
x-amz-copy-source​-server-side​-encryption​-customer-key
x-amz-copy-source-​server-side​-encryption​-customer-key-MD5
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in Amazon KMS.
You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:
Specify a canned ACL (x-amz-acl
) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:
x-amz-grant-read
x-amz-grant-write
x-amz-grant-read-acp
x-amz-grant-write-acp
x-amz-grant-full-control
You specify each grantee as a type=value pair, where the type is one of the following:
emailAddress
– if the value specified is the email address of an AWS account
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
For example, the following x-amz-grant-read
header grants the AWS accounts identified by email addresses permissions to read object data and its metadata:
x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"
The following operations are related to CopyObject
:
For more information, see Copying Objects.
", "alias": "PutObjectCopy" }, "CreateBucket": { @@ -91,7 +91,7 @@ } ], "documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html", - "documentation": "Creates a new bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.
Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.
By default, the bucket is created in the US East (N. Virginia) region. You can optionally specify a region in the request body. You might choose a region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the EU (Ireland) region. For more information, see How to Select a Region for Your Buckets.
If you send your create bucket request to the s3.amazonaws.com endpoint, the request go to the us-east-1 region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as region, even if the location constraint in the request specifies another region where the bucket is to be created. If you create a bucket in a region other than US East (N. Virginia) region, your application must be able to handle 307 redirect. For more information, see Virtual Hosting of Buckets.
When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.
Specify a canned ACL using the x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly using the x-amz-grant-read
, x-amz-grant-write
, x-amz-grant-read-acp
, x-amz-grant-write-acp
, x-amz-grant-full-control
headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
emailAddress – if the value specified is the email address of an AWS account
id – if the value specified is the canonical user ID of an AWS account
uri – if you are granting permissions to a predefined group
For example, the following x-amz-grant-read header grants the AWS accounts identified by email addresses permissions to read object data and its metadata:
x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
The following operations are related to CreateBucket
:
Creates a new bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.
Not every string is an acceptable bucket name. For information on bucket naming restrictions, see Working with Amazon S3 Buckets.
By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the EU (Ireland) Region. For more information, see How to Select a Region for Your Buckets.
If you send your create bucket request to the s3.amazonaws.com
endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual Hosting of Buckets.
When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.
Specify a canned ACL using the x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly using the x-amz-grant-read
, x-amz-grant-write
, x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
emailAddress
– if the value specified is the email address of an AWS account
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
For example, the following x-amz-grant-read
header grants the AWS accounts identified by email addresses permissions to read object data and its metadata:
x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
The following operations are related to CreateBucket
:
This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.
For more information about multipart uploads, see Multipart Upload Overview.
If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4).
After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.
You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart) and UploadPartCopy) requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload
.
To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the kms:Encrypt
, kms:Decrypt
, kms:ReEncrypt*
, kms:GenerateDataKey*
, and kms:DescribeKey
actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload.
If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.
For more information, see Protecting Data Using Server-Side Encryption.
When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
Specify a canned ACL with the x-amz-acl
request header. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS-managed encryption keys or provide your own encryption key.
Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in Amazon Key Management Service (KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.
x-amz-server-side​-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side- encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data.
All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.
For more information on Server-Side Encryption with CMKs Stored in Amazon KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
For more information on Server-Side Encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the Access Control List (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:
Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly use:
x-amz-grant-read
x-amz-grant-write
x-amz-grant-read-acp
x-amz-grant-write-acp
x-amz-grant-full-control
You specify each grantee as a type=value pair, where the type is one of the following:
emailAddress – if the value specified is the email address of an AWS account
id – if the value specified is the canonical user ID of an AWS account
uri – if you are granting permissions to a predefined group
For example, the following x-amz-grant-read header grants the AWS accounts identified by email addresses permissions to read object data and its metadata:
x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"
The following operations are related to CreateMultipartUpload
:
This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.
For more information about multipart uploads, see Multipart Upload Overview.
If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4).
After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.
You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart) and UploadPartCopy) requests must match the headers you used in the request to initiate the upload by using CreateMultipartUpload
.
To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the kms:Encrypt
, kms:Decrypt
, kms:ReEncrypt*
, kms:GenerateDataKey*
, and kms:DescribeKey
actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload.
If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.
For more information, see Protecting Data Using Server-Side Encryption.
When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
Specify a canned ACL with the x-amz-acl
request header. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key.
Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.
x-amz-server-side​-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify x-amz-server-side-encryption:aws:kms
, but don't provide x-amz-server-side- encryption-aws-kms-key-id
, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data.
All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:
Specify a canned ACL (x-amz-acl
) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:
x-amz-grant-read
x-amz-grant-write
x-amz-grant-read-acp
x-amz-grant-write-acp
x-amz-grant-full-control
You specify each grantee as a type=value pair, where the type is one of the following:
emailAddress
– if the value specified is the email address of an AWS account
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
For example, the following x-amz-grant-read
header grants the AWS accounts identified by email addresses permissions to read object data and its metadata:
x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"
The following operations are related to CreateMultipartUpload
:
Deletes the bucket. All objects (including all object versions and Delete Markers) in the bucket must be deleted before the bucket itself can be deleted.
Related Resources
Deletes the bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.
Related Resources
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to DeleteBucketAnalyticsConfiguration
:
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to DeleteBucketAnalyticsConfiguration
:
Deletes the cors
configuration information set for the bucket.
To use this operation, you must have permission to perform the s3:PutBucketCORS
action. The bucket owner has this permission by default and can grant this permission to others.
For information more about cors
, go to Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
Related Resources:
" + "documentation": "Deletes the cors
configuration information set for the bucket.
To use this operation, you must have permission to perform the s3:PutBucketCORS
action. The bucket owner has this permission by default and can grant this permission to others.
For information about cors
, see Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
Related Resources:
" }, "DeleteBucketEncryption": { "name": "DeleteBucketEncryption", @@ -170,7 +170,7 @@ "input": { "shape": "DeleteBucketInventoryConfigurationRequest" }, - "documentation": "Deletes an inventory configuration (identified by the inventory ID) from the bucket.
To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration
action. The 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.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
Operation related to DeleteBucketInventoryConfiguration
include:
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration
action. The 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.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
Operations related to DeleteBucketInventoryConfiguration
include:
Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.
To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration
action. The 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.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to DeleteBucketMetricsConfiguration
Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.
To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration
action. The 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.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to DeleteBucketMetricsConfiguration
:
This implementation of the DELETE operation uses the policysubresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy
permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
If you don't have DeleteBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're notusing 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 AWS account that owns a bucket can always use this operation, 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 UserPolicies.
The following operations are related to DeleteBucketPolicy
This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the DeleteBucketPolicy
permissions on the specified bucket and belong to the bucket owner's account to use this operation.
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 AWS account that owns a bucket can always use this operation, 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 UserPolicies.
The following operations are related to DeleteBucketPolicy
Deletes the replication configuration from the bucket.
To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration
action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
It can take a while for the deletion of a replication configuration to fully propagate.
For information about replication configuration, see Replication in the Amazon S3 Developer Guide.
The following operations are related to DeleteBucketReplication
Deletes the replication configuration from the bucket.
To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration
action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
It can take a while for the deletion of a replication configuration to fully propagate.
For information about replication configuration, see Replication in the Amazon S3 Developer Guide.
The following operations are related to DeleteBucketReplication
:
Deletes the tags from the bucket.
To use this operation, you must have permission to perform the s3:PutBucketTagging
action. By default, the bucket owner has this permission and can grant this permission to others.
The following operations are related to DeleteBucketTagging
Deletes the tags from the bucket.
To use this operation, you must have permission to perform the s3:PutBucketTagging
action. By default, the bucket owner has this permission and can grant this permission to others.
The following operations are related to DeleteBucketTagging
:
This operation removes the website configuration for a bucket. Amazon S3 returns a 200 OK
response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK
response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404
response if the bucket specified in the request does not exist.
This DELETE operation requires the S3:DeleteBucketWebsite
permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite
permission.
For more information about hosting websites, see Hosting Websites on Amazon S3.
The following operations are related to DeleteBucketWebsite
This operation removes the website configuration for a bucket. Amazon S3 returns a 200 OK
response upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK
response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a 404
response if the bucket specified in the request does not exist.
This DELETE operation requires the S3:DeleteBucketWebsite
permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the S3:DeleteBucketWebsite
permission.
For more information about hosting websites, see Hosting Websites on Amazon S3.
The following operations are related to DeleteBucketWebsite
:
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.
To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker, to true.
If the object you want to delete is in a bucket where the bucket versioning configurationis MFA Delete enabled, you must include the x-amz-mfa request header in the DELETE versionId request. Requests that include x-amz-mfa must use HTTPS.
For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.
You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket you must deny them the s3:DeleteObject, s3:DeleteObjectVersion and s3:PutLifeCycleConfiguration actions.
The following operation is related to DeleteObject
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.
To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, x-amz-delete-marker
, to true.
If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the x-amz-mfa
request header in the DELETE versionId
request. Requests that include x-amz-mfa
must use HTTPS.
For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.
You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the s3:DeleteObject
, s3:DeleteObjectVersion
, and s3:PutLifeCycleConfiguration
actions.
The following operation is related to DeleteObject
:
Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.
To use this operation, you must have permission to perform the s3:DeleteObjectTagging action.
To delete tags of a specific object version, add the versionId query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging action.
The following operations are related to DeleteBucketMetricsConfiguration
Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.
To use this operation, you must have permission to perform the s3:DeleteObjectTagging
action.
To delete tags of a specific object version, add the versionId
query parameter in the request. You will need permission for the s3:DeleteObjectVersionTagging
action.
The following operations are related to DeleteBucketMetricsConfiguration
:
This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.
The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success, or failure, in the response. Note that, if the object specified in the request is not found, Amazon S3 returns the result as deleted.
The operation supports two modes for the response; verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body.
When performing this operation on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non versioned objects you are attempting to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete.
Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not be altered in transit.
The following operations are related to DeleteObjects
This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.
The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.
The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body.
When performing this operation on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete.
Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.
The following operations are related to DeleteObjects
:
Removes the PublicAccessBlock configuration for an Amazon S3 bucket. In order to use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
The following operations are related to DeleteBucketMetricsConfiguration
:
Removes the PublicAccessBlock
configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock
permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
The following operations are related to DeleteBucketMetricsConfiguration
:
This implementation of the GET operation uses the accelerate
subresource to return the Transfer Acceleration state of a bucket, which is either Enabled
or Suspended
. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.
To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.
You set the Transfer Acceleration state of an existing bucket to Enabled
or Suspended
by using the PutBucketAccelerateConfiguration operation.
A GET accelerate
request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state, if a state has never been set on the bucket.
For more information on transfer acceleration, see Transfer Acceleration in the Amazon Simple Storage Service Developer Guide.
Related Resources
" + "documentation": "This implementation of the GET operation uses the accelerate
subresource to return the Transfer Acceleration state of a bucket, which is either Enabled
or Suspended
. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3.
To use this operation, you must have permission to perform the s3:GetAccelerateConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.
You set the Transfer Acceleration state of an existing bucket to Enabled
or Suspended
by using the PutBucketAccelerateConfiguration operation.
A GET accelerate
request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket.
For more information about transfer acceleration, see Transfer Acceleration in the Amazon Simple Storage Service Developer Guide.
Related Resources
" }, "GetBucketAcl": { "name": "GetBucketAcl", @@ -363,7 +363,7 @@ "shape": "GetBucketCorsOutput" }, "documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html", - "documentation": "Returns the cors configuration information set for the bucket.
To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.
To learn more cors, see Enabling Cross-Origin Resource SharingEnabling Cross-Origin Resource Sharing.
The following operations are related to GetBucketCors
:
Returns the cors configuration information set for the bucket.
To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others.
For more information about cors, see Enabling Cross-Origin Resource Sharing.
The following operations are related to GetBucketCors
:
For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter
element, you should the updated version of this topic. This topic is provided for backward compatibility.
Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration
action. The 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.
GetBucketLifecycle
has the following special error:
Error code: NoSuchLifecycleConfiguration
Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
The following operations are related to GetBucketLifecycle
:
For an updated version of this API, see GetBucketLifecycleConfiguration. If you configured a bucket lifecycle using the filter
element, you should see the updated version of this topic. This topic is provided for backward compatibility.
Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration
action. The 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.
GetBucketLifecycle
has the following special error:
Error code: NoSuchLifecycleConfiguration
Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
The following operations are related to GetBucketLifecycle
:
Returns the region the bucket resides in. You set the bucket's region using the LocationConstraint
request parameter in a CreateBucket
request. For more information, see CreateBucket.
To use this implementation of the operation, you must be the bucket owner.
The following operations are related to GetBucketLocation
:
Returns the Region the bucket resides in. You set the bucket's Region using the LocationConstraint
request parameter in a CreateBucket
request. For more information, see CreateBucket.
To use this implementation of the operation, you must be the bucket owner.
The following operations are related to GetBucketLocation
:
Returns the replication configuration of a bucket.
It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.
For information about replication configuration, see Replication.
This operation requires permissions for the s3:GetReplicationConfiguration
action. For more information about permissions, see Using Bucket Policies and User Policies.
If you include the Filter
element in a replication configuration, you must also include the DeleteMarkerReplication
and Priority
elements. The response also returns those elements.
GetBucketReplication
has the following special error:
Error code: NoSuchReplicationConfiguration
Description: There is no replication configuration with that name.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
The following operations are related to GetBucketReplication
:
Returns the replication configuration of a bucket.
It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result.
For information about replication configuration, see Replication in the Amazon Simple Storage Service Developer Guide.
This operation requires permissions for the s3:GetReplicationConfiguration
action. For more information about permissions, see Using Bucket Policies and User Policies.
If you include the Filter
element in a replication configuration, you must also include the DeleteMarkerReplication
and Priority
elements. The response also returns those elements.
For information about GetBucketReplication
errors, see ReplicationErrorCodeList
The following operations are related to GetBucketReplication
:
Returns the versioning state of a bucket.
To retrieve the versioning state of a bucket, you must be the bucket owner.
This implementation also returns the MFA Delete status of the versioning state, i.e., if the MFA Delete status is enabled
, the bucket owner must use an authentication device to change the versioning state of the bucket.
The following operations are related to GetBucketVersioning
:
Returns the versioning state of a bucket.
To retrieve the versioning state of a bucket, you must be the bucket owner.
This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is enabled
, the bucket owner must use an authentication device to change the versioning state of the bucket.
The following operations are related to GetBucketVersioning
:
Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.
This GET operation requires the S3:GetBucketWebsite
permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite
permission.
The following operations are related to DeleteBucketWebsite
Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.
This GET operation requires the S3:GetBucketWebsite
permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the S3:GetBucketWebsite
permission.
The following operations are related to DeleteBucketWebsite
:
Retrieves objects from Amazon S3. To use GET
, you must have READ
access to the object. If you grant READ
access to the anonymous user, you can return the object without using an authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg
, you can name it photos/2006/February/sample.jpg
.
To get an object from such a logical hierarchy, specify the full key name for the object in the GET
operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg
, specify the resource as /photos/2006/February/sample.jpg
. For a path-style request example, if you have the object photos/2006/February/sample.jpg
in the bucket named examplebucket, specify the resource as /examplebucket/photos/2006/February/sample.jpg
. For more information about request types, see HTTP Host Header Bucket Specification.
To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using . Otherwise, this operation returns an InvalidObjectStateError
error. For information about restoring archived objects, see Restoring Archived Objects.
Encryption request headers, like x-amz-server-side-encryption
, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging
action), the response also returns the x-amz-tagging-count
header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.
Permissions
You need the s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket
permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 will return an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 will return an HTTP status code 403 (\"access denied\") error.
Versioning
By default, the GET operation returns the current version of an object. To return a different version, use the versionId
subresource.
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true
in the response.
For more information about versioning, see PutBucketVersioning.
Overriding Response Header Values
There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.
You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type
, Content-Language
, Expires
, Cache-Control
, Content-Disposition
, and Content-Encoding
. To override these header values in the GET response, you use the following request parameters.
You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
response-content-type
response-content-language
response-expires
response-cache-control
response-content-disposition
response-content-encoding
Additional Considerations about Request Headers
If both of the If-Match
and If-Unmodified-Since
headers are present in the request as follows: If-Match
condition evaluates to true
, and; If-Unmodified-Since
condition evaluates to false
; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match
and If-Modified-Since
headers are present in the request as follows: If-None-Match
condition evaluates to false
, and; If-Modified-Since
condition evaluates to true
; then, S3 returns 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
The following operations are related to GetObject
:
Retrieves objects from Amazon S3. To use GET
, you must have READ
access to the object. If you grant READ
access to the anonymous user, you can return the object without using an authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object sample.jpg
, you can name it photos/2006/February/sample.jpg
.
To get an object from such a logical hierarchy, specify the full key name for the object in the GET
operation. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg
, specify the resource as /photos/2006/February/sample.jpg
. For a path-style request example, if you have the object photos/2006/February/sample.jpg
in the bucket named examplebucket
, specify the resource as /examplebucket/photos/2006/February/sample.jpg
. For more information about request types, see HTTP Host Header Bucket Specification.
To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
If the object you are retrieving is stored in the GLACIER or DEEP_ARCHIVE storage classes, before you can retrieve the object you must first restore a copy using . Otherwise, this operation returns an InvalidObjectStateError
error. For information about restoring archived objects, see Restoring Archived Objects.
Encryption request headers, like x-amz-server-side-encryption
, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging
action), the response also returns the x-amz-tagging-count
header that provides the count of number of tags associated with the object. You can use GetObjectTagging to retrieve the tag set associated with an object.
Permissions
You need the s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket
permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 will return an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 will return an HTTP status code 403 (\"access denied\") error.
Versioning
By default, the GET operation returns the current version of an object. To return a different version, use the versionId
subresource.
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true
in the response.
For more information about versioning, see PutBucketVersioning.
Overriding Response Header Values
There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.
You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are Content-Type
, Content-Language
, Expires
, Cache-Control
, Content-Disposition
, and Content-Encoding
. To override these header values in the GET response, you use the following request parameters.
You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
response-content-type
response-content-language
response-expires
response-cache-control
response-content-disposition
response-content-encoding
Additional Considerations about Request Headers
If both of the If-Match
and If-Unmodified-Since
headers are present in the request as follows: If-Match
condition evaluates to true
, and; If-Unmodified-Since
condition evaluates to false
; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match
and If-Modified-Since
headers are present in the request as follows: If-None-Match
condition evaluates to false
, and; If-Modified-Since
condition evaluates to true
; then, S3 returns 304 Not Modified response code.
For more information about conditional requests, see RFC 7232.
The following operations are related to GetObject
:
Retrieves the PublicAccessBlock
configuration for an Amazon S3 bucket. In order to use this operation, you must have the s3:GetBucketPublicAccessBlock
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or an object, it checks the PublicAccessBlock
configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock
settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
The following operations are related to GetPublicAccessBlock
:
Retrieves the PublicAccessBlock
configuration for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketPublicAccessBlock
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or an object, it checks the PublicAccessBlock
configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock
settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
The following operations are related to GetPublicAccessBlock
:
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.
A HEAD
request has the same options as a GET
operation on an object. The response is identical to the GET
response except that there is no response body.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Encryption request headers, like x-amz-server-side-encryption
, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
Consider the following when using request headers:
Consideration 1 – If both of the If-Match
and If-Unmodified-Since
headers are present in the request as follows:
If-Match
condition evaluates to true
, and;
If-Unmodified-Since
condition evaluates to false
;
Then Amazon S3 returns 200 OK
and the data requested.
Consideration 2 – If both of the If-None-Match
and If-Modified-Since
headers are present in the request as follows:
If-None-Match
condition evaluates to false
, and;
If-Modified-Since
condition evaluates to true
;
Then Amazon S3 returns the 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
Permissions
You need the s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 will return a HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 will return a HTTP status code 403 (\"access denied\") error.
The following operation is related to HeadObject
:
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.
A HEAD
request has the same options as a GET
operation on an object. The response is identical to the GET
response except that there is no response body.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Encryption request headers, like x-amz-server-side-encryption
, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400 BadRequest error.
Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
Consider the following when using request headers:
Consideration 1 – If both of the If-Match
and If-Unmodified-Since
headers are present in the request as follows:
If-Match
condition evaluates to true
, and;
If-Unmodified-Since
condition evaluates to false
;
Then Amazon S3 returns 200 OK
and the data requested.
Consideration 2 – If both of the If-None-Match
and If-Modified-Since
headers are present in the request as follows:
If-None-Match
condition evaluates to false
, and;
If-Modified-Since
condition evaluates to true
;
Then Amazon S3 returns the 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
Permissions
You need the s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 returns an HTTP status code 404 (\"no such key\") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 returns an HTTP status code 403 (\"access denied\") error.
The following operation is related to HeadObject
:
Returns some or all (up to 1000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.
This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects
.
The following operations are related to ListObjects
:
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.
This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing applications. For backward compatibility, Amazon S3 continues to support ListObjects
.
The following operations are related to ListObjects
:
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK
response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.
To use thisoperation, you must have READ access to the bucket.
To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform the s3:ListBucket
action. The 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.
This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.
To get a list of your buckets, see ListBuckets.
The following operations are related to ListObjectsV2
:
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK
response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.
To use this operation, you must have READ access to the bucket.
To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform the s3:ListBucket
action. The 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.
This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.
To get a list of your buckets, see ListBuckets.
The following operations are related to ListObjectsV2
:
Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP permission.
You can use one of the following two ways to set a bucket's permissions:
Specify the ACL in the request body
Specify permissions using request headers
You cannot specify access permission using both the body and the request headers.
Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.
Access Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with the x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. When using these headers you specify explicit access permissions and grantees (AWS accounts or a Amazon S3 groups) who will receive the permission. If you use these ACL specific headers, you cannot use x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
emailAddress – if the value specified is the email address of an AWS account
id – if the value specified is the canonical user ID of an AWS account
uri – if you are granting permissions to a predefined group
For example, the following x-amz-grant-write header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two AWS accounts identified by their email addresses.
x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By Email address:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
By the person's ID:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request
By URI:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
Related Resources
" + "documentation": "Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a bucket, you must have WRITE_ACP
permission.
You can use one of the following two ways to set a bucket's permissions:
Specify the ACL in the request body
Specify permissions using request headers
You cannot specify access permission using both the body and the request headers.
Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.
Access Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with the x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl
. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the x-amz-acl
header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
emailAddress
– if the value specified is the email address of an AWS account
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
For example, the following x-amz-grant-write
header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two AWS accounts identified by their email addresses.
x-amz-grant-write: uri=\"http://acs.amazonaws.com/groups/s3/LogDelivery\", emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By Email address:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
By the person's ID:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request
By URI:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
Related Resources
" }, "PutBucketAnalyticsConfiguration": { "name": "PutBucketAnalyticsConfiguration", @@ -935,7 +935,7 @@ "input": { "shape": "PutBucketAnalyticsConfigurationRequest" }, - "documentation": "Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.
You can choose to have storage class analysis export analysis reports to a comma-separated values (CSV) flat file, see the DataExport request element. Reports are updated daily and are based on the object filters you configure. When selecting data export you specify a destination bucket and optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.
You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
Special Errors
HTTP Error: HTTP 400 Bad Request
Code: InvalidArgument
Cause: Invalid argument.
HTTP Error: HTTP 400 Bad Request
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Error: HTTP 403 Forbidden
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.
Related Resources
Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.
You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the DataExport
request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics – Storage Class Analysis.
You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your Amazon S3 Resources.
Special Errors
HTTP Error: HTTP 400 Bad Request
Code: InvalidArgument
Cause: Invalid argument.
HTTP Error: HTTP 400 Bad Request
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Error: HTTP 403 Forbidden
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.
Related Resources
Sets the cors
configuration for your bucket. If the configuration exists, Amazon S3 replaces it.
To use this operation, you must be allowed to perform the s3:PutBucketCORS
action. By default, the bucket owner has this permission and can grant it to others.
You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com
to access your Amazon S3 bucket at my.example.bucket.com
by using the browser's XMLHttpRequest
capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the cors
subresource to the bucket. The cors
subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.
When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors
configuration on the bucket and uses the first CORSRule
rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:
The request's Origin
header must match AllowedOrigin
elements.
The request method (for example, GET, PUT, HEAD and so on) or the Access-Control-Request-Method
header in case of a pre-flight OPTIONS
request must be one of the AllowedMethod
elements.
Every header specified in the Access-Control-Request-Headers
request header of a pre-flight request must match an AllowedHeader
element.
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
Related Resources
" + "documentation": "Sets the cors
configuration for your bucket. If the configuration exists, Amazon S3 replaces it.
To use this operation, you must be allowed to perform the s3:PutBucketCORS
action. By default, the bucket owner has this permission and can grant it to others.
You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is http://www.example.com
to access your Amazon S3 bucket at my.example.bucket.com
by using the browser's XMLHttpRequest
capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the cors
subresource to the bucket. The cors
subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.
When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the cors
configuration on the bucket and uses the first CORSRule
rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met:
The request's Origin
header must match AllowedOrigin
elements.
The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method
header in case of a pre-flight OPTIONS
request must be one of the AllowedMethod
elements.
Every header specified in the Access-Control-Request-Headers
request header of a pre-flight request must match an AllowedHeader
element.
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
Related Resources
" }, "PutBucketEncryption": { "name": "PutBucketEncryption", @@ -958,7 +958,7 @@ "input": { "shape": "PutBucketEncryptionRequest" }, - "documentation": "This implementation of the PUT
operation uses the encryption
subresource to set the default encryption state of an existing bucket.
This implementation of the PUT
operation sets default encryption for a buckets using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS) bucket. For information about the Amazon S3 default encryption feature, see As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. in the Amazon Simple Storage Service Developer Guide.
This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature Version 4).
To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.
Related Resources
" + "documentation": "This implementation of the PUT
operation uses the encryption
subresource to set the default encryption state of an existing bucket.
This implementation of the PUT
operation sets default encryption for a buckets using server-side encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS) bucket.
This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature Version 4).
To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration
action. The 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 in the Amazon Simple Storage Service Developer Guide.
Related Resources
" }, "PutBucketInventoryConfiguration": { "name": "PutBucketInventoryConfiguration", @@ -1005,7 +1005,7 @@ "shape": "PutBucketLoggingRequest" }, "documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html", - "documentation": "Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.
The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee request element to grant access to other people. The Permissions request element specifies the kind of access the grantee has to the logs.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By the person's ID:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request.
By Email address:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
By URI:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:
<BucketLoggingStatus xmlns=\"http://doc.s3.amazonaws.com/2006-03-01\" />
For more information about server access logging, see Server Access Logging.
For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.
The following operations are related to PutBucketLogging
:
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.
The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee
request element to grant access to other people. The Permissions
request element specifies the kind of access the grantee has to the logs.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By the person's ID:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request.
By Email address:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
By URI:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element:
<BucketLoggingStatus xmlns=\"http://doc.s3.amazonaws.com/2006-03-01\" />
For more information about server access logging, see Server Access Logging.
For more information about creating a bucket, see CreateBucket. For more information about returning the logging status of a bucket, see GetBucketLogging.
The following operations are related to PutBucketLogging
:
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.
To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration action. The 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.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to PutBucketMetricsConfiguration
:
GetBucketLifecycle
has the following special error:
Error code: TooManyConfigurations
Description:You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Status Code: HTTP 400 Bad Request
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.
To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration
action. The 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.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to PutBucketMetricsConfiguration
:
GetBucketLifecycle
has the following special error:
Error code: TooManyConfigurations
Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Status Code: HTTP 400 Bad Request
Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.
Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.
By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration
.
<NotificationConfiguration>
</NotificationConfiguration>
This operation replaces the existing notification configuration with the configuration you include in the request body.
After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.
You can disable notifications by adding the empty NotificationConfiguration element.
By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification
permission.
The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add the configuration to your bucket.
Responses
If the configuration in the request body includes only one TopicConfiguration
specifying only the s3:ReducedRedundancyLostObject event type, the response will also include the x-amz-sns-test-message-id header containing the message ID of the test notification sent to topic.
The following operations is related to PutBucketNotificationConfiguration
:
Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.
Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.
By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty NotificationConfiguration
.
<NotificationConfiguration>
</NotificationConfiguration>
This operation replaces the existing notification configuration with the configuration you include in the request body.
After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.
You can disable notifications by adding the empty NotificationConfiguration element.
By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with s3:PutBucketNotification
permission.
The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add the configuration to your bucket.
Responses
If the configuration in the request body includes only one TopicConfiguration
specifying only the s3:ReducedRedundancyLostObject
event type, the response will also include the x-amz-sns-test-message-id
header containing the message ID of the test notification sent to the topic.
The following operation is related to PutBucketNotificationConfiguration
:
Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 Developer Guide.
To perform this operation, the user or role performing the operation must have the iam:PassRole permission.
Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.
A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket.
To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication
, Status
, and Priority
.
For information about enabling versioning on a bucket, see Using Versioning.
By default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.
Handling Replication of Encrypted Objects
By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following: SourceSelectionCriteria
, SseKmsEncryptedObjects
, Status
, EncryptionConfiguration
, and ReplicaKmsKeyID
. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS.
PutBucketReplication
has the following special errors:
Error code: InvalidRequest
Description: If the <Owner> in <AccessControlTranslation> has a value, the <Account> element must be specified.
HTTP 400
Error code: InvalidArgument
Description: The <Account> element is empty. It must contain a valid account ID.
HTTP 400
Error code: InvalidArgument
Description: The AWS account specified in the <Account> element must match the destination bucket owner.
HTTP 400
The following operations are related to PutBucketReplication
:
Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 Developer Guide.
To perform this operation, the user or role performing the operation must have the iam:PassRole permission.
Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.
A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket.
To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: DeleteMarkerReplication
, Status
, and Priority
.
For information about enabling versioning on a bucket, see Using Versioning.
By default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.
Handling Replication of Encrypted Objects
By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following: SourceSelectionCriteria
, SseKmsEncryptedObjects
, Status
, EncryptionConfiguration
, and ReplicaKmsKeyID
. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS.
For information on PutBucketReplication
errors, see ReplicationErrorCodeList
The following operations are related to PutBucketReplication
:
Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
You can set the versioning state with one of the following values:
Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.
If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.
If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the x-amz-mfa request
header and the Status and the MfaDelete
request elements in a request to set the versioning state of the bucket.
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. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.
Related Resources
" + "documentation": "Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
You can set the versioning state with one of the following values:
Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.
If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.
If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the x-amz-mfa request
header and the Status
and the MfaDelete
request elements in a request to set the versioning state of the bucket.
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. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.
Related Resources
" }, "PutBucketWebsite": { "name": "PutBucketWebsite", @@ -1111,7 +1111,7 @@ "shape": "PutBucketWebsiteRequest" }, "documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html", - "documentation": "Sets the configuration of the website that is specified in the website
subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3.
This PUT operation requires the S3:PutBucketWebsite
permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the S3:PutBucketWebsite
permission.
To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.
WebsiteConfiguration
RedirectAllRequestsTo
HostName
Protocol
If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected.
WebsiteConfiguration
IndexDocument
Suffix
ErrorDocument
Key
RoutingRules
RoutingRule
Condition
HttpErrorCodeReturnedEquals
KeyPrefixEquals
Redirect
Protocol
HostName
ReplaceKeyPrefixWith
ReplaceKeyWith
HttpRedirectCode
Sets the configuration of the website that is specified in the website
subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3.
This PUT operation requires the S3:PutBucketWebsite
permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the S3:PutBucketWebsite
permission.
To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket.
WebsiteConfiguration
RedirectAllRequestsTo
HostName
Protocol
If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected.
WebsiteConfiguration
IndexDocument
Suffix
ErrorDocument
Key
RoutingRules
RoutingRule
Condition
HttpErrorCodeReturnedEquals
KeyPrefixEquals
Redirect
Protocol
HostName
ReplaceKeyPrefixWith
ReplaceKeyWith
HttpRedirectCode
Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.
Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.
To ensure that data is not corrupted traversing the network, use the Content-MD5
header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.
To configure your application to send the request headers before sending the request body, use the 100-continue
HTTP status code. For PUT operations, this helps you avoid sending the message body if the message is rejected based on the headers (for example, because authentication fails or a redirect occurs). For more information on the 100-continue
HTTP status code, see Section 8.2.3 of http://www.ietf.org/rfc/rfc2616.txt.
You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS-managed encryption keys. For more information, see Using Server-Side Encryption.
You can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
Specify a canned ACL with the x-amz-acl
request header. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS-managed encryption keys or provide your own encryption key.
Use encryption keys managed Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.
x-amz-server-side​-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side- encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data.
All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.
For more information on Server-Side Encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS.
Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
For more information on Server-Side Encryption with CMKs stored in KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the Access Control List (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:
Specify a canned ACL (x-amz-acl) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly use:
x-amz-grant-read
x-amz-grant-write
x-amz-grant-read-acp
x-amz-grant-write-acp
x-amz-grant-full-control
You specify each grantee as a type=value pair, where the type is one of the following:
emailAddress – if the value specified is the email address of an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
EU (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported regions and endpoints, see Regions and Endpoints in the AWS General Reference
id – if the value specified is the canonical user ID of an AWS account
uri – if you are granting permissions to a predefined group
For example, the following x-amz-grant-read header grants the AWS accounts identified by email addresses permissions to read object data and its metadata:
x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"
You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS-managed encryption keys or provide your own encryption key.
Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.
x-amz-server-side​-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify x-amz-server-side-encryption:aws:kms, but don't provide x-amz-server-side- encryption-aws-kms-key-id, Amazon S3 uses the default AWS KMS CMK to protect the data.
All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.
For more information on Server-Side Encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.
If you use this feature, the ETag value that Amazon S3 returns in the response is not the MD5 of the object.
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
For more information on Server-Side Encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
Storage Class Options
By default, Amazon S3 uses the Standard storage class to store newly created objects. The Standard storage class provides high durability and high availability. You can specify other storage classes depending on the performance needs. For more information, see Storage Classes in the Amazon Simple Storage Service Developer Guide.
Versioning
If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response using the x-amz-version-id response
header. If versioning is suspended, Amazon S3 always uses null as the version ID for the object stored. For more information about returning the versioning state of a bucket, see GetBucketVersioning. If you enable versioning for a bucket, when Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.
Related Resources
" + "documentation": "Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.
Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.
To ensure that data is not corrupted traversing the network, use the Content-MD5
header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.
To configure your application to send the request headers before sending the request body, use the 100-continue
HTTP status code. For PUT operations, this helps you avoid sending the message body if the message is rejected based on the headers (for example, because authentication fails or a redirect occurs). For more information on the 100-continue
HTTP status code, see Section 8.2.3 of http://www.ietf.org/rfc/rfc2616.txt.
You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys. For more information, see Using Server-Side Encryption.
You can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
Specify a canned ACL with the x-amz-acl
request header. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key.
Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.
x-amz-server-side​-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify x-amz-server-side-encryption:aws:kms
, but don't provide x-amz-server-side- encryption-aws-kms-key-id
, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data.
All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS.
Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
For more information about server-side encryption with CMKs stored in KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the Access Control List (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:
Specify a canned ACL (x-amz-acl
) — Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly use:
x-amz-grant-read
x-amz-grant-write
x-amz-grant-read-acp
x-amz-grant-write-acp
x-amz-grant-full-control
You specify each grantee as a type=value pair, where the type is one of the following:
emailAddress
– if the value specified is the email address of an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
EU (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
For example, the following x-amz-grant-read
header grants the AWS accounts identified by email addresses permissions to read object data and its metadata:
x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"
You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS-managed encryption keys or provide your own encryption key.
Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.
x-amz-server-side​-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify x-amz-server-side-encryption:aws:kms
, but don't provide x-amz-server-side- encryption-aws-kms-key-id
, Amazon S3 uses the default AWS KMS CMK to protect the data.
All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.
If you use this feature, the ETag value that Amazon S3 returns in the response is not the MD5 of the object.
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
Storage Class Options
By default, Amazon S3 uses the Standard storage class to store newly created objects. The Standard storage class provides high durability and high availability. You can specify other storage classes depending on the performance needs. For more information, see Storage Classes in the Amazon Simple Storage Service Developer Guide.
Versioning
If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response using the x-amz-version-id response
header. If versioning is suspended, Amazon S3 always uses null as the version ID for the object stored. For more information about returning the versioning state of a bucket, see GetBucketVersioning. If you enable versioning for a bucket, when Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.
Related Resources
" }, "PutObjectAcl": { "name": "PutObjectAcl", @@ -1146,7 +1146,7 @@ } ], "documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html", - "documentation": "uses the acl subresource to set the access control list (ACL) permissions for an object that already exists in a bucket. You must have WRITE_ACP permission to set the ACL of an object.
Depending on your application needs, you may choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.
Access Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with the x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-acl. If you use this header, you cannot use other access control specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. When using these headers you specify explicit access permissions and grantees (AWS accounts or a Amazon S3 groups) who will receive the permission. If you use these ACL specific headers, you cannot use x-amz-acl header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
emailAddress – if the value specified is the email address of an AWS account
id – if the value specified is the canonical user ID of an AWS account
uri – if you are granting permissions to a predefined group
For example, the following x-amz-grant-read header grants list objects permission to the two AWS accounts identified by their email addresses.
x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By Email address:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
By the person's ID:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request
By URI:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
Versioning
The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId
subresource.
Related Resources
" + "documentation": "Uses the acl
subresource to set the access control list (ACL) permissions for an object that already exists in a bucket. You must have WRITE_ACP
permission to set the ACL of an object.
Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach.
Access Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with the x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of x-amz-ac
l. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use x-amz-acl
header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
emailAddress
– if the value specified is the email address of an AWS account
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
For example, the following x-amz-grant-read
header grants list objects permission to the two AWS accounts identified by their email addresses.
x-amz-grant-read: emailAddress=\"xyz@amazon.com\", emailAddress=\"abc@amazon.com\"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By Email address:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"AmazonCustomerByEmail\"><EmailAddress><>Grantees@email.com<></EmailAddress>lt;/Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
By the person's ID:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"CanonicalUser\"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request.
By URI:
<Grantee xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xsi:type=\"Group\"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
Versioning
The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the versionId
subresource.
Related Resources
" }, "PutObjectLegalHold": { "name": "PutObjectLegalHold", @@ -1213,7 +1213,7 @@ "input": { "shape": "PutPublicAccessBlockRequest" }, - "documentation": "Creates or modifies the PublicAccessBlock
configuration for an Amazon S3 bucket. In order to use this operation, you must have the s3:PutBucketPublicAccessBlock
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.
When Amazon S3 evaluates the PublicAccessBlock configuration for a bucket or an object, it checks the PublicAccessBlock configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
Related Resources
Creates or modifies the PublicAccessBlock
configuration for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketPublicAccessBlock
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or an object, it checks the PublicAccessBlock
configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the PublicAccessBlock
configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of \"Public\".
Related Resources
Restores an archived copy of an object back into Amazon S3
This operation performs the following types of requests:
select
- Perform a select query on an archived object
restore an archive
- Restore an archived object
To use this operation, you must have permissions to perform the s3:RestoreObject
and s3:GetObject
actions. The 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 in the Amazon Simple Storage Service Developer Guide.
Querying Archives with Select Requests
You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide.
When making a select request, do the following:
Define an output location for the select query's output. This must be an Amazon S3 bucket in the same AWS Region as the bucket that contains the archive object that is being queried. The AWS account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide.
For more information about the S3
structure in the request body, see the following:
Managing Access with ACLs in the Amazon Simple Storage Service Developer Guide
Protecting Data Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide
Define the SQL expression for the SELECT
type of restoration for your query in the request body's SelectParameters
structure. You can use expressions like the following examples.
The following expression returns all records from the specified object.
SELECT * FROM Object
Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.
SELECT s._1, s._2 FROM Object s WHERE s._3 > 100
If you have headers and you set the fileHeaderInfo
in the CSV
structure in the request body to USE
, you can specify headers in the query. (If you set the fileHeaderInfo
field to IGNORE
, the first row is skipped for the query.) You cannot mix ordinal positions with header column names.
SELECT s.Id, s.FirstName, s.SSN FROM S3Object s
For more information about using SQL with Glacier Select restore, see SQL Reference for Amazon S3 Select and Glacier Select in the Amazon Simple Storage Service Developer Guide.
When making a select request, you can also do the following:
To expedite your queries, specify the Expedited
tier. For more information about tiers, see \"Restoring Archives,\" later in this topic.
Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.
The following are additional important facts about the select feature:
The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy.
You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests.
Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409
.
Restoring Archives
Objects in the GLACIER and DEEP_ARCHIVE storage classes are archived. To access an archived object, you must first initiate a restore request. This restores a temporary copy of the archived object. In a restore request, you specify the number of days that you want the restored copy to exist. After the specified period, Amazon S3 deletes the temporary copy but the object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object was restored from.
To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.
The time it takes restore jobs to finish depends on which storage class the object is being restored from and which data access tier you specify.
When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier
element of the request body:
Expedited
- Expedited retrievals allow you to quickly access your data stored in the GLACIER storage class when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals are typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for the DEEP_ARCHIVE storage class.
Standard
- Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify the retrieval option. Standard retrievals typically complete within 3-5 hours from the GLACIER storage class and typically complete within 12 hours from the DEEP_ARCHIVE storage class.
Bulk
- Bulk retrievals are Amazon Glacier’s lowest-cost retrieval option, enabling you to retrieve large amounts, even petabytes, of data inexpensively in a day. Bulk retrievals typically complete within 5-12 hours from the GLACIER storage class and typically complete within 48 hours from the DEEP_ARCHIVE storage class.
For more information about archive retrieval options and provisioned capacity for Expedited
data access, see Restoring Archived Objects in the Amazon Simple Storage Service Developer Guide.
You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. You upgrade the speed of an in-progress restoration by issuing another restore request to the same object, setting a new Tier
request element. When issuing a request to upgrade the restore tier, you must choose a tier that is faster than the tier that the in-progress restore is using. You must not change any other parameters, such as the Days
request element. For more information, see Upgrading the Speed of an In-Progress Restore in the Amazon Simple Storage Service Developer Guide.
To get the status of object restoration, you can send a HEAD
request. Operations return the x-amz-restore
header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon Simple Storage Service Developer Guide.
After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.
If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon Simple Storage Service Developer Guide.
Responses
A successful operation returns either the 200 OK
or 202 Accepted
status code.
If the object copy is not previously restored, then Amazon S3 returns 202 Accepted
in the response.
If the object copy is previously restored, Amazon S3 returns 200 OK
in the response.
Special Errors
Code: RestoreAlreadyInProgress
Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: GlacierExpeditedRetrievalNotAvailable
Cause: Glacier expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to Standard or Bulk retrievals.)
HTTP Status Code: 503
SOAP Fault Code Prefix: N/A
Related Resources
SQL Reference for Amazon S3 Select and Glacier Select in the Amazon Simple Storage Service Developer Guide
Restores an archived copy of an object back into Amazon S3
This operation performs the following types of requests:
select
- Perform a select query on an archived object
restore an archive
- Restore an archived object
To use this operation, you must have permissions to perform the s3:RestoreObject
and s3:GetObject
actions. The 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 in the Amazon Simple Storage Service Developer Guide.
Querying Archives with Select Requests
You use a select type of request to perform SQL queries on archived objects. The archived objects that are being queried by the select request must be formatted as uncompressed comma-separated values (CSV) files. You can run queries and custom analytics on your archived data without having to restore your data to a hotter Amazon S3 tier. For an overview about select requests, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide.
When making a select request, do the following:
Define an output location for the select query's output. This must be an Amazon S3 bucket in the same AWS Region as the bucket that contains the archive object that is being queried. The AWS account that initiates the job must have permissions to write to the S3 bucket. You can specify the storage class and encryption for the output objects stored in the bucket. For more information about output, see Querying Archived Objects in the Amazon Simple Storage Service Developer Guide.
For more information about the S3
structure in the request body, see the following:
Managing Access with ACLs in the Amazon Simple Storage Service Developer Guide
Protecting Data Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide
Define the SQL expression for the SELECT
type of restoration for your query in the request body's SelectParameters
structure. You can use expressions like the following examples.
The following expression returns all records from the specified object.
SELECT * FROM Object
Assuming that you are not using any headers for data stored in the object, you can specify columns with positional headers.
SELECT s._1, s._2 FROM Object s WHERE s._3 > 100
If you have headers and you set the fileHeaderInfo
in the CSV
structure in the request body to USE
, you can specify headers in the query. (If you set the fileHeaderInfo
field to IGNORE
, the first row is skipped for the query.) You cannot mix ordinal positions with header column names.
SELECT s.Id, s.FirstName, s.SSN FROM S3Object s
For more information about using SQL with Glacier Select restore, see SQL Reference for Amazon S3 Select and Glacier Select in the Amazon Simple Storage Service Developer Guide.
When making a select request, you can also do the following:
To expedite your queries, specify the Expedited
tier. For more information about tiers, see \"Restoring Archives,\" later in this topic.
Specify details about the data serialization format of both the input object that is being queried and the serialization of the CSV-encoded query results.
The following are additional important facts about the select feature:
The output results are new Amazon S3 objects. Unlike archive retrievals, they are stored until explicitly deleted-manually or through a lifecycle policy.
You can issue more than one select request on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid issuing duplicate requests.
Amazon S3 accepts a select request even if the object has already been restored. A select request doesn’t return error response 409
.
Restoring Archives
Objects in the GLACIER and DEEP_ARCHIVE storage classes are archived. To access an archived object, you must first initiate a restore request. This restores a temporary copy of the archived object. In a restore request, you specify the number of days that you want the restored copy to exist. After the specified period, Amazon S3 deletes the temporary copy but the object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object was restored from.
To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.
The time it takes restore jobs to finish depends on which storage class the object is being restored from and which data access tier you specify.
When restoring an archived object (or using a select request), you can specify one of the following data access tier options in the Tier
element of the request body:
Expedited
- Expedited retrievals allow you to quickly access your data stored in the GLACIER storage class when occasional urgent requests for a subset of archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals are typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for the DEEP_ARCHIVE storage class.
Standard
- Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify the retrieval option. Standard retrievals typically complete within 3-5 hours from the GLACIER storage class and typically complete within 12 hours from the DEEP_ARCHIVE storage class.
Bulk
- Bulk retrievals are Amazon S3 Glacier’s lowest-cost retrieval option, enabling you to retrieve large amounts, even petabytes, of data inexpensively in a day. Bulk retrievals typically complete within 5-12 hours from the GLACIER storage class and typically complete within 48 hours from the DEEP_ARCHIVE storage class.
For more information about archive retrieval options and provisioned capacity for Expedited
data access, see Restoring Archived Objects in the Amazon Simple Storage Service Developer Guide.
You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. You upgrade the speed of an in-progress restoration by issuing another restore request to the same object, setting a new Tier
request element. When issuing a request to upgrade the restore tier, you must choose a tier that is faster than the tier that the in-progress restore is using. You must not change any other parameters, such as the Days
request element. For more information, see Upgrading the Speed of an In-Progress Restore in the Amazon Simple Storage Service Developer Guide.
To get the status of object restoration, you can send a HEAD
request. Operations return the x-amz-restore
header, which provides information about the restoration status, in the response. You can use Amazon S3 event notifications to notify you when a restore is initiated or completed. For more information, see Configuring Amazon S3 Event Notifications in the Amazon Simple Storage Service Developer Guide.
After restoring an archived object, you can update the restoration period by reissuing the request with a new period. Amazon S3 updates the restoration period relative to the current time and charges only for the request-there are no data transfer charges. You cannot update the restoration period when Amazon S3 is actively processing your current restore request for the object.
If your bucket has a lifecycle configuration with a rule that includes an expiration action, the object expiration overrides the life span that you specify in a restore request. For example, if you restore an object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon S3 deletes the object in 3 days. For more information about lifecycle configuration, see PutBucketLifecycleConfiguration and Object Lifecycle Management in Amazon Simple Storage Service Developer Guide.
Responses
A successful operation returns either the 200 OK
or 202 Accepted
status code.
If the object copy is not previously restored, then Amazon S3 returns 202 Accepted
in the response.
If the object copy is previously restored, Amazon S3 returns 200 OK
in the response.
Special Errors
Code: RestoreAlreadyInProgress
Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: GlacierExpeditedRetrievalNotAvailable
Cause: Glacier expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to Standard or Bulk retrievals.)
HTTP Status Code: 503
SOAP Fault Code Prefix: N/A
Related Resources
SQL Reference for Amazon S3 Select and Glacier Select in the Amazon Simple Storage Service Developer Guide
Uploads a part in a multipart upload.
In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.
You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request.
Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload.
To ensure that data is not corrupted when traversing the network, specify the Content-MD5
header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
For more information on multipart uploads, go to Multipart Upload Overview in the Amazon Simple Storage Service Developer Guide .
For information on the permissions required to use the multipart upload API, go to Multipart Upload API and Permissions in the Amazon Simple Storage Service Developer Guide.
You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the AWS-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. For more information, go to Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide.
Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload.
If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
Special Errors
Code: NoSuchUpload
Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Related Resources
" + "documentation": "Uploads a part in a multipart upload.
In this operation, you provide part data in your request. However, you have an option to specify your existing Amazon S3 object as a data source for the part you are uploading. To upload a part from an existing object, you use the UploadPartCopy operation.
You must initiate a multipart upload (see CreateMultipartUpload) before you can upload any part. In response to your initiate request, Amazon S3 returns an upload ID, a unique identifier, that you must include in your upload part request.
Part numbers can be any number from 1 to 10,000, inclusive. A part number uniquely identifies a part and also defines its position within the object being created. If you upload a new part using the same part number that was used with a previous part, the previously uploaded part is overwritten. Each part must be at least 5 MB in size, except the last part. There is no size limit on the last part of your multipart upload.
To ensure that data is not corrupted when traversing the network, specify the Content-MD5
header in the upload part request. Amazon S3 checks the part data against the provided MD5 value. If they do not match, Amazon S3 returns an error.
Note: After you initiate multipart upload and upload one or more parts, you must either complete or abort multipart upload in order to stop getting charged for storage of the uploaded parts. Only after you either complete or abort multipart upload, Amazon S3 frees up the parts storage and stops charging you for the parts storage.
For more information on multipart uploads, go to Multipart Upload Overview in the Amazon Simple Storage Service Developer Guide .
For information on the permissions required to use the multipart upload API, go to Multipart Upload API and Permissions in the Amazon Simple Storage Service Developer Guide.
You can optionally request server-side encryption where Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. You have the option of providing your own encryption key, or you can use the AWS managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in the request must match the headers you used in the request to initiate the upload by using CreateMultipartUpload. For more information, go to Using Server-Side Encryption in the Amazon Simple Storage Service Developer Guide.
Server-side encryption is supported by the S3 Multipart Upload actions. Unless you are using a customer-provided encryption key, you don't need to specify the encryption parameters in each UploadPart request. Instead, you only need to specify the server-side encryption parameters in the initial Initiate Multipart request. For more information, see CreateMultipartUpload.
If you requested server-side encryption using a customer-provided encryption key in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following headers.
x-amz-server-side​-encryption​-customer-algorithm
x-amz-server-side​-encryption​-customer-key
x-amz-server-side​-encryption​-customer-key-MD5
Special Errors
Code: NoSuchUpload
Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Related Resources
" }, "UploadPartCopy": { "name": "UploadPartCopy", @@ -1282,7 +1282,7 @@ "shape": "UploadPartCopyOutput" }, "documentationUrl": "http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html", - "documentation": "Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source
in your request and a byte range by adding the request header x-amz-copy-source-range
in your request.
The minimum allowable part size for a multipart upload is 5 MB. For more information about multipart upload limits, go to Quick Facts in the Amazon Simple Storage Service Developer Guide.
Instead of using an existing object as part data, you might use the UploadPart operation and provide data in your request.
You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.
For more information on using the UploadPartCopy operation, see the following topics:
For conceptual information on multipart uploads, go to Uploading Objects Using Multipart Upload in the Amazon Simple Storage Service Developer Guide.
For information on permissions required to use the multipart upload API, go to Multipart Upload API and Permissions in the Amazon Simple Storage Service Developer Guide.
For information about copying objects using a single atomic operation vs. the multipart upload, go to Operations on Objects in the Amazon Simple Storage Service Developer Guide.
For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.
Note the following additional considerations about the request headers x-amz-copy-source-if-match
, x-amz-copy-source-if-none-match
x-amz-copy-source-if-unmodified-since
x-amz-copy-source-if-modified-since
Consideration 1 - If both of the x-amz-copy-source-if-match
and x-amz-copy-source-if-unmodified-since
headers are present in the request as follows:
x-amz-copy-source-if-match
condition evaluates to true
, and;
x-amz-copy-source-if-unmodified-since
condition evaluates to false
;
then, S3 returns 200 OK
and copies the data.
Consideration 2 - If both of the x-amz-copy-source-if-none-match
and x-amz-copy-source-if-modified-since
headers are present in the request as follows:
x-amz-copy-source-if-none-match
condition evaluates to false
, and;
x-amz-copy-source-if-modified-since
condition evaluates to true
;
then, S3 returns 412 Precondition Failed
response code.
Versioning
If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source
identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source
, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-amz-copy-source
and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source
.
You can optionally specify a specific version of the source object to copy by adding the versionId
subresource as shown in the following example:
x-amz-copy-source: /bucket/object?versionId=version id
Special Errors
Code: NoSuchUpload
Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
HTTP Status Code: 404 Not Found
Code: InvalidRequest
Cause: The specified copy source is not supported as a byte-range copy source.
HTTP Status Code: 400 Bad Request
Related Resources
Uploads a part by copying data from an existing object as data source. You specify the data source by adding the request header x-amz-copy-source
in your request and a byte range by adding the request header x-amz-copy-source-range
in your request.
The minimum allowable part size for a multipart upload is 5 MB. For more information about multipart upload limits, go to Quick Facts in the Amazon Simple Storage Service Developer Guide.
Instead of using an existing object as part data, you might use the UploadPart operation and provide data in your request.
You must initiate a multipart upload before you can upload any part. In response to your initiate request. Amazon S3 returns a unique identifier, the upload ID, that you must include in your upload part request.
For more information about using the UploadPartCopy
operation, see the following:
For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon Simple Storage Service Developer Guide.
For information about permissions required to use the multipart upload API, see Multipart Upload API and Permissions in the Amazon Simple Storage Service Developer Guide.
For information about copying objects using a single atomic operation vs. the multipart upload, see Operations on Objects in the Amazon Simple Storage Service Developer Guide.
For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.
Note the following additional considerations about the request headers x-amz-copy-source-if-match
, x-amz-copy-source-if-none-match
, x-amz-copy-source-if-unmodified-since
, and x-amz-copy-source-if-modified-since
:
Consideration 1 - If both of the x-amz-copy-source-if-match
and x-amz-copy-source-if-unmodified-since
headers are present in the request as follows:
x-amz-copy-source-if-match
condition evaluates to true
, and;
x-amz-copy-source-if-unmodified-since
condition evaluates to false
;
Amazon S3 returns 200 OK
and copies the data.
Consideration 2 - If both of the x-amz-copy-source-if-none-match
and x-amz-copy-source-if-modified-since
headers are present in the request as follows:
x-amz-copy-source-if-none-match
condition evaluates to false
, and;
x-amz-copy-source-if-modified-since
condition evaluates to true
;
Amazon S3 returns 412 Precondition Failed
response code.
Versioning
If your bucket has versioning enabled, you could have multiple versions of the same object. By default, x-amz-copy-source
identifies the current version of the object to copy. If the current version is a delete marker and you don't specify a versionId in the x-amz-copy-source
, Amazon S3 returns a 404 error, because the object does not exist. If you specify versionId in the x-amz-copy-source
and the versionId is a delete marker, Amazon S3 returns an HTTP 400 error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source
.
You can optionally specify a specific version of the source object to copy by adding the versionId
subresource as shown in the following example:
x-amz-copy-source: /bucket/object?versionId=version id
Special Errors
Code: NoSuchUpload
Cause: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
HTTP Status Code: 404 Not Found
Code: InvalidRequest
Cause: The specified copy source is not supported as a byte-range copy source.
HTTP Status Code: 400 Bad Request
Related Resources
The bucket to which the upload was taking place.
", + "documentation": "The bucket name to which the upload was taking place.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -1729,7 +1729,7 @@ "documentation": "Specifies that CSV field values may contain quoted record delimiters and such records should be allowed. Default value is FALSE. Setting this value to TRUE may lower performance.
" } }, - "documentation": "Describes how a uncompressed comma-separated values (CSV)-formatted input object is formatted.
" + "documentation": "Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.
" }, "CSVOutput": { "type": "structure", @@ -1784,7 +1784,7 @@ }, "InvocationRole": { "shape": "CloudFunctionInvocationRole", - "documentation": "The role supporting the invocation of the lambda function
" + "documentation": "The role supporting the invocation of the Lambda function
" } }, "documentation": "Container for specifying the AWS Lambda notification configuration.
" @@ -1854,7 +1854,7 @@ }, "SSEKMSKeyId": { "shape": "SSEKMSKeyId", - "documentation": "If present, specifies the ID of the AWS Key Management Service (KMS) customer master key (CMK) that was used for the object.
", + "documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used for the object.
", "location": "header", "locationName": "x-amz-server-side-encryption-aws-kms-key-id" }, @@ -1956,7 +1956,7 @@ }, "KeyPrefixEquals": { "shape": "KeyPrefixEquals", - "documentation": "The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html
, the key prefix will be ExamplePage.html
. To redirect request for all pages with the prefix docs/
, the key prefix will be /docs
, which identifies all objects in the docs/ folder. Required when the parent element Condition
is specified and sibling HttpErrorCodeReturnedEquals
is not specified. If both conditions are specified, both must be true for the redirect to be applied.
The object key name prefix when the redirect is applied. For example, to redirect requests for ExamplePage.html
, the key prefix will be ExamplePage.html
. To redirect request for all pages with the prefix docs/
, the key prefix will be /docs
, which identifies all objects in the docs/
folder. Required when the parent element Condition
is specified and sibling HttpErrorCodeReturnedEquals
is not specified. If both conditions are specified, both must be true for the redirect to be applied.
A container for describing a condition that must be met for the specified redirect to apply. For example, 1. If request is for pages in the /docs
folder, redirect to the /documents
folder. 2. If request results in HTTP error 4xx, redirect request to another host where you might process the error.
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
", + "documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "location": "header", "locationName": "x-amz-server-side-encryption" }, @@ -2030,13 +2030,13 @@ }, "SSECustomerKeyMD5": { "shape": "SSECustomerKeyMD5", - "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
", + "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId": { "shape": "SSEKMSKeyId", - "documentation": "If present, specifies the ID of the AWS Key Management Service (KMS) customer master key (CMK) that was used for the object.
", + "documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used for the object.
", "location": "header", "locationName": "x-amz-server-side-encryption-aws-kms-key-id" }, @@ -2190,7 +2190,7 @@ }, "ServerSideEncryption": { "shape": "ServerSideEncryption", - "documentation": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
", + "documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "location": "header", "locationName": "x-amz-server-side-encryption" }, @@ -2208,25 +2208,25 @@ }, "SSECustomerAlgorithm": { "shape": "SSECustomerAlgorithm", - "documentation": "Specifies the algorithm to use to when encrypting the object (e.g., AES256).
", + "documentation": "Specifies the algorithm to use to when encrypting the object (for example, AES256).
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey": { "shape": "SSECustomerKey", - "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
", + "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm
header.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
", + "documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId": { "shape": "SSEKMSKeyId", - "documentation": "Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
", + "documentation": "Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 Developer Guide.
", "location": "header", "locationName": "x-amz-server-side-encryption-aws-kms-key-id" }, @@ -2238,7 +2238,7 @@ }, "CopySourceSSECustomerAlgorithm": { "shape": "CopySourceSSECustomerAlgorithm", - "documentation": "Specifies the algorithm to use when decrypting the source object (e.g., AES256).
", + "documentation": "Specifies the algorithm to use when decrypting the source object (for example, AES256).
", "location": "header", "locationName": "x-amz-copy-source-server-side-encryption-customer-algorithm" }, @@ -2250,7 +2250,7 @@ }, "CopySourceSSECustomerKeyMD5": { "shape": "CopySourceSSECustomerKeyMD5", - "documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
", + "documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
", "location": "header", "locationName": "x-amz-copy-source-server-side-encryption-customer-key-MD5" }, @@ -2261,7 +2261,7 @@ }, "Tagging": { "shape": "TaggingHeader", - "documentation": "The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters
", + "documentation": "The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective
. The tag-set must be encoded as URL Query parameters.
Returns the date that the object was last modified.
" } }, - "documentation": ">Container for all response elements.
" + "documentation": "Container for all response elements.
" }, "CopyPartResult": { "type": "structure", @@ -2350,7 +2350,7 @@ "members": { "LocationConstraint": { "shape": "BucketLocationConstraint", - "documentation": "Specifies the region where the bucket will be created. If you don't specify a region, the bucket is created in US East (N. Virginia) Region (us-east-1).
" + "documentation": "Specifies the Region where the bucket will be created. If you don't specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1).
" } }, "documentation": "The configuration information for the bucket.
" @@ -2360,7 +2360,7 @@ "members": { "Location": { "shape": "Location", - "documentation": "Specifies the region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) region (us-east-1), you do not need to specify the location.
", + "documentation": "Specifies the Region where the bucket will be created. If you are creating a bucket on the US East (N. Virginia) Region (us-east-1), you do not need to specify the location.
", "location": "header", "locationName": "Location" } @@ -2436,19 +2436,19 @@ "members": { "AbortDate": { "shape": "AbortDate", - "documentation": "If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.
", + "documentation": "If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
The response also includes the x-amz-abort-rule-id
header that provides the ID of the lifecycle configuration rule that defines this action.
This header is returned along with the x-amz-abort-date header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.
", + "documentation": "This header is returned along with the x-amz-abort-date
header. It identifies the applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.
Name of the bucket to which the multipart upload was initiated.
", + "documentation": "Name of the bucket to which the multipart upload was initiated.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "locationName": "Bucket" }, "Key": { @@ -2461,7 +2461,7 @@ }, "ServerSideEncryption": { "shape": "ServerSideEncryption", - "documentation": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
", + "documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "location": "header", "locationName": "x-amz-server-side-encryption" }, @@ -2473,13 +2473,13 @@ }, "SSECustomerKeyMD5": { "shape": "SSECustomerKeyMD5", - "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
", + "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId": { "shape": "SSEKMSKeyId", - "documentation": "If present, specifies the ID of the AWS Key Management Service (KMS) customer master key (CMK) that was used for the object.
", + "documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used for the object.
", "location": "header", "locationName": "x-amz-server-side-encryption-aws-kms-key-id" }, @@ -2589,7 +2589,7 @@ }, "ServerSideEncryption": { "shape": "ServerSideEncryption", - "documentation": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
", + "documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "location": "header", "locationName": "x-amz-server-side-encryption" }, @@ -2607,25 +2607,25 @@ }, "SSECustomerAlgorithm": { "shape": "SSECustomerAlgorithm", - "documentation": "Specifies the algorithm to use to when encrypting the object (e.g., AES256).
", + "documentation": "Specifies the algorithm to use to when encrypting the object (for example, AES256).
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey": { "shape": "SSECustomerKey", - "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
", + "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm
header.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
", + "documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId": { "shape": "SSEKMSKeyId", - "documentation": "Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
", + "documentation": "Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 Developer Guide.
", "location": "header", "locationName": "x-amz-server-side-encryption-aws-kms-key-id" }, @@ -2642,7 +2642,7 @@ }, "Tagging": { "shape": "TaggingHeader", - "documentation": "The tag-set for the object. The tag-set must be encoded as URL Query parameters
", + "documentation": "The tag-set for the object. The tag-set must be encoded as URL Query parameters.
", "location": "header", "locationName": "x-amz-tagging" }, @@ -2927,7 +2927,7 @@ "documentation": "Indicates whether to replicate delete markers.
In the current implementation, Amazon S3 doesn't replicate the delete markers. The status must be Disabled
.
Specifies whether Amazon S3 replicates the delete markers. If you specify a Filter
, you must specify this element. However, in the latest version of replication configuration (when Filter
is specified), Amazon S3 doesn't replicate delete markers. Therefore, the DeleteMarkerReplication
element can contain only <Status>Disabled</Status>. For an example configuration, see Basic Rule Configuration.
If you don't specify the Filter element, Amazon S3 assumes the replication configuration is the earlier version, V1. In the earlier version, Amazon S3 handled replication of delete markers differently. For more information, see Backward Compatibility.
Specifies whether Amazon S3 replicates the delete markers. If you specify a Filter
, you must specify this element. However, in the latest version of replication configuration (when Filter
is specified), Amazon S3 doesn't replicate delete markers. Therefore, the DeleteMarkerReplication
element can contain only <Status>Disabled</Status>. For an example configuration, see Basic Rule Configuration.
If you don't specify the Filter
element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, Amazon S3 handled replication of delete markers differently. For more information, see Backward Compatibility.
The bucket name of the bucket containing the object.
", + "documentation": "The bucket name of the bucket containing the object.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -2989,7 +2989,7 @@ }, "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. Required to permanently delete a versionedobject if versioning is configured with MFA Deleteenabled.
", + "documentation": "The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.
", "location": "header", "locationName": "x-amz-mfa" }, @@ -3032,7 +3032,7 @@ "members": { "Bucket": { "shape": "BucketName", - "documentation": "The bucket containing the objects from which to remove the tags.
", + "documentation": "The bucket name containing the objects from which to remove the tags.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -3078,7 +3078,7 @@ "members": { "Bucket": { "shape": "BucketName", - "documentation": "The bucket name containing the objects to delete.
", + "documentation": "The bucket name containing the objects to delete.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -3092,7 +3092,7 @@ }, "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. Required to permanently delete a versioned object if versioning is configured with MFA Delete enabled.
", + "documentation": "The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device. Required to permanently delete a versioned object if versioning is configured with MFA delete enabled.
", "location": "header", "locationName": "x-amz-mfa" }, @@ -3171,7 +3171,7 @@ }, "Account": { "shape": "AccountId", - "documentation": "Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS account that owns the destination bucket by specifying the AccessControlTranslation
property, this is the account ID of the destination bucket owner. For more information, see Replication Additional Configuration: Change Replica Owner in the Amazon Simple Storage Service Developer Guide.
Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the AWS account that owns the destination bucket by specifying the AccessControlTranslation
property, this is the account ID of the destination bucket owner. For more information, see Replication Additional Configuration: Changing the Replica Owner in the Amazon Simple Storage Service Developer Guide.
A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics
block.
A container specifying S3 Replication Time Control (S3 RTC), including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a Metrics
block.
A container specifying replication metrics-related information, including whether emitting metrics and Amazon S3 events for replication are enabled. In addition, contains configurations related to specific metrics or events. Must be specified together with a ReplicationTime
block.
A container specifying replication metrics-related settings enabling metrics and Amazon S3 events for S3 Replication Time Control (S3 RTC). Must be specified together with a ReplicationTime
block.
Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket.
" + "documentation": "Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).
" }, "DisplayName": { "type": "string" @@ -3223,15 +3223,15 @@ "members": { "EncryptionType": { "shape": "ServerSideEncryption", - "documentation": "The server-side encryption algorithm used when storing job results in Amazon S3 (e.g., AES256, aws:kms).
" + "documentation": "The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).
" }, "KMSKeyId": { "shape": "SSEKMSKeyId", - "documentation": "If the encryption type is aws:kms, this optional value specifies the AWS KMS key ID to use for encryption of job results.
" + "documentation": "If the encryption type is aws:kms
, this optional value specifies the AWS KMS key ID to use for encryption of job results.
If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.
" + "documentation": "If the encryption type is aws:kms
, this optional value can be used to specify the encryption context for the restore results.
Contains the type of server-side encryption used.
" @@ -3268,7 +3268,7 @@ }, "Code": { "shape": "Code", - "documentation": "The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
Amazon S3 error codes
Code: AccessDenied
Description: Access Denied
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: AccountProblem
Description: There is a problem with your AWS account that prevents the operation from completing successfully. Contact AWS Support for further assistance.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: AllAccessDisabled
Description: All access to this Amazon S3 resource has been disabled. Contact AWS Support for further assistance.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: AmbiguousGrantByEmailAddress
Description: The email address you provided is associated with more than one account.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: AuthorizationHeaderMalformed
Description: The authorization header you provided is invalid.
HTTP Status Code: 400 Bad Request
HTTP Status Code: N/A
Code: BadDigest
Description: The Content-MD5 you specified did not match what we received.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: BucketAlreadyExists
Description: The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: BucketAlreadyOwnedByYou
Description: The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all AWS Regions except in the North Virginia region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).
Code: 409 Conflict (in all regions except the North Virginia region)
SOAP Fault Code Prefix: Client
Code: BucketNotEmpty
Description: The bucket you tried to delete is not empty.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: CredentialsNotSupported
Description: This request does not support credentials.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: CrossLocationLoggingProhibited
Description: Cross-location logging not allowed. Buckets in one geographic location cannot log information to a bucket in another location.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: EntityTooSmall
Description: Your proposed upload is smaller than the minimum allowed object size.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: EntityTooLarge
Description: Your proposed upload exceeds the maximum allowed object size.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: ExpiredToken
Description: The provided token has expired.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: IllegalVersioningConfigurationException
Description: Indicates that the versioning configuration specified in the request is invalid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: IncompleteBody
Description: You did not provide the number of bytes specified by the Content-Length HTTP header
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: IncorrectNumberOfFilesInPostRequest
Description: POST requires exactly one file upload per request.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InlineDataTooLarge
Description: Inline data exceeds the maximum allowed size.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InternalError
Description: We encountered an internal error. Please try again.
HTTP Status Code: 500 Internal Server Error
SOAP Fault Code Prefix: Server
Code: InvalidAccessKeyId
Description: The AWS access key ID you provided does not exist in our records.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: InvalidAddressingHeader
Description: You must specify the Anonymous role.
HTTP Status Code: N/A
SOAP Fault Code Prefix: Client
Code: InvalidArgument
Description: Invalid Argument
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidBucketName
Description: The specified bucket is not valid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidBucketState
Description: The request is not valid with the current state of the bucket.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: InvalidDigest
Description: The Content-MD5 you specified is not valid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidEncryptionAlgorithmError
Description: The encryption request you specified is not valid. The valid value is AES256.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidLocationConstraint
Description: The specified location constraint is not valid. For more information about Regions, see How to Select a Region for Your Buckets.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidObjectState
Description: The operation is not valid for the current state of the object.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: InvalidPart
Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidPartOrder
Description: The list of parts was not in ascending order. Parts list must be specified in order by part number.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidPayer
Description: All access to this object has been disabled. Please contact AWS Support for further assistance.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: InvalidPolicyDocument
Description: The content of the form does not meet the conditions specified in the policy document.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidRange
Description: The requested range cannot be satisfied.
HTTP Status Code: 416 Requested Range Not Satisfiable
SOAP Fault Code Prefix: Client
Code: InvalidRequest
Description: Please use AWS4-HMAC-SHA256.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: SOAP requests must be made over an HTTPS connection.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidRequest
Description: Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS compliant names.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Acceleration is not supported for buckets with periods (.) in their names.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Accelerate endpoint only supports virtual style requests.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Accelerate is not configured on this bucket.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Accelerate is disabled on this bucket.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Acceleration is not supported on this bucket. Contact AWS Support for more information.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Acceleration cannot be enabled on this bucket. Contact AWS Support for more information.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidSecurity
Description: The provided security credentials are not valid.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: InvalidSOAPRequest
Description: The SOAP request body is invalid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidStorageClass
Description: The storage class you specified is not valid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidTargetBucketForLogging
Description: The target bucket for logging does not exist, is not owned by you, or does not have the appropriate grants for the log-delivery group.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidToken
Description: The provided token is malformed or otherwise invalid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidURI
Description: Couldn't parse the specified URI.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: KeyTooLongError
Description: Your key is too long.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MalformedACLError
Description: The XML you provided was not well-formed or did not validate against our published schema.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MalformedPOSTRequest
Description: The body of your POST request is not well-formed multipart/form-data.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MalformedXML
Description: This happens when the user sends malformed XML (XML that doesn't conform to the published XSD) for the configuration. The error message is, \"The XML you provided was not well-formed or did not validate against our published schema.\"
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MaxMessageLengthExceeded
Description: Your request was too big.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MaxPostPreDataLengthExceededError
Description: Your POST request fields preceding the upload file were too large.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MetadataTooLarge
Description: Your metadata headers exceed the maximum allowed metadata size.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MethodNotAllowed
Description: The specified method is not allowed against this resource.
HTTP Status Code: 405 Method Not Allowed
SOAP Fault Code Prefix: Client
Code: MissingAttachment
Description: A SOAP attachment was expected, but none were found.
HTTP Status Code: N/A
SOAP Fault Code Prefix: Client
Code: MissingContentLength
Description: You must provide the Content-Length HTTP header.
HTTP Status Code: 411 Length Required
SOAP Fault Code Prefix: Client
Code: MissingRequestBodyError
Description: This happens when the user sends an empty XML document as a request. The error message is, \"Request body is empty.\"
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MissingSecurityElement
Description: The SOAP 1.1 request is missing a security element.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MissingSecurityHeader
Description: Your request is missing a required header.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: NoLoggingStatusForKey
Description: There is no such thing as a logging status subresource for a key.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: NoSuchBucket
Description: The specified bucket does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchBucketPolicy
Description: The specified bucket does not have a bucket policy.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchKey
Description: The specified key does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchLifecycleConfiguration
Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchUpload
Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchVersion
Description: Indicates that the version ID specified in the request does not match an existing version.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NotImplemented
Description: A header you provided implies functionality that is not implemented.
HTTP Status Code: 501 Not Implemented
SOAP Fault Code Prefix: Server
Code: NotSignedUp
Description: Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: OperationAborted
Description: A conflicting conditional operation is currently in progress against this resource. Try again.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: PermanentRedirect
Description: The bucket you are attempting to access must be addressed using the specified endpoint. Send all future requests to this endpoint.
HTTP Status Code: 301 Moved Permanently
SOAP Fault Code Prefix: Client
Code: PreconditionFailed
Description: At least one of the preconditions you specified did not hold.
HTTP Status Code: 412 Precondition Failed
SOAP Fault Code Prefix: Client
Code: Redirect
Description: Temporary redirect.
HTTP Status Code: 307 Moved Temporarily
SOAP Fault Code Prefix: Client
Code: RestoreAlreadyInProgress
Description: Object restore is already in progress.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: RequestIsNotMultiPartContent
Description: Bucket POST must be of the enclosure-type multipart/form-data.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: RequestTimeout
Description: Your socket connection to the server was not read from or written to within the timeout period.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: RequestTimeTooSkewed
Description: The difference between the request time and the server's time is too large.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: RequestTorrentOfBucketError
Description: Requesting the torrent file of a bucket is not permitted.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: SignatureDoesNotMatch
Description: The request signature we calculated does not match the signature you provided. Check your AWS secret access key and signing method. For more information, see REST Authentication and SOAP Authentication for details.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: ServiceUnavailable
Description: Reduce your request rate.
HTTP Status Code: 503 Service Unavailable
SOAP Fault Code Prefix: Server
Code: SlowDown
Description: Reduce your request rate.
HTTP Status Code: 503 Slow Down
SOAP Fault Code Prefix: Server
Code: TemporaryRedirect
Description: You are being redirected to the bucket while DNS updates.
HTTP Status Code: 307 Moved Temporarily
SOAP Fault Code Prefix: Client
Code: TokenRefreshRequired
Description: The provided token must be refreshed.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: TooManyBuckets
Description: You have attempted to create more buckets than allowed.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: UnexpectedContent
Description: This request does not support content.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: UnresolvableGrantByEmailAddress
Description: The email address you provided does not match any account on record.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: UserKeyMustBeSpecified
Description: The bucket POST must contain the specified field name. If it is specified, check the order of the fields.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
The error code is a string that uniquely identifies an error condition. It is meant to be read and understood by programs that detect and handle errors by type.
Amazon S3 error codes
Code: AccessDenied
Description: Access Denied
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: AccountProblem
Description: There is a problem with your AWS account that prevents the operation from completing successfully. Contact AWS Support for further assistance.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: AllAccessDisabled
Description: All access to this Amazon S3 resource has been disabled. Contact AWS Support for further assistance.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: AmbiguousGrantByEmailAddress
Description: The email address you provided is associated with more than one account.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: AuthorizationHeaderMalformed
Description: The authorization header you provided is invalid.
HTTP Status Code: 400 Bad Request
HTTP Status Code: N/A
Code: BadDigest
Description: The Content-MD5 you specified did not match what we received.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: BucketAlreadyExists
Description: The requested bucket name is not available. The bucket namespace is shared by all users of the system. Please select a different name and try again.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: BucketAlreadyOwnedByYou
Description: The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all AWS Regions except in the North Virginia Region. For legacy compatibility, if you re-create an existing bucket that you already own in the North Virginia Region, Amazon S3 returns 200 OK and resets the bucket access control lists (ACLs).
Code: 409 Conflict (in all Regions except the North Virginia Region)
SOAP Fault Code Prefix: Client
Code: BucketNotEmpty
Description: The bucket you tried to delete is not empty.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: CredentialsNotSupported
Description: This request does not support credentials.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: CrossLocationLoggingProhibited
Description: Cross-location logging not allowed. Buckets in one geographic location cannot log information to a bucket in another location.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: EntityTooSmall
Description: Your proposed upload is smaller than the minimum allowed object size.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: EntityTooLarge
Description: Your proposed upload exceeds the maximum allowed object size.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: ExpiredToken
Description: The provided token has expired.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: IllegalVersioningConfigurationException
Description: Indicates that the versioning configuration specified in the request is invalid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: IncompleteBody
Description: You did not provide the number of bytes specified by the Content-Length HTTP header
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: IncorrectNumberOfFilesInPostRequest
Description: POST requires exactly one file upload per request.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InlineDataTooLarge
Description: Inline data exceeds the maximum allowed size.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InternalError
Description: We encountered an internal error. Please try again.
HTTP Status Code: 500 Internal Server Error
SOAP Fault Code Prefix: Server
Code: InvalidAccessKeyId
Description: The AWS access key ID you provided does not exist in our records.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: InvalidAddressingHeader
Description: You must specify the Anonymous role.
HTTP Status Code: N/A
SOAP Fault Code Prefix: Client
Code: InvalidArgument
Description: Invalid Argument
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidBucketName
Description: The specified bucket is not valid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidBucketState
Description: The request is not valid with the current state of the bucket.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: InvalidDigest
Description: The Content-MD5 you specified is not valid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidEncryptionAlgorithmError
Description: The encryption request you specified is not valid. The valid value is AES256.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidLocationConstraint
Description: The specified location constraint is not valid. For more information about Regions, see How to Select a Region for Your Buckets.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidObjectState
Description: The operation is not valid for the current state of the object.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: InvalidPart
Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidPartOrder
Description: The list of parts was not in ascending order. Parts list must be specified in order by part number.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidPayer
Description: All access to this object has been disabled. Please contact AWS Support for further assistance.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: InvalidPolicyDocument
Description: The content of the form does not meet the conditions specified in the policy document.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidRange
Description: The requested range cannot be satisfied.
HTTP Status Code: 416 Requested Range Not Satisfiable
SOAP Fault Code Prefix: Client
Code: InvalidRequest
Description: Please use AWS4-HMAC-SHA256.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: SOAP requests must be made over an HTTPS connection.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidRequest
Description: Amazon S3 Transfer Acceleration is not supported for buckets with non-DNS compliant names.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Acceleration is not supported for buckets with periods (.) in their names.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Accelerate endpoint only supports virtual style requests.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Accelerate is not configured on this bucket.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Accelerate is disabled on this bucket.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Acceleration is not supported on this bucket. Contact AWS Support for more information.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidRequest
Description: Amazon S3 Transfer Acceleration cannot be enabled on this bucket. Contact AWS Support for more information.
HTTP Status Code: 400 Bad Request
Code: N/A
Code: InvalidSecurity
Description: The provided security credentials are not valid.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: InvalidSOAPRequest
Description: The SOAP request body is invalid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidStorageClass
Description: The storage class you specified is not valid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidTargetBucketForLogging
Description: The target bucket for logging does not exist, is not owned by you, or does not have the appropriate grants for the log-delivery group.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidToken
Description: The provided token is malformed or otherwise invalid.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: InvalidURI
Description: Couldn't parse the specified URI.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: KeyTooLongError
Description: Your key is too long.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MalformedACLError
Description: The XML you provided was not well-formed or did not validate against our published schema.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MalformedPOSTRequest
Description: The body of your POST request is not well-formed multipart/form-data.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MalformedXML
Description: This happens when the user sends malformed XML (XML that doesn't conform to the published XSD) for the configuration. The error message is, \"The XML you provided was not well-formed or did not validate against our published schema.\"
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MaxMessageLengthExceeded
Description: Your request was too big.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MaxPostPreDataLengthExceededError
Description: Your POST request fields preceding the upload file were too large.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MetadataTooLarge
Description: Your metadata headers exceed the maximum allowed metadata size.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MethodNotAllowed
Description: The specified method is not allowed against this resource.
HTTP Status Code: 405 Method Not Allowed
SOAP Fault Code Prefix: Client
Code: MissingAttachment
Description: A SOAP attachment was expected, but none were found.
HTTP Status Code: N/A
SOAP Fault Code Prefix: Client
Code: MissingContentLength
Description: You must provide the Content-Length HTTP header.
HTTP Status Code: 411 Length Required
SOAP Fault Code Prefix: Client
Code: MissingRequestBodyError
Description: This happens when the user sends an empty XML document as a request. The error message is, \"Request body is empty.\"
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MissingSecurityElement
Description: The SOAP 1.1 request is missing a security element.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: MissingSecurityHeader
Description: Your request is missing a required header.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: NoLoggingStatusForKey
Description: There is no such thing as a logging status subresource for a key.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: NoSuchBucket
Description: The specified bucket does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchBucketPolicy
Description: The specified bucket does not have a bucket policy.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchKey
Description: The specified key does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchLifecycleConfiguration
Description: The lifecycle configuration does not exist.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchUpload
Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NoSuchVersion
Description: Indicates that the version ID specified in the request does not match an existing version.
HTTP Status Code: 404 Not Found
SOAP Fault Code Prefix: Client
Code: NotImplemented
Description: A header you provided implies functionality that is not implemented.
HTTP Status Code: 501 Not Implemented
SOAP Fault Code Prefix: Server
Code: NotSignedUp
Description: Your account is not signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at the following URL: https://aws.amazon.com/s3
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: OperationAborted
Description: A conflicting conditional operation is currently in progress against this resource. Try again.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: PermanentRedirect
Description: The bucket you are attempting to access must be addressed using the specified endpoint. Send all future requests to this endpoint.
HTTP Status Code: 301 Moved Permanently
SOAP Fault Code Prefix: Client
Code: PreconditionFailed
Description: At least one of the preconditions you specified did not hold.
HTTP Status Code: 412 Precondition Failed
SOAP Fault Code Prefix: Client
Code: Redirect
Description: Temporary redirect.
HTTP Status Code: 307 Moved Temporarily
SOAP Fault Code Prefix: Client
Code: RestoreAlreadyInProgress
Description: Object restore is already in progress.
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: RequestIsNotMultiPartContent
Description: Bucket POST must be of the enclosure-type multipart/form-data.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: RequestTimeout
Description: Your socket connection to the server was not read from or written to within the timeout period.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: RequestTimeTooSkewed
Description: The difference between the request time and the server's time is too large.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: RequestTorrentOfBucketError
Description: Requesting the torrent file of a bucket is not permitted.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: SignatureDoesNotMatch
Description: The request signature we calculated does not match the signature you provided. Check your AWS secret access key and signing method. For more information, see REST Authentication and SOAP Authentication for details.
HTTP Status Code: 403 Forbidden
SOAP Fault Code Prefix: Client
Code: ServiceUnavailable
Description: Reduce your request rate.
HTTP Status Code: 503 Service Unavailable
SOAP Fault Code Prefix: Server
Code: SlowDown
Description: Reduce your request rate.
HTTP Status Code: 503 Slow Down
SOAP Fault Code Prefix: Server
Code: TemporaryRedirect
Description: You are being redirected to the bucket while DNS updates.
HTTP Status Code: 307 Moved Temporarily
SOAP Fault Code Prefix: Client
Code: TokenRefreshRequired
Description: The provided token must be refreshed.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: TooManyBuckets
Description: You have attempted to create more buckets than allowed.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: UnexpectedContent
Description: This request does not support content.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: UnresolvableGrantByEmailAddress
Description: The email address you provided does not match any account on record.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Code: UserKeyMustBeSpecified
Description: The bucket POST must contain the specified field name. If it is specified, check the order of the fields.
HTTP Status Code: 400 Bad Request
SOAP Fault Code Prefix: Client
Specifies whether existing object replication is enabled.
" + "documentation": "" } }, - "documentation": "A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects.
" + "documentation": "Optional configuration to replicate existing source bucket objects. For more information, see Replicating Existing Objects in the Amazon S3 Developer Guide.
" }, "ExistingObjectReplicationStatus": { "type": "string", @@ -3415,7 +3415,7 @@ "member": { "shape": "FilterRule" }, - "documentation": "A list of containers for the key value pair that defines the criteria for the filter rule.
", + "documentation": "A list of containers for the key-value pair that defines the criteria for the filter rule.
", "flattened": true }, "FilterRuleName": { @@ -3606,7 +3606,7 @@ "members": { "Bucket": { "shape": "BucketName", - "documentation": "The name of the bucket for which to the the lifecycle information.
", + "documentation": "The name of the bucket for which to get the lifecycle information.
", "location": "uri", "locationName": "Bucket" } @@ -3630,7 +3630,7 @@ "members": { "Bucket": { "shape": "BucketName", - "documentation": "The name of the bucket for which to the the lifecycle information.
", + "documentation": "The name of the bucket for which to get the lifecycle information.
", "location": "uri", "locationName": "Bucket" } @@ -3641,7 +3641,7 @@ "members": { "LocationConstraint": { "shape": "BucketLocationConstraint", - "documentation": "Specifies the region where the bucket resides. For a list of all the Amazon S3 supported location constraints by region, see Regions and Endpoints.
" + "documentation": "Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see Regions and Endpoints.
" } } }, @@ -3937,7 +3937,7 @@ "members": { "Bucket": { "shape": "BucketName", - "documentation": "The bucket name of the object for which to get the ACL information.
", + "documentation": "The bucket name that contains the object for which to get the ACL information.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -3979,7 +3979,7 @@ "members": { "Bucket": { "shape": "BucketName", - "documentation": "The bucket containing the object whose Legal Hold status you want to retrieve.
", + "documentation": "The bucket name containing the object whose Legal Hold status you want to retrieve.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -4042,13 +4042,13 @@ }, "AcceptRanges": { "shape": "AcceptRanges", - "documentation": "Indicates that a range of bytes was specifed.
", + "documentation": "Indicates that a range of bytes was specified.
", "location": "header", "locationName": "accept-ranges" }, "Expiration": { "shape": "Expiration", - "documentation": "If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.
", + "documentation": "If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.
", "location": "header", "locationName": "x-amz-expiration" }, @@ -4072,13 +4072,13 @@ }, "ETag": { "shape": "ETag", - "documentation": "An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL
", + "documentation": "An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
", "location": "header", "locationName": "ETag" }, "MissingMeta": { "shape": "MissingMeta", - "documentation": "This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
", + "documentation": "This is set to the number of metadata entries not returned in x-amz-meta
headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
", + "documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "location": "header", "locationName": "x-amz-server-side-encryption" }, @@ -4156,13 +4156,13 @@ }, "SSECustomerKeyMD5": { "shape": "SSECustomerKeyMD5", - "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
", + "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId": { "shape": "SSEKMSKeyId", - "documentation": "If present, specifies the ID of the AWS Key Management Service (KMS) customer master key (CMK) that was used for the object.
", + "documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used for the object.
", "location": "header", "locationName": "x-amz-server-side-encryption-aws-kms-key-id" }, @@ -4225,7 +4225,7 @@ "members": { "Bucket": { "shape": "BucketName", - "documentation": "The bucket name containing the object.
", + "documentation": "The bucket name containing the object.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -4261,43 +4261,43 @@ }, "Range": { "shape": "Range", - "documentation": "Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
", + "documentation": "Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
", "location": "header", "locationName": "Range" }, "ResponseCacheControl": { "shape": "ResponseCacheControl", - "documentation": "Sets the Cache-Control header of the response.
", + "documentation": "Sets the Cache-Control
header of the response.
Sets the Content-Disposition header of the response
", + "documentation": "Sets the Content-Disposition
header of the response
Sets the Content-Encoding header of the response.
", + "documentation": "Sets the Content-Encoding
header of the response.
Sets the Content-Language header of the response.
", + "documentation": "Sets the Content-Language
header of the response.
Sets the Content-Type header of the response.
", + "documentation": "Sets the Content-Type
header of the response.
Sets the Expires header of the response.
", + "documentation": "Sets the Expires
header of the response.
Specifies the algorithm to use to when encrypting the object (e.g., AES256).
", + "documentation": "Specifies the algorithm to use to when encrypting the object (for example, AES256).
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey": { "shape": "SSECustomerKey", - "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
", + "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm
header.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
", + "documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, @@ -4357,7 +4357,7 @@ "members": { "Bucket": { "shape": "BucketName", - "documentation": "The bucket containing the object whose retention settings you want to retrieve.
", + "documentation": "The bucket name containing the object whose retention settings you want to retrieve.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -4407,7 +4407,7 @@ "members": { "Bucket": { "shape": "BucketName", - "documentation": "The bucket name containing the object for which to get the tagging information.
", + "documentation": "The bucket name containing the object for which to get the tagging information.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -4600,13 +4600,13 @@ }, "AcceptRanges": { "shape": "AcceptRanges", - "documentation": "Indicates that a range of bytes was specifed.
", + "documentation": "Indicates that a range of bytes was specified.
", "location": "header", "locationName": "accept-ranges" }, "Expiration": { "shape": "Expiration", - "documentation": "If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key value pairs providing object expiration information. The value of the rule-id is URL encoded.
", + "documentation": "If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.
", "location": "header", "locationName": "x-amz-expiration" }, @@ -4630,13 +4630,13 @@ }, "ETag": { "shape": "ETag", - "documentation": "An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL
", + "documentation": "An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
", "location": "header", "locationName": "ETag" }, "MissingMeta": { "shape": "MissingMeta", - "documentation": "This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
", + "documentation": "This is set to the number of metadata entries not returned in x-amz-meta
headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
If the object is stored using server-side encryption either with an AWS KMS customer master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with the value of the Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
", + "documentation": "If the object is stored using server-side encryption either with an AWS KMS customer master key (CMK) or an Amazon S3-managed encryption key, the response includes this header with the value of the server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "location": "header", "locationName": "x-amz-server-side-encryption" }, @@ -4708,13 +4708,13 @@ }, "SSECustomerKeyMD5": { "shape": "SSECustomerKeyMD5", - "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
", + "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId": { "shape": "SSEKMSKeyId", - "documentation": "If present, specifies the ID of the AWS Key Management Service (KMS) customer master key (CMK) that was used for the object.
", + "documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used for the object.
", "location": "header", "locationName": "x-amz-server-side-encryption-aws-kms-key-id" }, @@ -4731,7 +4731,7 @@ }, "ReplicationStatus": { "shape": "ReplicationStatus", - "documentation": "Amazon S3 can return this header if your request involves a bucket that is either a source or destination in a replication rule.
In replication you have a source bucket on which you configure replication and destination bucket where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:
If requesting object from the source bucket — Amazon S3 will return the x-amz-replication-status header if object in your request is eligible for replication.
For example, suppose in your replication configuration you specify object prefix \"TaxDocs\" requesting Amazon S3 to replicate objects with key prefix \"TaxDocs\". Then any objects you upload with this key name prefix, for example \"TaxDocs/document1.pdf\", is eligible for replication. For any object request with this key name prefix Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.
If requesting object from the destination bucket — Amazon S3 will return the x-amz-replication-status header with value REPLICA if object in your request is a replica that Amazon S3 created.
For more information, see Replication.
", + "documentation": "Amazon S3 can return this header if your request involves a bucket that is either a source or destination in a replication rule.
In replication, you have a source bucket on which you configure replication and destination bucket where Amazon S3 stores object replicas. When you request an object (GetObject
) or object metadata (HeadObject
) from these buckets, Amazon S3 will return the x-amz-replication-status
header in the response as follows:
If requesting an object from the source bucket — Amazon S3 will return the x-amz-replication-status
header if the object in your request is eligible for replication.
For example, suppose that in your replication configuration, you specify object prefix TaxDocs
requesting Amazon S3 to replicate objects with key prefix TaxDocs
. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf
, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status
header with value PENDING, COMPLETED or FAILED indicating object replication status.
If requesting an object from the destination bucket — Amazon S3 will return the x-amz-replication-status
header with value REPLICA if the object in your request is a replica that Amazon S3 created.
For more information, see Replication.
", "location": "header", "locationName": "x-amz-replication-status" }, @@ -4806,7 +4806,7 @@ }, "Range": { "shape": "Range", - "documentation": "Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
", + "documentation": "Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.
", "location": "header", "locationName": "Range" }, @@ -4818,19 +4818,19 @@ }, "SSECustomerAlgorithm": { "shape": "SSECustomerAlgorithm", - "documentation": "Specifies the algorithm to use to when encrypting the object (e.g., AES256).
", + "documentation": "Specifies the algorithm to use to when encrypting the object (for example, AES256).
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey": { "shape": "SSECustomerKey", - "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
", + "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm
header.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
", + "documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, @@ -4879,10 +4879,10 @@ "members": { "Suffix": { "shape": "Suffix", - "documentation": "A suffix that is appended to a request that is for a directory on the website endpoint (e.g. if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.
" + "documentation": "A suffix that is appended to a request that is for a directory on the website endpoint (for example,if the suffix is index.html and you make a request to samplebucket/images/ the data that is returned will be for the object with the key name images/index.html) The suffix must not be empty and must not include a slash character.
" } }, - "documentation": "Container for the Suffix element.
" + "documentation": "Container for the Suffix
element.
Name of the Principal.
" } }, - "documentation": "Container element that identifies who initiated the ultipart upload.
" + "documentation": "Container element that identifies who initiated the multipart upload.
" }, "InputSerialization": { "type": "structure", @@ -4989,12 +4989,12 @@ "members": { "SSES3": { "shape": "SSES3", - "documentation": "Specifies the use of SSE-S3 to encrypt delivered Inventory reports.
", + "documentation": "Specifies the use of SSE-S3 to encrypt delivered inventory reports.
", "locationName": "SSE-S3" }, "SSEKMS": { "shape": "SSEKMS", - "documentation": "Specifies the use of SSE-KMS to encrypt delivered Inventory reports.
", + "documentation": "Specifies the use of SSE-KMS to encrypt delivered inventory reports.
", "locationName": "SSE-KMS" } }, @@ -5074,7 +5074,7 @@ }, "Bucket": { "shape": "BucketName", - "documentation": "The Amazon resource name (ARN) of the bucket where inventory results will be published.
" + "documentation": "The Amazon Resource Name (ARN) of the bucket where inventory results will be published.
" }, "Format": { "shape": "InventoryFormat", @@ -5242,7 +5242,7 @@ }, "Prefix": { "shape": "Prefix", - "documentation": "Prefix identifying one or more objects to which the rule applies. This is No longer used; use Filter instead.
", + "documentation": "Prefix identifying one or more objects to which the rule applies. This is No longer used; use Filter
instead.
Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to the a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the a specifc storage class at a set period in the object's lifetime.
", + "documentation": "Specifies the transition rule for the lifecycle rule that describes when noncurrent objects transition to a specific storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to a specific storage class at a set period in the object's lifetime.
", "locationName": "NoncurrentVersionTransition" }, "NoncurrentVersionExpiration": { @@ -5302,7 +5302,7 @@ "shape": "LifecycleRuleAndOperator" } }, - "documentation": "The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter must have exactly one of Prefix, Tag, or And specified.
" + "documentation": "The Filter
is used to identify objects that a Lifecycle Rule applies to. A Filter
must have exactly one of Prefix
, Tag
, or And
specified.
NextContinuationToken is sent when isTruncated is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken. The token is obfuscated and is not a usable value.
" + "documentation": " NextContinuationToken
is sent when isTruncated
is true, which indicates that there are more analytics configurations to list. The next request must include this NextContinuationToken
. The token is obfuscated and is not a usable value.
The marker used to continue this inventory configuration listing. Use the NextContinuationToken from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.
" + "documentation": "The marker used to continue this inventory configuration listing. Use the NextContinuationToken
from this response to continue the listing in a subsequent request. The continuation token is an opaque value that Amazon S3 understands.
The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.
" + "documentation": "The marker used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken
from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.
When a list is truncated, this element specifies the value that should be used for the upload-id-marker request parameter in a subsequent request.
" + "documentation": "When a list is truncated, this element specifies the value that should be used for the upload-id-marker
request parameter in a subsequent request.
Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.
", + "documentation": "Container for elements related to a particular multipart upload. A response can contain zero or more Upload
elements.
If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes element. The distinct key prefixes are returned in the Prefix child element.
" + "documentation": "If you specify a delimiter in the request, then the result returns each distinct key prefix containing the delimiter in a CommonPrefixes
element. The distinct key prefixes are returned in the Prefix
child element.
Name of the bucket to which the multipart upload was initiated.
", + "documentation": "Name of the bucket to which the multipart upload was initiated.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -5547,7 +5547,7 @@ }, "UploadIdMarker": { "shape": "UploadIdMarker", - "documentation": "Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker.
", + "documentation": "Together with key-marker, specifies the multipart upload after which listing should begin. If key-marker is not specified, the upload-id-marker parameter is ignored. Otherwise, any multipart uploads for a key equal to the key-marker might be included in the list only if they have an upload ID lexicographically greater than the specified upload-id-marker
.
A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.
" + "documentation": "A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria. If your results were truncated, you can make a follow-up paginated request using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.
" }, "KeyMarker": { "shape": "KeyMarker", - "documentation": "Marks the last Key returned in a truncated response.
" + "documentation": "Marks the last key returned in a truncated response.
" }, "VersionIdMarker": { "shape": "VersionIdMarker", - "documentation": "Marks the last version of the Key returned in a truncated response.
" + "documentation": "Marks the last version of the key returned in a truncated response.
" }, "NextKeyMarker": { "shape": "NextKeyMarker", - "documentation": "When the number of responses exceeds the value of MaxKeys, NextKeyMarker specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.
" + "documentation": "When the number of responses exceeds the value of MaxKeys
, NextKeyMarker
specifies the first key not returned that satisfies the search criteria. Use this value for the key-marker request parameter in a subsequent request.
When the number of responses exceeds the value of MaxKeys, NextVersionIdMarker specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.
" + "documentation": "When the number of responses exceeds the value of MaxKeys
, NextVersionIdMarker
specifies the first object version not returned that satisfies the search criteria. Use this value for the version-id-marker request parameter in a subsequent request.
Bucket owner's name.
" + "documentation": "Bucket name.
" }, "Prefix": { "shape": "Prefix", @@ -5596,7 +5596,7 @@ }, "Delimiter": { "shape": "Delimiter", - "documentation": "The delimeter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.
" + "documentation": "The delimiter grouping the included keys. A delimiter is a character that you specify to group keys. All keys that contain the same string between the prefix and the first occurrence of the delimiter are grouped under a single result element in CommonPrefixes
. These groups are counted as one result against the max-keys limitation. These keys are not returned elsewhere in the response.
The name of the bucket that contains the objects.
", + "documentation": "The bucket name that contains the objects.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -5666,7 +5666,7 @@ "members": { "IsTruncated": { "shape": "IsTruncated", - "documentation": "A flag that indicates whether or not Amazon S3 returned all of the results that satisfied the search criteria.
" + "documentation": "A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.
" }, "Marker": { "shape": "Marker", @@ -5682,7 +5682,7 @@ }, "Name": { "shape": "BucketName", - "documentation": "Name of the bucket.
" + "documentation": "Bucket name.
" }, "Prefix": { "shape": "Prefix", @@ -5690,7 +5690,7 @@ }, "Delimiter": { "shape": "Delimiter", - "documentation": "Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.
" + "documentation": "Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes
collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys
value.
Name of the bucket.
" + "documentation": "Bucket name.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
" }, "Prefix": { "shape": "Prefix", @@ -5776,7 +5776,7 @@ }, "Delimiter": { "shape": "Delimiter", - "documentation": "Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.
" + "documentation": "Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys
value.
NextContinuationToken is sent when isTruncated is true which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key
" + "documentation": " NextContinuationToken
is sent when isTruncated
is true, which means there are more keys in the bucket that can be listed. The next list requests to Amazon S3 can be continued with this NextContinuationToken
. NextContinuationToken
is obfuscated and is not a real key
Name of the bucket to list.
", + "documentation": "Bucket name to list.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -5852,7 +5852,7 @@ }, "FetchOwner": { "shape": "FetchOwner", - "documentation": "The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true
", + "documentation": "The owner field is not present in listV2 by default, if you want to return owner field with each key in the result then set the fetch owner field to true.
", "location": "querystring", "locationName": "fetch-owner" }, @@ -5875,13 +5875,13 @@ "members": { "AbortDate": { "shape": "AbortDate", - "documentation": "If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
The response will also include the x-amz-abort-rule-id header that will provide the ID of the lifecycle configuration rule that defines this action.
", + "documentation": "If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, then the response includes this header indicating when the initiated multipart upload will become eligible for abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
The response will also include the x-amz-abort-rule-id
header that will provide the ID of the lifecycle configuration rule that defines this action.
This header is returned along with the x-amz-abort-date header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.
", + "documentation": "This header is returned along with the x-amz-abort-date
header. It identifies applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.
Container for elements related to a particular part. A response can contain zero or more Part elements.
", + "documentation": " Container for elements related to a particular part. A response can contain zero or more Part
elements.
Container element that identifies who initiated the multipart upload. If the initiator is an AWS account, this element provides the same information as the Owner element. If the initiator is an IAM User, then this element provides the user ARN and display name.
" + "documentation": "Container element that identifies who initiated the multipart upload. If the initiator is an AWS account, this element provides the same information as the Owner
element. If the initiator is an IAM User, this element provides the user ARN and display name.
Name of the bucket to which the parts are being uploaded.->
", + "documentation": "Name of the bucket to which the parts are being uploaded.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -5997,7 +5997,7 @@ "members": { "TargetBucket": { "shape": "TargetBucket", - "documentation": "Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case you should choose a different TargetPrefix for each source bucket so that the delivered log files can be distinguished by key.
" + "documentation": "Specifies the bucket where you want Amazon S3 to store server access logs. You can have your logs delivered to any bucket that you own, including the same bucket that is being logged. You can also configure multiple buckets to deliver their logs to the same target bucket. In this case, you should choose a different TargetPrefix
for each source bucket so that the delivered log files can be distinguished by key.
A container specifying the time threshold for emitting the s3:Replication:OperationMissedThreshold
event.
A container specifying replication metrics-related information, including whether emitting metrics and Amazon S3 events for replication are enabled. In addition, contains configurations related to specific metrics or events. Must be specified together with a ReplicationTime
block.
A container specifying replication metrics-related settings enabling metrics and Amazon S3 events for S3 Replication Time Control (S3 RTC). Must be specified together with a ReplicationTime
block.
Identifies who initiated the multipart upload.
" } }, - "documentation": "Container for the MultipartUpload for the Amazon S3 object.
" + "documentation": "Container for the MultipartUpload
for the Amazon S3 object.
Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
" + "documentation": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
" } }, "documentation": "Specifies when noncurrent object versions expire. Upon expiration, Amazon S3 permanently deletes the noncurrent object versions. You set this lifecycle configuration action on a bucket that has versioning enabled (or suspended) to request that Amazon S3 delete noncurrent object versions at a specific period in the object's lifetime.
" @@ -6246,7 +6246,7 @@ "members": { "NoncurrentDays": { "shape": "Days", - "documentation": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon Simple Storage Service Developer Guide.
" + "documentation": "Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. For information about the noncurrent days calculations, see How Amazon S3 Calculates How Long an Object Has Been Noncurrent in the Amazon Simple Storage Service Developer Guide.
" }, "StorageClass": { "shape": "TransitionStorageClass", @@ -6288,7 +6288,7 @@ "members": { "TopicConfiguration": { "shape": "TopicConfigurationDeprecated", - "documentation": "This data type is deperecated. A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.
" + "documentation": "This data type is deprecated. A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events.
" }, "QueueConfiguration": { "shape": "QueueConfigurationDeprecated", @@ -6493,7 +6493,7 @@ "members": { "ETag": { "shape": "ETag", - "documentation": "The entity tag is an MD5 hash of that version of the object
" + "documentation": "The entity tag is an MD5 hash of that version of the object.
" }, "Size": { "shape": "Size", @@ -6521,7 +6521,7 @@ }, "Owner": { "shape": "Owner", - "documentation": "Specifies the Owner of the object.
" + "documentation": "Specifies the owner of the object.
" } }, "documentation": "The version of an object.
" @@ -6571,14 +6571,14 @@ "members": { "DisplayName": { "shape": "DisplayName", - "documentation": "Container for the display name of the owner
" + "documentation": "Container for the display name of the owner.
" }, "ID": { "shape": "ID", - "documentation": "Container for the ID of the owner
" + "documentation": "Container for the ID of the owner.
" } }, - "documentation": "Container for the owner's display name and ID
" + "documentation": "Container for the owner's display name and ID.
" }, "OwnerOverride": { "type": "string", @@ -6727,7 +6727,7 @@ "locationName": "RestrictPublicBuckets" } }, - "documentation": "The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer Guide.
" + "documentation": "The PublicAccessBlock configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer Guide.
" }, "PutBucketAccelerateConfigurationRequest": { "type": "structure", @@ -6864,7 +6864,7 @@ }, "CORSConfiguration": { "shape": "CORSConfiguration", - "documentation": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
", + "documentation": "Describes the cross-origin access configuration for objects in an Amazon S3 bucket. For more information, see Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
", "locationName": "CORSConfiguration", "xmlNamespace": { "uri": "http://s3.amazonaws.com/doc/2006-03-01/" @@ -7223,7 +7223,7 @@ }, "Tagging": { "shape": "Tagging", - "documentation": "Container for the TagSet and Tag elements.
", + "documentation": "Container for the TagSet
and Tag
elements.
The canned ACL to apply to the object. For more information, see Canned ACL
", + "documentation": "The canned ACL to apply to the object. For more information, see Canned ACL.
", "location": "header", "locationName": "x-amz-acl" }, @@ -7331,7 +7331,7 @@ }, "Bucket": { "shape": "BucketName", - "documentation": "The name of the bucket to which the ACL is being added.
", + "documentation": "The bucket name that contains the object to which you want to attach the ACL.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -7410,7 +7410,7 @@ "members": { "Bucket": { "shape": "BucketName", - "documentation": "The bucket containing the object that you want to place a Legal Hold on.
", + "documentation": "The bucket name containing the object that you want to place a Legal Hold on.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -7533,13 +7533,13 @@ }, "SSECustomerKeyMD5": { "shape": "SSECustomerKeyMD5", - "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
", + "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId": { "shape": "SSEKMSKeyId", - "documentation": "If the x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (KMS) customer master key (CMK) that was used for the object.
", + "documentation": "If x-amz-server-side-encryption
is present and has the value of aws:kms
, this header specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used for the object.
Name of the bucket to which the PUT operation was initiated.
", + "documentation": "Bucket name to which the PUT operation was initiated.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -7666,7 +7666,7 @@ }, "ServerSideEncryption": { "shape": "ServerSideEncryption", - "documentation": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
", + "documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "location": "header", "locationName": "x-amz-server-side-encryption" }, @@ -7678,31 +7678,31 @@ }, "WebsiteRedirectLocation": { "shape": "WebsiteRedirectLocation", - "documentation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see .
In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
x-amz-website-redirect-location: /anotherPage.html
In the following example, the request header sets the object redirect to another website:
x-amz-website-redirect-location: http://www.example.com/
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.
", + "documentation": "If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about object metadata, see Object Key and Metadata.
In the following example, the request header sets the redirect to an object (anotherPage.html) in the same bucket:
x-amz-website-redirect-location: /anotherPage.html
In the following example, the request header sets the object redirect to another website:
x-amz-website-redirect-location: http://www.example.com/
For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and How to Configure Website Page Redirects.
", "location": "header", "locationName": "x-amz-website-redirect-location" }, "SSECustomerAlgorithm": { "shape": "SSECustomerAlgorithm", - "documentation": "Specifies the algorithm to use to when encrypting the object (e.g., AES256).
", + "documentation": "Specifies the algorithm to use to when encrypting the object (for example, AES256).
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey": { "shape": "SSECustomerKey", - "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header.
", + "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm
header.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
", + "documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId": { "shape": "SSEKMSKeyId", - "documentation": "If the x-amz-server-side-encryption is present and has the value of aws:kms, this header specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used for the object.
If the value of x-amz-server-side-encryption is aws:kms, this header specifies the ID of the AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the AWS managed CMK in AWS to protect the data.
", + "documentation": "If x-amz-server-side-encryption
is present and has the value of aws:kms
, this header specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used for the object.
If the value of x-amz-server-side-encryption
is aws:kms
, this header specifies the ID of the AWS KMS CMK that will be used for the object. If you specify x-amz-server-side-encryption:aws:kms
, but do not provide x-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the AWS managed CMK in AWS to protect the data.
The bucket that contains the object you want to apply this Object Retention configuration to.
", + "documentation": "The bucket name that contains the object you want to apply this Object Retention configuration to.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -7828,7 +7828,7 @@ "members": { "Bucket": { "shape": "BucketName", - "documentation": "The bucket containing the object.
", + "documentation": "The bucket name containing the object.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -7852,7 +7852,7 @@ }, "Tagging": { "shape": "Tagging", - "documentation": "Container for the TagSet and Tag elements
", + "documentation": "Container for the TagSet
and Tag
elements
A collection of bucket events for which to send notiications
", + "documentation": "A collection of bucket events for which to send notifications
", "locationName": "Event" }, "Filter": { @@ -7932,7 +7932,7 @@ }, "Events": { "shape": "EventList", - "documentation": "A collection of bucket events for which to send notiications
", + "documentation": "A collection of bucket events for which to send notifications
", "locationName": "Event" }, "Queue": { @@ -7940,7 +7940,7 @@ "documentation": "The Amazon Resource Name (ARN) of the Amazon SQS queue to which Amazon S3 publishes a message when it detects events of the specified type.
" } }, - "documentation": "This data type is deprecated. Please use QueueConfiguration for the same purposes. This dat type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
" + "documentation": "This data type is deprecated. Use QueueConfiguration for the same purposes. This data type specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.
" }, "QueueConfigurationList": { "type": "list", @@ -8067,11 +8067,11 @@ }, "Priority": { "shape": "Priority", - "documentation": "The priority associated with the rule. If you specify multiple rules in a replication configuration, Amazon S3 prioritizes the rules to prevent conflicts when filtering. If two or more rules identify the same object based on a specified filter, the rule with higher priority takes precedence. For example:
Same object quality prefix based filter criteria If prefixes you specified in multiple rules overlap
Same object qualify tag based filter criteria specified in multiple rules
For more information, see Replication in the Amazon S3 Developer Guide.
" + "documentation": "The priority associated with the rule. If you specify multiple rules in a replication configuration, Amazon S3 prioritizes the rules to prevent conflicts when filtering. If two or more rules identify the same object based on a specified filter, the rule with higher priority takes precedence. For example:
Same object quality prefix-based filter criteria if prefixes you specified in multiple rules overlap
Same object qualify tag-based filter criteria specified in multiple rules
For more information, see Replication in the Amazon Simple Storage Service Developer Guide.
" }, "Prefix": { "shape": "Prefix", - "documentation": "An object keyname prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string.
", + "documentation": "An object key name prefix that identifies the object or objects to which the rule applies. The maximum prefix length is 1,024 characters. To include all objects in a bucket, specify an empty string.
", "deprecated": true }, "Filter": { @@ -8087,11 +8087,11 @@ }, "ExistingObjectReplication": { "shape": "ExistingObjectReplication", - "documentation": "A container that specifies information about existing object replication. You can choose whether to enable or disable the replication of existing objects.
" + "documentation": "" }, "Destination": { "shape": "Destination", - "documentation": "A container for information about the replication destination.
" + "documentation": "A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).
" }, "DeleteMarkerReplication": { "shape": "DeleteMarkerReplication" @@ -8104,7 +8104,7 @@ "members": { "Prefix": { "shape": "Prefix", - "documentation": "An object keyname prefix that identifies the subset of objects to which the rule applies.
" + "documentation": "An object key name prefix that identifies the subset of objects to which the rule applies.
" }, "Tags": { "shape": "TagSet", @@ -8113,14 +8113,14 @@ "locationName": "Tag" } }, - "documentation": "A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter.
For example:
If you specify both a Prefix and a Tag filter, wrap these filters in an And tag.
If you specify a filter based on multiple tags, wrap the Tag elements in an And tag
A container for specifying rule filters. The filters determine the subset of objects to which the rule applies. This element is required only if you specify more than one filter.
For example:
If you specify both a Prefix
and a Tag
filter, wrap these filters in an And
tag.
If you specify a filter based on multiple tags, wrap the Tag
elements in an And
tag
An object keyname prefix that identifies the subset of objects to which the rule applies.
" + "documentation": "An object key name prefix that identifies the subset of objects to which the rule applies.
" }, "Tag": { "shape": "Tag", @@ -8169,10 +8169,10 @@ }, "Time": { "shape": "ReplicationTimeValue", - "documentation": "A container specifying the time by which replication should complete for all objects and operations on objects.
" + "documentation": "A container specifying the time by which replication should be complete for all objects and operations on objects.
" } }, - "documentation": " A container specifying the time when all objects and operations on objects are replicated. Must be specified together with a Metrics
block.
A container specifying S3 Replication Time Control (S3 RTC) related information, including whether S3 RTC is enabled and the time when all objects and operations on objects must be replicated. Must be specified together with a Metrics
block.
Contains an integer specifying time in minutes.
" + "documentation": "Contains an integer specifying time in minutes.
Valid values: 15 minutes.
" } }, - "documentation": "A container specifying the time value.
" + "documentation": " A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics EventThreshold
.
Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. Documentation on downloading objects from requester pays buckets can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectsinRequesterPaysBuckets.html
", + "documentation": "Confirms that the requester knows that she or he will be charged for the request. Bucket owners need not specify this parameter in their requests. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requestor Pays Buckets in the Amazon S3 Developer Guide.
", "enum": [ "requester" ] @@ -8226,7 +8226,7 @@ "documentation": "Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE.
" } }, - "documentation": "Container for specifiying if periodic QueryProgress messages should be sent.
" + "documentation": "Container for specifying if periodic QueryProgress
messages should be sent.
The bucket name.
", + "documentation": "The bucket name or containing the object to restore.
When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.
", "location": "uri", "locationName": "Bucket" }, @@ -8313,11 +8313,11 @@ "members": { "Days": { "shape": "Days", - "documentation": "Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.
" + "documentation": "Lifetime of the active copy in days. Do not use with restores that specify OutputLocation
.
Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.
" + "documentation": "Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation
.
The class of storage used to store the restore results.
" } }, - "documentation": "Describes an S3 location that will receive the results of the restore request.
" + "documentation": "Describes an Amazon S3 location that will receive the results of the restore request.
" }, "SSECustomerAlgorithm": { "type": "string" @@ -8490,10 +8490,10 @@ "members": { "KeyId": { "shape": "SSEKMSKeyId", - "documentation": "Specifies the ID of the AWS Key Management Service (KMS) customer master key (CMK) to use for encrypting Inventory reports.
" + "documentation": "Specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) to use for encrypting inventory reports.
" } }, - "documentation": "Specifies the use of SSE-KMS to encrypt delivered Inventory reports.
", + "documentation": "Specifies the use of SSE-KMS to encrypt delivered inventory reports.
", "locationName": "SSE-KMS" }, "SSEKMSEncryptionContext": { @@ -8507,7 +8507,7 @@ "SSES3": { "type": "structure", "members": {}, - "documentation": "Specifies the use of SSE-S3 to encrypt delivered Inventory reports.
", + "documentation": "Specifies the use of SSE-S3 to encrypt delivered inventory reports.
", "locationName": "SSE-S3" }, "ScanRange": { @@ -8519,9 +8519,10 @@ }, "End": { "shape": "End", - "documentation": "Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. If only the End parameter is supplied, it is interpreted to mean scan the last N bytes of the file. For example; <scanrange><end>50</end></scanrange>
means scan the last 50 bytes.
Specifies the end of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is one less than the size of the object being queried. If only the End parameter is supplied, it is interpreted to mean scan the last N bytes of the file. For example, <scanrange><end>50</end></scanrange>
means scan the last 50 bytes.
Specifies the byte range of the object to get the records from. A record is processed when its first byte is contained by the range. This parameter is optional, but when specified, it must not be empty. See RFC 2616, Section 14.35.1 about how to specify the start and end of the range.
" }, "SelectObjectContentEventStream": { "type": "structure", @@ -8547,7 +8548,7 @@ "documentation": "The End Event.
" } }, - "documentation": "The continer for selecting objects from a content event stream.
", + "documentation": "The container for selecting objects from a content event stream.
", "eventstream": true }, "SelectObjectContentOutput": { @@ -8585,19 +8586,19 @@ }, "SSECustomerAlgorithm": { "shape": "SSECustomerAlgorithm", - "documentation": "The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.
", + "documentation": "The SSE Algorithm used to encrypt the object. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey": { "shape": "SSECustomerKey", - "documentation": "The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.
", + "documentation": "The SSE Customer Key. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key" }, "SSECustomerKeyMD5": { "shape": "SSECustomerKeyMD5", - "documentation": "The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.
", + "documentation": "The SSE Customer Key MD5. For more information, see Server-Side Encryption (Using Customer-Provided Encryption Keys.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, @@ -8607,7 +8608,7 @@ }, "ExpressionType": { "shape": "ExpressionType", - "documentation": "The type of the provided expression (for example., SQL).
" + "documentation": "The type of the provided expression (for example, SQL).
" }, "RequestProgress": { "shape": "RequestProgress", @@ -8643,7 +8644,7 @@ }, "ExpressionType": { "shape": "ExpressionType", - "documentation": "The type of the provided expression (e.g., SQL).
" + "documentation": "The type of the provided expression (for example, SQL).
" }, "Expression": { "shape": "Expression", @@ -8868,10 +8869,10 @@ "members": { "TagSet": { "shape": "TagSet", - "documentation": "A collection for a a set of tags
" + "documentation": "A collection for a set of tags
" } }, - "documentation": "Container for TagSet elements.
" + "documentation": "Container for TagSet
elements.
Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.
" } }, - "documentation": "A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events. This data type is deperecated. Please use TopicConfiguration instead.
" + "documentation": "A container for specifying the configuration for publication of messages to an Amazon Simple Notification Service (Amazon SNS) topic when Amazon S3 detects specified events. This data type is deprecated. Use TopicConfiguration instead.
" }, "TopicConfigurationList": { "type": "list", @@ -9044,7 +9045,7 @@ }, "ServerSideEncryption": { "shape": "ServerSideEncryption", - "documentation": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
", + "documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "location": "header", "locationName": "x-amz-server-side-encryption" }, @@ -9056,13 +9057,13 @@ }, "SSECustomerKeyMD5": { "shape": "SSECustomerKeyMD5", - "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
", + "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId": { "shape": "SSEKMSKeyId", - "documentation": "If present, specifies the ID of the AWS Key Management Service (KMS) customer master key (CMK) that was used for the object.
", + "documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used for the object.
", "location": "header", "locationName": "x-amz-server-side-encryption-aws-kms-key-id" }, @@ -9122,7 +9123,7 @@ }, "CopySourceRange": { "shape": "CopySourceRange", - "documentation": "The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first ten bytes of the source. You can copy a range only if the source object is greater than 5 MB.
", + "documentation": "The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.
", "location": "header", "locationName": "x-amz-copy-source-range" }, @@ -9146,25 +9147,25 @@ }, "SSECustomerAlgorithm": { "shape": "SSECustomerAlgorithm", - "documentation": "Specifies the algorithm to use to when encrypting the object (e.g., AES256).
", + "documentation": "Specifies the algorithm to use to when encrypting the object (for example, AES256).
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey": { "shape": "SSECustomerKey", - "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.
", + "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm
header. This must be the same encryption key specified in the initiate multipart upload request.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
", + "documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, "CopySourceSSECustomerAlgorithm": { "shape": "CopySourceSSECustomerAlgorithm", - "documentation": "Specifies the algorithm to use when decrypting the source object (e.g., AES256).
", + "documentation": "Specifies the algorithm to use when decrypting the source object (for example, AES256).
", "location": "header", "locationName": "x-amz-copy-source-server-side-encryption-customer-algorithm" }, @@ -9176,7 +9177,7 @@ }, "CopySourceSSECustomerKeyMD5": { "shape": "CopySourceSSECustomerKeyMD5", - "documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
", + "documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
", "location": "header", "locationName": "x-amz-copy-source-server-side-encryption-customer-key-MD5" }, @@ -9192,7 +9193,7 @@ "members": { "ServerSideEncryption": { "shape": "ServerSideEncryption", - "documentation": "The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
", + "documentation": "The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
", "location": "header", "locationName": "x-amz-server-side-encryption" }, @@ -9210,13 +9211,13 @@ }, "SSECustomerKeyMD5": { "shape": "SSECustomerKeyMD5", - "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round trip message integrity verification of the customer-provided encryption key.
", + "documentation": "If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, "SSEKMSKeyId": { "shape": "SSEKMSKeyId", - "documentation": "If present, specifies the ID of the AWS Key Management Service (KMS) customer master key (CMK) was used for the object.
", + "documentation": "If present, specifies the ID of the AWS Key Management Service (AWS KMS) customer master key (CMK) was used for the object.
", "location": "header", "locationName": "x-amz-server-side-encryption-aws-kms-key-id" }, @@ -9255,7 +9256,7 @@ }, "ContentMD5": { "shape": "ContentMD5", - "documentation": "The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameted is required if object lock parameters are specified.
", + "documentation": "The base64-encoded 128-bit MD5 digest of the part data. This parameter is auto-populated when using the command from the CLI. This parameter is required if object lock parameters are specified.
", "location": "header", "locationName": "Content-MD5" }, @@ -9279,19 +9280,19 @@ }, "SSECustomerAlgorithm": { "shape": "SSECustomerAlgorithm", - "documentation": "Specifies the algorithm to use to when encrypting the object (e.g., AES256).
", + "documentation": "Specifies the algorithm to use to when encrypting the object (for example, AES256).
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-algorithm" }, "SSECustomerKey": { "shape": "SSECustomerKey", - "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.
", + "documentation": "Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side​-encryption​-customer-algorithm header
. This must be the same encryption key specified in the initiate multipart upload request.
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure the encryption key was transmitted without error.
", + "documentation": "Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
", "location": "header", "locationName": "x-amz-server-side-encryption-customer-key-MD5" }, diff --git a/apis/s3control-2018-08-20.min.json b/apis/s3control-2018-08-20.min.json index 104ed12004..7a5415e6ff 100644 --- a/apis/s3control-2018-08-20.min.json +++ b/apis/s3control-2018-08-20.min.json @@ -11,6 +11,41 @@ "uid": "s3control-2018-08-20" }, "operations": { + "CreateAccessPoint": { + "http": { + "method": "PUT", + "requestUri": "/v20180820/accesspoint/{name}" + }, + "input": { + "locationName": "CreateAccessPointRequest", + "xmlNamespace": { + "uri": "http://awss3control.amazonaws.com/doc/2018-08-20/" + }, + "type": "structure", + "required": [ + "AccountId", + "Name", + "Bucket" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "location": "uri", + "locationName": "name" + }, + "Bucket": {}, + "VpcConfiguration": { + "shape": "S5" + }, + "PublicAccessBlockConfiguration": { + "shape": "S7" + } + } + } + }, "CreateJob": { "http": { "requestUri": "/v20180820/jobs" @@ -39,16 +74,16 @@ "type": "boolean" }, "Operation": { - "shape": "S4" + "shape": "Sb" }, "Report": { - "shape": "S12" + "shape": "S19" }, "ClientRequestToken": { "idempotencyToken": true }, "Manifest": { - "shape": "S17" + "shape": "S1e" }, "Description": {}, "Priority": { @@ -64,6 +99,52 @@ } } }, + "DeleteAccessPoint": { + "http": { + "method": "DELETE", + "requestUri": "/v20180820/accesspoint/{name}" + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "Name" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "location": "uri", + "locationName": "name" + } + } + } + }, + "DeleteAccessPointPolicy": { + "http": { + "method": "DELETE", + "requestUri": "/v20180820/accesspoint/{name}/policy" + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "Name" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "location": "uri", + "locationName": "name" + } + } + } + }, "DeletePublicAccessBlock": { "http": { "method": "DELETE", @@ -118,16 +199,16 @@ "JobArn": {}, "Status": {}, "Manifest": { - "shape": "S17" + "shape": "S1e" }, "Operation": { - "shape": "S4" + "shape": "Sb" }, "Priority": { "type": "integer" }, "ProgressSummary": { - "shape": "S1q" + "shape": "S1z" }, "StatusUpdateReason": {}, "FailureReasons": { @@ -141,7 +222,7 @@ } }, "Report": { - "shape": "S12" + "shape": "S19" }, "CreationTime": { "type": "timestamp" @@ -159,6 +240,112 @@ } } }, + "GetAccessPoint": { + "http": { + "method": "GET", + "requestUri": "/v20180820/accesspoint/{name}" + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "Name" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "location": "uri", + "locationName": "name" + } + } + }, + "output": { + "type": "structure", + "members": { + "Name": {}, + "Bucket": {}, + "NetworkOrigin": {}, + "VpcConfiguration": { + "shape": "S5" + }, + "PublicAccessBlockConfiguration": { + "shape": "S7" + }, + "CreationDate": { + "type": "timestamp" + } + } + } + }, + "GetAccessPointPolicy": { + "http": { + "method": "GET", + "requestUri": "/v20180820/accesspoint/{name}/policy" + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "Name" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "location": "uri", + "locationName": "name" + } + } + }, + "output": { + "type": "structure", + "members": { + "Policy": {} + } + } + }, + "GetAccessPointPolicyStatus": { + "http": { + "method": "GET", + "requestUri": "/v20180820/accesspoint/{name}/policyStatus" + }, + "input": { + "type": "structure", + "required": [ + "AccountId", + "Name" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "location": "uri", + "locationName": "name" + } + } + }, + "output": { + "type": "structure", + "members": { + "PolicyStatus": { + "type": "structure", + "members": { + "IsPublic": { + "locationName": "IsPublic", + "type": "boolean" + } + } + } + } + } + }, "GetPublicAccessBlock": { "http": { "method": "GET", @@ -180,12 +367,69 @@ "type": "structure", "members": { "PublicAccessBlockConfiguration": { - "shape": "S25" + "shape": "S7" } }, "payload": "PublicAccessBlockConfiguration" } }, + "ListAccessPoints": { + "http": { + "method": "GET", + "requestUri": "/v20180820/accesspoint" + }, + "input": { + "type": "structure", + "required": [ + "AccountId" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + }, + "Bucket": { + "location": "querystring", + "locationName": "bucket" + }, + "NextToken": { + "location": "querystring", + "locationName": "nextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "maxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "members": { + "AccessPointList": { + "type": "list", + "member": { + "locationName": "AccessPoint", + "type": "structure", + "required": [ + "Name", + "NetworkOrigin", + "Bucket" + ], + "members": { + "Name": {}, + "NetworkOrigin": {}, + "VpcConfiguration": { + "shape": "S5" + }, + "Bucket": {} + } + } + }, + "NextToken": {} + } + } + }, "ListJobs": { "http": { "method": "GET", @@ -241,7 +485,7 @@ "type": "timestamp" }, "ProgressSummary": { - "shape": "S1q" + "shape": "S1z" } } } @@ -249,6 +493,35 @@ } } }, + "PutAccessPointPolicy": { + "http": { + "method": "PUT", + "requestUri": "/v20180820/accesspoint/{name}/policy" + }, + "input": { + "locationName": "PutAccessPointPolicyRequest", + "xmlNamespace": { + "uri": "http://awss3control.amazonaws.com/doc/2018-08-20/" + }, + "type": "structure", + "required": [ + "AccountId", + "Name", + "Policy" + ], + "members": { + "AccountId": { + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "location": "uri", + "locationName": "name" + }, + "Policy": {} + } + } + }, "PutPublicAccessBlock": { "http": { "method": "PUT", @@ -262,7 +535,7 @@ ], "members": { "PublicAccessBlockConfiguration": { - "shape": "S25", + "shape": "S7", "locationName": "PublicAccessBlockConfiguration", "xmlNamespace": { "uri": "http://awss3control.amazonaws.com/doc/2018-08-20/" @@ -358,7 +631,37 @@ } }, "shapes": { - "S4": { + "S5": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "VpcId": {} + } + }, + "S7": { + "type": "structure", + "members": { + "BlockPublicAcls": { + "locationName": "BlockPublicAcls", + "type": "boolean" + }, + "IgnorePublicAcls": { + "locationName": "IgnorePublicAcls", + "type": "boolean" + }, + "BlockPublicPolicy": { + "locationName": "BlockPublicPolicy", + "type": "boolean" + }, + "RestrictPublicBuckets": { + "locationName": "RestrictPublicBuckets", + "type": "boolean" + } + } + }, + "Sb": { "type": "structure", "members": { "LambdaInvoke": { @@ -373,7 +676,7 @@ "TargetResource": {}, "CannedAccessControlList": {}, "AccessControlGrants": { - "shape": "Sa" + "shape": "Sh" }, "MetadataDirective": {}, "ModifiedSinceConstraint": { @@ -406,7 +709,7 @@ } }, "NewObjectTagging": { - "shape": "Sn" + "shape": "Su" }, "RedirectLocation": {}, "RequesterPays": { @@ -445,7 +748,7 @@ } }, "Grants": { - "shape": "Sa" + "shape": "Sh" } } }, @@ -458,7 +761,7 @@ "type": "structure", "members": { "TagSet": { - "shape": "Sn" + "shape": "Su" } } }, @@ -473,7 +776,7 @@ } } }, - "Sa": { + "Sh": { "type": "list", "member": { "type": "structure", @@ -490,7 +793,7 @@ } } }, - "Sn": { + "Su": { "type": "list", "member": { "type": "structure", @@ -504,7 +807,7 @@ } } }, - "S12": { + "S19": { "type": "structure", "required": [ "Enabled" @@ -519,7 +822,7 @@ "ReportScope": {} } }, - "S17": { + "S1e": { "type": "structure", "required": [ "Spec", @@ -553,7 +856,7 @@ } } }, - "S1q": { + "S1z": { "type": "structure", "members": { "TotalNumberOfTasks": { @@ -566,27 +869,6 @@ "type": "long" } } - }, - "S25": { - "type": "structure", - "members": { - "BlockPublicAcls": { - "locationName": "BlockPublicAcls", - "type": "boolean" - }, - "IgnorePublicAcls": { - "locationName": "IgnorePublicAcls", - "type": "boolean" - }, - "BlockPublicPolicy": { - "locationName": "BlockPublicPolicy", - "type": "boolean" - }, - "RestrictPublicBuckets": { - "locationName": "RestrictPublicBuckets", - "type": "boolean" - } - } } } } \ No newline at end of file diff --git a/apis/s3control-2018-08-20.normal.json b/apis/s3control-2018-08-20.normal.json index c3ed816f87..80e35b1ede 100644 --- a/apis/s3control-2018-08-20.normal.json +++ b/apis/s3control-2018-08-20.normal.json @@ -11,6 +11,21 @@ "uid": "s3control-2018-08-20" }, "operations": { + "CreateAccessPoint": { + "name": "CreateAccessPoint", + "http": { + "method": "PUT", + "requestUri": "/v20180820/accesspoint/{name}" + }, + "input": { + "shape": "CreateAccessPointRequest", + "locationName": "CreateAccessPointRequest", + "xmlNamespace": { + "uri": "http://awss3control.amazonaws.com/doc/2018-08-20/" + } + }, + "documentation": "Creates an access point and associates it with the specified bucket.
" + }, "CreateJob": { "name": "CreateJob", "http": { @@ -43,6 +58,28 @@ ], "documentation": "Creates an Amazon S3 batch operations job.
" }, + "DeleteAccessPoint": { + "name": "DeleteAccessPoint", + "http": { + "method": "DELETE", + "requestUri": "/v20180820/accesspoint/{name}" + }, + "input": { + "shape": "DeleteAccessPointRequest" + }, + "documentation": "Deletes the specified access point.
" + }, + "DeleteAccessPointPolicy": { + "name": "DeleteAccessPointPolicy", + "http": { + "method": "DELETE", + "requestUri": "/v20180820/accesspoint/{name}/policy" + }, + "input": { + "shape": "DeleteAccessPointPolicyRequest" + }, + "documentation": "Deletes the access point policy for the specified access point.
" + }, "DeletePublicAccessBlock": { "name": "DeletePublicAccessBlock", "http": { @@ -52,7 +89,7 @@ "input": { "shape": "DeletePublicAccessBlockRequest" }, - "documentation": "Deletes the block public access configuration for the specified account.
" + "documentation": "Removes the PublicAccessBlock
configuration for an Amazon Web Services account.
Retrieves the configuration parameters and status for a batch operations job.
" }, + "GetAccessPoint": { + "name": "GetAccessPoint", + "http": { + "method": "GET", + "requestUri": "/v20180820/accesspoint/{name}" + }, + "input": { + "shape": "GetAccessPointRequest" + }, + "output": { + "shape": "GetAccessPointResult" + }, + "documentation": "Returns configuration information about the specified access point.
" + }, + "GetAccessPointPolicy": { + "name": "GetAccessPointPolicy", + "http": { + "method": "GET", + "requestUri": "/v20180820/accesspoint/{name}/policy" + }, + "input": { + "shape": "GetAccessPointPolicyRequest" + }, + "output": { + "shape": "GetAccessPointPolicyResult" + }, + "documentation": "Returns the access point policy associated with the specified access point.
" + }, + "GetAccessPointPolicyStatus": { + "name": "GetAccessPointPolicyStatus", + "http": { + "method": "GET", + "requestUri": "/v20180820/accesspoint/{name}/policyStatus" + }, + "input": { + "shape": "GetAccessPointPolicyStatusRequest" + }, + "output": { + "shape": "GetAccessPointPolicyStatusResult" + }, + "documentation": "Indicates whether the specified access point currently has a policy that allows public access. For more information about public access through access points, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
" + }, "GetPublicAccessBlock": { "name": "GetPublicAccessBlock", "http": { @@ -99,7 +178,21 @@ "shape": "NoSuchPublicAccessBlockConfiguration" } ], - "documentation": "" + "documentation": "Retrieves the PublicAccessBlock
configuration for an Amazon Web Services account.
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 1000 access points (or the number specified in maxResults
, whichever is less), then the response will include a continuation token that you can use to list the additional access points.
Lists current jobs and jobs that have ended within the last 30 days for the AWS account making the request.
" }, + "PutAccessPointPolicy": { + "name": "PutAccessPointPolicy", + "http": { + "method": "PUT", + "requestUri": "/v20180820/accesspoint/{name}/policy" + }, + "input": { + "shape": "PutAccessPointPolicyRequest", + "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.
" + }, "PutPublicAccessBlock": { "name": "PutPublicAccessBlock", "http": { @@ -135,7 +243,7 @@ "input": { "shape": "PutPublicAccessBlockRequest" }, - "documentation": "" + "documentation": "Creates or modifies the PublicAccessBlock
configuration for an Amazon Web Services account.
The name of this access point.
" + }, + "NetworkOrigin": { + "shape": "NetworkOrigin", + "documentation": "Indicates whether this access point allows access from the public Internet. If VpcConfiguration
is specified for this access point, then NetworkOrigin
is VPC
, and the access point doesn't allow access from the public Internet. Otherwise, NetworkOrigin
is Internet
, and the access point allows access from the public Internet, subject to the access point and bucket access policies.
The Virtual Private Cloud (VPC) configuration for this access point, if one exists.
" + }, + "Bucket": { + "shape": "BucketName", + "documentation": "The name of the bucket associated with this access point.
" + } + }, + "documentation": "An access point used to access a bucket.
" + }, + "AccessPointList": { + "type": "list", + "member": { + "shape": "AccessPoint", + "locationName": "AccessPoint" + } + }, + "AccessPointName": { + "type": "string", + "max": 50, + "min": 3 + }, "AccountId": { "type": "string", "max": 64 @@ -205,9 +352,47 @@ "Boolean": { "type": "boolean" }, + "BucketName": { + "type": "string", + "max": 255, + "min": 3 + }, "ConfirmationRequired": { "type": "boolean" }, + "CreateAccessPointRequest": { + "type": "structure", + "required": [ + "AccountId", + "Name", + "Bucket" + ], + "members": { + "AccountId": { + "shape": "AccountId", + "documentation": "The AWS account ID for the owner of the bucket for which you want to create an access point.
", + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "shape": "AccessPointName", + "documentation": "The name you want to assign to this access point.
", + "location": "uri", + "locationName": "name" + }, + "Bucket": { + "shape": "BucketName", + "documentation": "The name of the bucket that you want to associate this access point with.
" + }, + "VpcConfiguration": { + "shape": "VpcConfiguration", + "documentation": "If you include this field, Amazon S3 restricts access to this access point to requests from the specified Virtual Private Cloud (VPC).
" + }, + "PublicAccessBlockConfiguration": { + "shape": "PublicAccessBlockConfiguration" + } + } + }, "CreateJobRequest": { "type": "structure", "required": [ @@ -272,6 +457,51 @@ } } }, + "CreationDate": { + "type": "timestamp" + }, + "DeleteAccessPointPolicyRequest": { + "type": "structure", + "required": [ + "AccountId", + "Name" + ], + "members": { + "AccountId": { + "shape": "AccountId", + "documentation": "The account ID for the account that owns the specified access point.
", + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "shape": "AccessPointName", + "documentation": "The name of the access point whose policy you want to delete.
", + "location": "uri", + "locationName": "name" + } + } + }, + "DeleteAccessPointRequest": { + "type": "structure", + "required": [ + "AccountId", + "Name" + ], + "members": { + "AccountId": { + "shape": "AccountId", + "documentation": "The account ID for the account that owns the specified access point.
", + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "shape": "AccessPointName", + "documentation": "The name of the access point you want to delete.
", + "location": "uri", + "locationName": "name" + } + } + }, "DeletePublicAccessBlockRequest": { "type": "structure", "required": [ @@ -280,7 +510,7 @@ "members": { "AccountId": { "shape": "AccountId", - "documentation": "The account ID for the AWS account whose block public access configuration you want to delete.
", + "documentation": "The account ID for the Amazon Web Services account whose PublicAccessBlock
configuration you want to remove.
The account ID for the account that owns the specified access point.
", + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "shape": "AccessPointName", + "documentation": "The name of the access point whose policy you want to retrieve.
", + "location": "uri", + "locationName": "name" + } + } + }, + "GetAccessPointPolicyResult": { + "type": "structure", + "members": { + "Policy": { + "shape": "Policy", + "documentation": "The access point policy associated with the specified access point.
" + } + } + }, + "GetAccessPointPolicyStatusRequest": { + "type": "structure", + "required": [ + "AccountId", + "Name" + ], + "members": { + "AccountId": { + "shape": "AccountId", + "documentation": "The account ID for the account that owns the specified access point.
", + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "shape": "AccessPointName", + "documentation": "The name of the access point whose policy status you want to retrieve.
", + "location": "uri", + "locationName": "name" + } + } + }, + "GetAccessPointPolicyStatusResult": { + "type": "structure", + "members": { + "PolicyStatus": { + "shape": "PolicyStatus", + "documentation": "Indicates the current policy status of the specified access point.
" + } + } + }, + "GetAccessPointRequest": { + "type": "structure", + "required": [ + "AccountId", + "Name" + ], + "members": { + "AccountId": { + "shape": "AccountId", + "documentation": "The account ID for the account that owns the specified access point.
", + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "shape": "AccessPointName", + "documentation": "The name of the access point whose configuration information you want to retrieve.
", + "location": "uri", + "locationName": "name" + } + } + }, + "GetAccessPointResult": { + "type": "structure", + "members": { + "Name": { + "shape": "AccessPointName", + "documentation": "The name of the specified access point.
" + }, + "Bucket": { + "shape": "BucketName", + "documentation": "The name of the bucket associated with the specified access point.
" + }, + "NetworkOrigin": { + "shape": "NetworkOrigin", + "documentation": "Indicates whether this access point allows access from the public Internet. If VpcConfiguration
is specified for this access point, then NetworkOrigin
is VPC
, and the access point doesn't allow access from the public Internet. Otherwise, NetworkOrigin
is Internet
, and the access point allows access from the public Internet, subject to the access point and bucket access policies.
Contains the Virtual Private Cloud (VPC) configuration for the specified access point.
" + }, + "PublicAccessBlockConfiguration": { + "shape": "PublicAccessBlockConfiguration" + }, + "CreationDate": { + "shape": "CreationDate", + "documentation": "The date and time when the specified access point was created.
" + } + } + }, "GetPublicAccessBlockOutput": { "type": "structure", "members": { "PublicAccessBlockConfiguration": { "shape": "PublicAccessBlockConfiguration", - "documentation": "" + "documentation": "The PublicAccessBlock
configuration currently in effect for this Amazon Web Services account.
The account ID for the Amazon Web Services account whose PublicAccessBlock
configuration you want to retrieve.
The bucket where specified job-completion report will be stored.
", + "documentation": "The Amazon Resource Name (ARN) for the bucket where specified job-completion report will be stored.
", "box": true }, "Format": { @@ -762,6 +1104,51 @@ }, "documentation": "Contains the configuration parameters for a Lambda Invoke
operation.
The AWS account ID for owner of the bucket whose access points you want to list.
", + "location": "header", + "locationName": "x-amz-account-id" + }, + "Bucket": { + "shape": "BucketName", + "documentation": "The name of the bucket whose associated access points you want to list.
", + "location": "querystring", + "locationName": "bucket" + }, + "NextToken": { + "shape": "NonEmptyMaxLength1024String", + "documentation": "A continuation token. If a previous call to ListAccessPoints
returned a continuation token in the NextToken
field, then providing that value here causes Amazon S3 to retrieve the next page of results.
The maximum number of access points that you want to include in the list. If the specified bucket has more than this number of access points, then the response will include a continuation token in the NextToken
field that you can use to retrieve the next page of access points.
Contains identification and configuration information for one or more access points associated with the specified bucket.
" + }, + "NextToken": { + "shape": "NonEmptyMaxLength1024String", + "documentation": "If the specified bucket has more access points than can be returned in one call to this API, then this field contains a continuation token that you can provide in subsequent calls to this API to retrieve additional access points.
" + } + } + }, "ListJobsRequest": { "type": "structure", "required": [ @@ -817,6 +1204,13 @@ "max": 1000, "min": 1 }, + "NetworkOrigin": { + "type": "string", + "enum": [ + "Internet", + "VPC" + ] + }, "NonEmptyMaxLength1024String": { "type": "string", "max": 1024, @@ -847,31 +1241,71 @@ "S3InitiateRestoreObject" ] }, + "Policy": { + "type": "string" + }, + "PolicyStatus": { + "type": "structure", + "members": { + "IsPublic": { + "shape": "IsPublic", + "documentation": "", + "locationName": "IsPublic" + } + }, + "documentation": "Indicates whether this access point policy is public. For more information about how Amazon S3 evaluates policies to determine whether they are public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer Guide.
" + }, "PublicAccessBlockConfiguration": { "type": "structure", "members": { "BlockPublicAcls": { "shape": "Setting", - "documentation": "", + "documentation": "Specifies whether Amazon S3 should block public access control lists (ACLs) for buckets in this account. Setting this element to TRUE
causes the following behavior:
PUT Bucket acl and PUT Object acl calls fail if the specified ACL is public.
PUT Object calls fail if the request includes a public ACL.
PUT Bucket calls fail if the request includes a public ACL.
Enabling this setting doesn't affect existing policies or ACLs.
", "locationName": "BlockPublicAcls" }, "IgnorePublicAcls": { "shape": "Setting", - "documentation": "", + "documentation": "Specifies whether Amazon S3 should ignore public ACLs for buckets in this account. Setting this element to TRUE
causes Amazon S3 to ignore all public ACLs on buckets in this account and any objects that they contain.
Enabling this setting doesn't affect the persistence of any existing ACLs and doesn't prevent new public ACLs from being set.
", "locationName": "IgnorePublicAcls" }, "BlockPublicPolicy": { "shape": "Setting", - "documentation": "", + "documentation": "Specifies whether Amazon S3 should block public bucket policies for buckets in this account. Setting this element to TRUE
causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.
Enabling this setting doesn't affect existing bucket policies.
", "locationName": "BlockPublicPolicy" }, "RestrictPublicBuckets": { "shape": "Setting", - "documentation": "", + "documentation": "Specifies whether Amazon S3 should restrict public bucket policies for buckets in this account. Setting this element to TRUE
restricts access to buckets with public policies to only AWS services and authorized users within this account.
Enabling this setting doesn't affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.
", "locationName": "RestrictPublicBuckets" } }, - "documentation": "" + "documentation": "The PublicAccessBlock
configuration that you want to apply to this Amazon S3 bucket. You can enable the configuration options in any combination. For more information about when Amazon S3 considers a bucket or object public, see The Meaning of \"Public\" in the Amazon Simple Storage Service Developer Guide.
The AWS account ID for owner of the bucket associated with the specified access point.
", + "location": "header", + "locationName": "x-amz-account-id" + }, + "Name": { + "shape": "AccessPointName", + "documentation": "The name of the access point that you want to associate with the specified policy.
", + "location": "uri", + "locationName": "name" + }, + "Policy": { + "shape": "Policy", + "documentation": "The policy that you want to apply to the specified access point. For more information about access point policies, see Managing Data Access with Amazon S3 Access Points in the Amazon Simple Storage Service Developer Guide.
" + } + } }, "PutPublicAccessBlockRequest": { "type": "structure", @@ -882,7 +1316,7 @@ "members": { "PublicAccessBlockConfiguration": { "shape": "PublicAccessBlockConfiguration", - "documentation": "", + "documentation": "The PublicAccessBlock
configuration that you want to apply to the specified Amazon Web Services account.
The account ID for the Amazon Web Services account whose PublicAccessBlock
configuration you want to set.
Contains the configuration parameters for a PUT Copy object operation. Amazon S3 batch operations passes each value through to the underlying PUT Copy object API. For more information about the parameters for this operation, see PUT Object - Copy.
" @@ -1390,6 +1828,24 @@ "documentation": "The reason that the specified job's status was updated.
" } } + }, + "VpcConfiguration": { + "type": "structure", + "required": [ + "VpcId" + ], + "members": { + "VpcId": { + "shape": "VpcId", + "documentation": "If this field is specified, this access point will only allow connections from the specified VPC ID.
" + } + }, + "documentation": "The Virtual Private Cloud (VPC) configuration for an access point.
" + }, + "VpcId": { + "type": "string", + "max": 1024, + "min": 1 } }, "documentation": "AWS S3 Control provides access to Amazon S3 control plane operations.
" diff --git a/apis/s3control-2018-08-20.paginators.json b/apis/s3control-2018-08-20.paginators.json index 886110429d..b725a739c2 100644 --- a/apis/s3control-2018-08-20.paginators.json +++ b/apis/s3control-2018-08-20.paginators.json @@ -1,5 +1,10 @@ { "pagination": { + "ListAccessPoints": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, "ListJobs": { "input_token": "NextToken", "output_token": "NextToken", diff --git a/apis/sagemaker-a2i-runtime-2019-11-07.examples.json b/apis/sagemaker-a2i-runtime-2019-11-07.examples.json new file mode 100644 index 0000000000..0ea7e3b0bb --- /dev/null +++ b/apis/sagemaker-a2i-runtime-2019-11-07.examples.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/apis/sagemaker-a2i-runtime-2019-11-07.min.json b/apis/sagemaker-a2i-runtime-2019-11-07.min.json new file mode 100644 index 0000000000..552a1ffb0a --- /dev/null +++ b/apis/sagemaker-a2i-runtime-2019-11-07.min.json @@ -0,0 +1,229 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-11-07", + "endpointPrefix": "a2i-runtime.sagemaker", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "Amazon Augmented AI Runtime", + "serviceId": "SageMaker A2I Runtime", + "signatureVersion": "v4", + "signingName": "sagemaker", + "uid": "sagemaker-a2i-runtime-2019-11-07" + }, + "operations": { + "DeleteHumanLoop": { + "http": { + "method": "DELETE", + "requestUri": "/human-loops/{HumanLoopName}" + }, + "input": { + "type": "structure", + "required": [ + "HumanLoopName" + ], + "members": { + "HumanLoopName": { + "location": "uri", + "locationName": "HumanLoopName" + } + } + }, + "output": { + "type": "structure", + "members": {} + } + }, + "DescribeHumanLoop": { + "http": { + "method": "GET", + "requestUri": "/human-loops/{HumanLoopName}" + }, + "input": { + "type": "structure", + "required": [ + "HumanLoopName" + ], + "members": { + "HumanLoopName": { + "location": "uri", + "locationName": "HumanLoopName" + } + } + }, + "output": { + "type": "structure", + "required": [ + "CreationTimestamp", + "HumanLoopStatus", + "HumanLoopName", + "HumanLoopArn", + "FlowDefinitionArn", + "HumanLoopInput" + ], + "members": { + "CreationTimestamp": { + "type": "timestamp" + }, + "FailureReason": {}, + "FailureCode": {}, + "HumanLoopStatus": {}, + "HumanLoopName": {}, + "HumanLoopArn": {}, + "FlowDefinitionArn": {}, + "HumanLoopInput": { + "shape": "Sb" + }, + "HumanLoopOutput": { + "type": "structure", + "required": [ + "OutputS3Uri" + ], + "members": { + "OutputS3Uri": {} + } + } + } + } + }, + "ListHumanLoops": { + "http": { + "method": "GET", + "requestUri": "/human-loops" + }, + "input": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "location": "querystring", + "locationName": "CreationTimeAfter", + "type": "timestamp" + }, + "CreationTimeBefore": { + "location": "querystring", + "locationName": "CreationTimeBefore", + "type": "timestamp" + }, + "SortOrder": { + "location": "querystring", + "locationName": "SortOrder" + }, + "NextToken": { + "location": "querystring", + "locationName": "NextToken" + }, + "MaxResults": { + "location": "querystring", + "locationName": "MaxResults", + "type": "integer" + } + } + }, + "output": { + "type": "structure", + "required": [ + "HumanLoopSummaries" + ], + "members": { + "HumanLoopSummaries": { + "type": "list", + "member": { + "type": "structure", + "members": { + "HumanLoopName": {}, + "HumanLoopStatus": {}, + "CreationTime": { + "type": "timestamp" + }, + "FailureReason": {}, + "FlowDefinitionArn": {} + } + } + }, + "NextToken": {} + } + } + }, + "StartHumanLoop": { + "http": { + "requestUri": "/human-loops" + }, + "input": { + "type": "structure", + "required": [ + "HumanLoopName", + "FlowDefinitionArn", + "HumanLoopInput" + ], + "members": { + "HumanLoopName": {}, + "FlowDefinitionArn": {}, + "HumanLoopInput": { + "shape": "Sb" + }, + "DataAttributes": { + "type": "structure", + "required": [ + "ContentClassifiers" + ], + "members": { + "ContentClassifiers": { + "type": "list", + "member": {} + } + } + } + } + }, + "output": { + "type": "structure", + "members": { + "HumanLoopArn": {}, + "HumanLoopActivationResults": { + "type": "structure", + "members": { + "HumanLoopActivationReason": { + "type": "structure", + "members": { + "ConditionsMatched": { + "type": "boolean" + } + } + }, + "HumanLoopActivationConditionsEvaluationResults": {} + } + } + } + } + }, + "StopHumanLoop": { + "http": { + "requestUri": "/human-loops/stop" + }, + "input": { + "type": "structure", + "required": [ + "HumanLoopName" + ], + "members": { + "HumanLoopName": {} + } + }, + "output": { + "type": "structure", + "members": {} + } + } + }, + "shapes": { + "Sb": { + "type": "structure", + "required": [ + "InputContent" + ], + "members": { + "InputContent": {} + } + } + } +} \ No newline at end of file diff --git a/apis/sagemaker-a2i-runtime-2019-11-07.normal.json b/apis/sagemaker-a2i-runtime-2019-11-07.normal.json new file mode 100644 index 0000000000..2fd49827da --- /dev/null +++ b/apis/sagemaker-a2i-runtime-2019-11-07.normal.json @@ -0,0 +1,513 @@ +{ + "version": "2.0", + "metadata": { + "apiVersion": "2019-11-07", + "endpointPrefix": "a2i-runtime.sagemaker", + "jsonVersion": "1.1", + "protocol": "rest-json", + "serviceFullName": "Amazon Augmented AI Runtime", + "serviceId": "SageMaker A2I Runtime", + "signatureVersion": "v4", + "signingName": "sagemaker", + "uid": "sagemaker-a2i-runtime-2019-11-07" + }, + "operations": { + "DeleteHumanLoop": { + "name": "DeleteHumanLoop", + "http": { + "method": "DELETE", + "requestUri": "/human-loops/{HumanLoopName}" + }, + "input": { + "shape": "DeleteHumanLoopRequest" + }, + "output": { + "shape": "DeleteHumanLoopResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Deletes the specified human loop for a flow definition.
" + }, + "DescribeHumanLoop": { + "name": "DescribeHumanLoop", + "http": { + "method": "GET", + "requestUri": "/human-loops/{HumanLoopName}" + }, + "input": { + "shape": "DescribeHumanLoopRequest" + }, + "output": { + "shape": "DescribeHumanLoopResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Returns information about the specified human loop.
" + }, + "ListHumanLoops": { + "name": "ListHumanLoops", + "http": { + "method": "GET", + "requestUri": "/human-loops" + }, + "input": { + "shape": "ListHumanLoopsRequest" + }, + "output": { + "shape": "ListHumanLoopsResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Returns information about human loops, given the specified parameters.
" + }, + "StartHumanLoop": { + "name": "StartHumanLoop", + "http": { + "method": "POST", + "requestUri": "/human-loops" + }, + "input": { + "shape": "StartHumanLoopRequest" + }, + "output": { + "shape": "StartHumanLoopResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "ServiceQuotaExceededException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Starts a human loop, provided that at least one activation condition is met.
" + }, + "StopHumanLoop": { + "name": "StopHumanLoop", + "http": { + "method": "POST", + "requestUri": "/human-loops/stop" + }, + "input": { + "shape": "StopHumanLoopRequest" + }, + "output": { + "shape": "StopHumanLoopResponse" + }, + "errors": [ + { + "shape": "ValidationException" + }, + { + "shape": "ResourceNotFoundException" + }, + { + "shape": "ThrottlingException" + }, + { + "shape": "InternalServerException" + } + ], + "documentation": "Stops the specified human loop.
" + } + }, + "shapes": { + "Boolean": { + "type": "boolean" + }, + "ContentClassifier": { + "type": "string", + "enum": [ + "FreeOfPersonallyIdentifiableInformation", + "FreeOfAdultContent" + ] + }, + "ContentClassifiers": { + "type": "list", + "member": { + "shape": "ContentClassifier" + }, + "max": 256 + }, + "DeleteHumanLoopRequest": { + "type": "structure", + "required": [ + "HumanLoopName" + ], + "members": { + "HumanLoopName": { + "shape": "HumanLoopName", + "documentation": "The name of the human loop you want to delete.
", + "location": "uri", + "locationName": "HumanLoopName" + } + } + }, + "DeleteHumanLoopResponse": { + "type": "structure", + "members": {} + }, + "DescribeHumanLoopRequest": { + "type": "structure", + "required": [ + "HumanLoopName" + ], + "members": { + "HumanLoopName": { + "shape": "HumanLoopName", + "documentation": "The name of the human loop.
", + "location": "uri", + "locationName": "HumanLoopName" + } + } + }, + "DescribeHumanLoopResponse": { + "type": "structure", + "required": [ + "CreationTimestamp", + "HumanLoopStatus", + "HumanLoopName", + "HumanLoopArn", + "FlowDefinitionArn", + "HumanLoopInput" + ], + "members": { + "CreationTimestamp": { + "shape": "Timestamp", + "documentation": "The timestamp when Amazon Augmented AI created the human loop.
" + }, + "FailureReason": { + "shape": "String", + "documentation": "The reason why a human loop has failed. The failure reason is returned when the human loop status is Failed
.
A failure code denoting a specific type of failure.
" + }, + "HumanLoopStatus": { + "shape": "HumanLoopStatus", + "documentation": "The status of the human loop. Valid values:
" + }, + "HumanLoopName": { + "shape": "HumanLoopName", + "documentation": "The name of the human loop.
" + }, + "HumanLoopArn": { + "shape": "HumanLoopArn", + "documentation": "The Amazon Resource Name (ARN) of the human loop.
" + }, + "FlowDefinitionArn": { + "shape": "FlowDefinitionArn", + "documentation": "The Amazon Resource Name (ARN) of the flow definition.
" + }, + "HumanLoopInput": { + "shape": "HumanLoopInputContent", + "documentation": "An object containing information about the human loop input.
" + }, + "HumanLoopOutput": { + "shape": "HumanLoopOutputContent", + "documentation": "An object containing information about the output of the human loop.
" + } + } + }, + "FailureReason": { + "type": "string", + "max": 1024 + }, + "FlowDefinitionArn": { + "type": "string", + "max": 1024, + "pattern": "arn:aws[a-z\\-]*:sagemaker:[a-z0-9\\-]*:[0-9]{12}:flow-definition/.*" + }, + "HumanLoopActivationReason": { + "type": "structure", + "members": { + "ConditionsMatched": { + "shape": "Boolean", + "documentation": "True if the specified conditions were matched to trigger the human loop.
" + } + }, + "documentation": "Contains information about why a human loop was triggered. If at least one activation reason is evaluated to be true, the human loop is activated.
" + }, + "HumanLoopActivationResults": { + "type": "structure", + "members": { + "HumanLoopActivationReason": { + "shape": "HumanLoopActivationReason", + "documentation": "An object containing information about why a human loop was triggered.
" + }, + "HumanLoopActivationConditionsEvaluationResults": { + "shape": "String", + "documentation": "A copy of the human loop activation conditions of the flow definition, augmented with the results of evaluating those conditions on the input provided to the StartHumanLoop
operation.
Information about the corresponding flow definition's human loop activation condition evaluation. Null if StartHumanLoop
was invoked directly.
Serialized input from the human loop.
" + } + }, + "documentation": "An object containing the input.
" + }, + "HumanLoopName": { + "type": "string", + "max": 63, + "min": 1, + "pattern": "^[a-z0-9](-*[a-z0-9])*$" + }, + "HumanLoopOutputContent": { + "type": "structure", + "required": [ + "OutputS3Uri" + ], + "members": { + "OutputS3Uri": { + "shape": "String", + "documentation": "The location of the Amazon S3 object where Amazon Augmented AI stores your human loop output. The output is stored at the following location: s3://S3OutputPath/HumanLoopName/CreationTime/output.json
.
Information about where the human output will be stored.
" + }, + "HumanLoopStatus": { + "type": "string", + "enum": [ + "InProgress", + "Failed", + "Completed", + "Stopped", + "Stopping" + ] + }, + "HumanLoopSummaries": { + "type": "list", + "member": { + "shape": "HumanLoopSummary" + } + }, + "HumanLoopSummary": { + "type": "structure", + "members": { + "HumanLoopName": { + "shape": "HumanLoopName", + "documentation": "The name of the human loop.
" + }, + "HumanLoopStatus": { + "shape": "HumanLoopStatus", + "documentation": "The status of the human loop. Valid values:
" + }, + "CreationTime": { + "shape": "Timestamp", + "documentation": "When Amazon Augmented AI created the human loop.
" + }, + "FailureReason": { + "shape": "FailureReason", + "documentation": "The reason why the human loop failed. A failure reason is returned only when the status of the human loop is Failed
.
The Amazon Resource Name (ARN) of the flow definition.
" + } + }, + "documentation": "Summary information about the human loop.
" + }, + "HumanReviewDataAttributes": { + "type": "structure", + "required": [ + "ContentClassifiers" + ], + "members": { + "ContentClassifiers": { + "shape": "ContentClassifiers", + "documentation": "Declares that your content is free of personally identifiable information or adult content. Amazon SageMaker may restrict the Amazon Mechanical Turk workers that can view your task based on this information.
" + } + }, + "documentation": "Attributes of the data specified by the customer. Use these to describe the data to be labeled.
" + }, + "InputContent": { + "type": "string", + "max": 4194304 + }, + "ListHumanLoopsRequest": { + "type": "structure", + "members": { + "CreationTimeAfter": { + "shape": "Timestamp", + "documentation": "(Optional) The timestamp of the date when you want the human loops to begin. For example, 1551000000
.
(Optional) The timestamp of the date before which you want the human loops to begin. For example, 1550000000
.
An optional value that specifies whether you want the results sorted in Ascending
or Descending
order.
A token to resume pagination.
", + "location": "querystring", + "locationName": "NextToken" + }, + "MaxResults": { + "shape": "MaxResults", + "documentation": "The total number of items to return. If the total number of available items is more than the value specified in MaxResults
, then a NextToken
will be provided in the output that you can use to resume pagination.
An array of objects containing information about the human loops.
" + }, + "NextToken": { + "shape": "NextToken", + "documentation": "A token to resume pagination.
" + } + } + }, + "MaxResults": { + "type": "integer", + "max": 100, + "min": 1 + }, + "NextToken": { + "type": "string", + "max": 8192, + "pattern": ".*" + }, + "SortOrder": { + "type": "string", + "enum": [ + "Ascending", + "Descending" + ] + }, + "StartHumanLoopRequest": { + "type": "structure", + "required": [ + "HumanLoopName", + "FlowDefinitionArn", + "HumanLoopInput" + ], + "members": { + "HumanLoopName": { + "shape": "HumanLoopName", + "documentation": "The name of the human loop.
" + }, + "FlowDefinitionArn": { + "shape": "FlowDefinitionArn", + "documentation": "The Amazon Resource Name (ARN) of the flow definition.
" + }, + "HumanLoopInput": { + "shape": "HumanLoopInputContent", + "documentation": "An object containing information about the human loop.
" + }, + "DataAttributes": { + "shape": "HumanReviewDataAttributes", + "documentation": "Attributes of the data specified by the customer.
" + } + } + }, + "StartHumanLoopResponse": { + "type": "structure", + "members": { + "HumanLoopArn": { + "shape": "HumanLoopArn", + "documentation": "The Amazon Resource Name (ARN) of the human loop.
" + }, + "HumanLoopActivationResults": { + "shape": "HumanLoopActivationResults", + "documentation": "An object containing information about the human loop activation.
" + } + } + }, + "StopHumanLoopRequest": { + "type": "structure", + "required": [ + "HumanLoopName" + ], + "members": { + "HumanLoopName": { + "shape": "HumanLoopName", + "documentation": "The name of the human loop you want to stop.
" + } + } + }, + "StopHumanLoopResponse": { + "type": "structure", + "members": {} + }, + "String": { + "type": "string" + }, + "Timestamp": { + "type": "timestamp" + } + }, + "documentation": "Amazon Augmented AI (Augmented AI) (Preview) is a service that adds human judgment to any machine learning application. Human reviewers can take over when an AI application can't evaluate data with a high degree of confidence.
From fraudulent bank transaction identification to document processing to image analysis, machine learning models can be trained to make decisions as well as or better than a human. Nevertheless, some decisions require contextual interpretation, such as when you need to decide whether an image is appropriate for a given audience. Content moderation guidelines are nuanced and highly dependent on context, and they vary between countries. When trying to apply AI in these situations, you can be forced to choose between \"ML only\" systems with unacceptably high error rates or \"human only\" systems that are expensive and difficult to scale, and that slow down decision making.
This API reference includes information about API actions and data types you can use to interact with Augmented AI programmatically.
You can create a flow definition against the Augmented AI API. Provide the Amazon Resource Name (ARN) of a flow definition to integrate AI service APIs, such as Textract.AnalyzeDocument
and Rekognition.DetectModerationLabels
. These AI services, in turn, invoke the StartHumanLoop API, which evaluates conditions under which humans will be invoked. If humans are required, Augmented AI creates a human loop. Results of human work are available asynchronously in Amazon Simple Storage Service (Amazon S3). You can use Amazon CloudWatch Events to detect human work results.
You can find additional Augmented AI API documentation in the following reference guides: Amazon Rekognition, Amazon SageMaker, and Amazon Textract.
" +} \ No newline at end of file diff --git a/apis/sagemaker-a2i-runtime-2019-11-07.paginators.json b/apis/sagemaker-a2i-runtime-2019-11-07.paginators.json new file mode 100644 index 0000000000..b19128c262 --- /dev/null +++ b/apis/sagemaker-a2i-runtime-2019-11-07.paginators.json @@ -0,0 +1,10 @@ +{ + "pagination": { + "ListHumanLoops": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults", + "result_key": "HumanLoopSummaries" + } + } +} diff --git a/apis/textract-2018-06-27.min.json b/apis/textract-2018-06-27.min.json index ec7d0bf67d..bc74581aa3 100644 --- a/apis/textract-2018-06-27.min.json +++ b/apis/textract-2018-06-27.min.json @@ -25,6 +25,26 @@ }, "FeatureTypes": { "shape": "S8" + }, + "HumanLoopConfig": { + "type": "structure", + "required": [ + "HumanLoopName", + "FlowDefinitionArn" + ], + "members": { + "HumanLoopName": {}, + "FlowDefinitionArn": {}, + "DataAttributes": { + "type": "structure", + "members": { + "ContentClassifiers": { + "type": "list", + "member": {} + } + } + } + } } } }, @@ -32,11 +52,25 @@ "type": "structure", "members": { "DocumentMetadata": { - "shape": "Sb" + "shape": "Sh" }, "Blocks": { - "shape": "Sd" - } + "shape": "Sj" + }, + "HumanLoopActivationOutput": { + "type": "structure", + "members": { + "HumanLoopArn": {}, + "HumanLoopActivationReasons": { + "type": "list", + "member": {} + }, + "HumanLoopActivationConditionsEvaluationResults": { + "jsonvalue": true + } + } + }, + "AnalyzeDocumentModelVersion": {} } } }, @@ -56,11 +90,12 @@ "type": "structure", "members": { "DocumentMetadata": { - "shape": "Sb" + "shape": "Sh" }, "Blocks": { - "shape": "Sd" - } + "shape": "Sj" + }, + "DetectDocumentTextModelVersion": {} } } }, @@ -82,17 +117,18 @@ "type": "structure", "members": { "DocumentMetadata": { - "shape": "Sb" + "shape": "Sh" }, "JobStatus": {}, "NextToken": {}, "Blocks": { - "shape": "Sd" + "shape": "Sj" }, "Warnings": { - "shape": "S13" + "shape": "S1e" }, - "StatusMessage": {} + "StatusMessage": {}, + "AnalyzeDocumentModelVersion": {} } } }, @@ -114,17 +150,18 @@ "type": "structure", "members": { "DocumentMetadata": { - "shape": "Sb" + "shape": "Sh" }, "JobStatus": {}, "NextToken": {}, "Blocks": { - "shape": "Sd" + "shape": "Sj" }, "Warnings": { - "shape": "S13" + "shape": "S1e" }, - "StatusMessage": {} + "StatusMessage": {}, + "DetectDocumentTextModelVersion": {} } } }, @@ -137,7 +174,7 @@ ], "members": { "DocumentLocation": { - "shape": "S1b" + "shape": "S1m" }, "FeatureTypes": { "shape": "S8" @@ -145,7 +182,7 @@ "ClientRequestToken": {}, "JobTag": {}, "NotificationChannel": { - "shape": "S1e" + "shape": "S1p" } } }, @@ -164,12 +201,12 @@ ], "members": { "DocumentLocation": { - "shape": "S1b" + "shape": "S1m" }, "ClientRequestToken": {}, "JobTag": {}, "NotificationChannel": { - "shape": "S1e" + "shape": "S1p" } } }, @@ -205,7 +242,7 @@ "type": "list", "member": {} }, - "Sb": { + "Sh": { "type": "structure", "members": { "Pages": { @@ -213,7 +250,7 @@ } } }, - "Sd": { + "Sj": { "type": "list", "member": { "type": "structure", @@ -296,7 +333,7 @@ } } }, - "S13": { + "S1e": { "type": "list", "member": { "type": "structure", @@ -311,7 +348,7 @@ } } }, - "S1b": { + "S1m": { "type": "structure", "members": { "S3Object": { @@ -319,7 +356,7 @@ } } }, - "S1e": { + "S1p": { "type": "structure", "required": [ "SNSTopicArn", diff --git a/apis/textract-2018-06-27.normal.json b/apis/textract-2018-06-27.normal.json index 30fb92403c..c87d7cebe0 100644 --- a/apis/textract-2018-06-27.normal.json +++ b/apis/textract-2018-06-27.normal.json @@ -51,9 +51,12 @@ }, { "shape": "ThrottlingException" + }, + { + "shape": "HumanLoopQuotaExceededException" } ], - "documentation": "Analyzes an input document for relationships between detected items.
The types of information returned are as follows:
Words and lines that are related to nearby lines and words. The related information is returned in two Block objects each of type KEY_VALUE_SET
: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.
You can choose which type of analysis to perform by specifying the FeatureTypes
list.
The output is returned in a list of BLOCK
objects.
AnalyzeDocument
is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.
For more information, see Document Text Analysis.
" + "documentation": "Analyzes an input document for relationships between detected items.
The types of information returned are as follows:
Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET
: a KEY Block
object and a VALUE Block
object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block
object contains information about a detected table. A CELL Block
object is returned for each cell in a table.
Lines and words of text. A LINE Block
object contains one or more WORD Block
objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of FeatureTypes
).
Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block
object contains information about a selection element, including the selection status.
You can choose which type of analysis to perform by specifying the FeatureTypes
list.
The output is returned in a list of Block
objects.
AnalyzeDocument
is a synchronous operation. To analyze documents asynchronously, use StartDocumentAnalysis.
For more information, see Document Text Analysis.
" }, "DetectDocumentText": { "name": "DetectDocumentText", @@ -96,7 +99,7 @@ "shape": "ThrottlingException" } ], - "documentation": "Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPG or PNG format. DetectDocumentText
returns the detected text in an array of Block objects.
Each document page has as an associated Block
of type PAGE. Each PAGE Block
object is the parent of LINE Block
objects that represent the lines of detected text on a page. A LINE Block
object is a parent for each word that makes up the line. Words are represented by Block
objects of type WORD.
DetectDocumentText
is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.
For more information, see Document Text Detection.
" + "documentation": "Detects text in the input document. Amazon Textract can detect lines of text and the words that make up a line of text. The input document must be an image in JPEG or PNG format. DetectDocumentText
returns the detected text in an array of Block objects.
Each document page has as an associated Block
of type PAGE. Each PAGE Block
object is the parent of LINE Block
objects that represent the lines of detected text on a page. A LINE Block
object is a parent for each word that makes up the line. Words are represented by Block
objects of type WORD.
DetectDocumentText
is a synchronous operation. To analyze documents asynchronously, use StartDocumentTextDetection.
For more information, see Document Text Detection.
" }, "GetDocumentAnalysis": { "name": "GetDocumentAnalysis", @@ -130,7 +133,7 @@ "shape": "ThrottlingException" } ], - "documentation": "Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId
). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis
. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetDocumentAnalysis
, and pass the job identifier (JobId
) from the initial call to StartDocumentAnalysis
.
GetDocumentAnalysis
returns an array of Block objects. The following types of information are returned:
Words and lines that are related to nearby lines and words. The related information is returned in two Block objects each of type KEY_VALUE_SET
: a KEY Block object and a VALUE Block object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block object contains information about a detected table. A CELL Block object is returned for each cell in a table.
Selectable elements such as checkboxes and radio buttons. A SELECTION_ELEMENT Block object contains information about a selectable element.
Lines and words of text. A LINE Block object contains one or more WORD Block objects.
Use the MaxResults
parameter to limit the number of blocks returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis
, and populate the NextToken
request parameter with the token value that's returned from the previous call to GetDocumentAnalysis
.
For more information, see Document Text Analysis.
" + "documentation": "Gets the results for an Amazon Textract asynchronous operation that analyzes text in a document.
You start asynchronous text analysis by calling StartDocumentAnalysis, which returns a job identifier (JobId
). When the text analysis operation finishes, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that's registered in the initial call to StartDocumentAnalysis
. To get the results of the text-detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetDocumentAnalysis
, and pass the job identifier (JobId
) from the initial call to StartDocumentAnalysis
.
GetDocumentAnalysis
returns an array of Block objects. The following types of information are returned:
Form data (key-value pairs). The related information is returned in two Block objects, each of type KEY_VALUE_SET
: a KEY Block
object and a VALUE Block
object. For example, Name: Ana Silva Carolina contains a key and value. Name: is the key. Ana Silva Carolina is the value.
Table and table cell data. A TABLE Block
object contains information about a detected table. A CELL Block
object is returned for each cell in a table.
Lines and words of text. A LINE Block
object contains one or more WORD Block
objects. All lines and words that are detected in the document are returned (including text that doesn't have a relationship with the value of the StartDocumentAnalysis
FeatureTypes
input parameter).
Selection elements such as check boxes and option buttons (radio buttons) can be detected in form data and in tables. A SELECTION_ELEMENT Block
object contains information about a selection element, including the selection status.
Use the MaxResults
parameter to limit the number of blocks that are returned. If there are more results than specified in MaxResults
, the value of NextToken
in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call GetDocumentAnalysis
, and populate the NextToken
request parameter with the token value that's returned from the previous call to GetDocumentAnalysis
.
For more information, see Document Text Analysis.
" }, "GetDocumentTextDetection": { "name": "GetDocumentTextDetection", @@ -213,7 +216,7 @@ "shape": "LimitExceededException" } ], - "documentation": "Starts asynchronous analysis of an input document for relationships between detected items such as key and value pairs, tables, and selection elements.
StartDocumentAnalysis
can analyze text in documents that are in JPG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.
StartDocumentAnalysis
returns a job identifier (JobId
) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel
. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetDocumentAnalysis, and pass the job identifier (JobId
) from the initial call to StartDocumentAnalysis
.
For more information, see Document Text Analysis.
" + "documentation": "Starts the asynchronous analysis of an input document for relationships between detected items such as key-value pairs, tables, and selection elements.
StartDocumentAnalysis
can analyze text in documents that are in JPEG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.
StartDocumentAnalysis
returns a job identifier (JobId
) that you use to get the results of the operation. When text analysis is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel
. To get the results of the text analysis operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetDocumentAnalysis, and pass the job identifier (JobId
) from the initial call to StartDocumentAnalysis
.
For more information, see Document Text Analysis.
" }, "StartDocumentTextDetection": { "name": "StartDocumentTextDetection", @@ -262,7 +265,7 @@ "shape": "LimitExceededException" } ], - "documentation": "Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.
StartDocumentTextDetection
can analyze text in documents that are in JPG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.
StartTextDetection
returns a job identifier (JobId
) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel
. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetDocumentTextDetection, and pass the job identifier (JobId
) from the initial call to StartDocumentTextDetection
.
For more information, see Document Text Detection.
" + "documentation": "Starts the asynchronous detection of text in a document. Amazon Textract can detect lines of text and the words that make up a line of text.
StartDocumentTextDetection
can analyze text in documents that are in JPEG, PNG, and PDF format. The documents are stored in an Amazon S3 bucket. Use DocumentLocation to specify the bucket name and file name of the document.
StartTextDetection
returns a job identifier (JobId
) that you use to get the results of the operation. When text detection is finished, Amazon Textract publishes a completion status to the Amazon Simple Notification Service (Amazon SNS) topic that you specify in NotificationChannel
. To get the results of the text detection operation, first check that the status value published to the Amazon SNS topic is SUCCEEDED
. If so, call GetDocumentTextDetection, and pass the job identifier (JobId
) from the initial call to StartDocumentTextDetection
.
For more information, see Document Text Detection.
" } }, "shapes": { @@ -275,11 +278,15 @@ "members": { "Document": { "shape": "Document", - "documentation": "The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPG or PNG format.
If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes
field.
The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes
field.
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes
.
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes
. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes
).
Sets the configuration for the human in the loop workflow for analyzing documents.
" } } }, @@ -292,7 +299,15 @@ }, "Blocks": { "shape": "BlockList", - "documentation": "The text that's detected and analyzed by AnalyzeDocument
.
The items that are detected and analyzed by AnalyzeDocument
.
Shows the results of the human in the loop evaluation.
" + }, + "AnalyzeDocumentModelVersion": { + "shape": "String", + "documentation": "The version of the model used to analyze the document.
" } } }, @@ -301,11 +316,11 @@ "members": { "BlockType": { "shape": "BlockType", - "documentation": "The type of text that's recognized in a block. In text-detection operations, the following types are returned:
PAGE - Contains a list of the LINE Block objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that's detected on a document page.
In text analysis operations, the following types are returned:
PAGE - Contains a list of child Block objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block objects for a field that's detected on a document page. Use the EntityType
field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces that's detected on a document page.
LINE - A string of tab-delimited, contiguous words that's detected on a document page.
TABLE - A table that's detected on a document page. A table is any grid-based information with 2 or more rows or columns with a cell span of 1 row and 1 column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selectable element such as a radio button or checkbox that's detected on a document page. Use the value of SelectionStatus
to determine the status of the selection element.
The type of text item that's recognized. In operations for text detection, the following types are returned:
PAGE - Contains a list of the LINE Block
objects that are detected on a document page.
WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
In text analysis operations, the following types are returned:
PAGE - Contains a list of child Block
objects that are detected on a document page.
KEY_VALUE_SET - Stores the KEY and VALUE Block
objects for linked text that's detected on a document page. Use the EntityType
field to determine if a KEY_VALUE_SET object is a KEY Block
object or a VALUE Block
object.
WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
LINE - A string of tab-delimited, contiguous words that are detected on a document page.
TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus
to determine the status of the selection element.
The confidence that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
" + "documentation": "The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
" }, "Text": { "shape": "String", @@ -321,11 +336,11 @@ }, "RowSpan": { "shape": "UInteger", - "documentation": "The number of rows that a table spans. RowSpan
isn't returned by DetectDocumentText
and GetDocumentTextDetection
.
The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan
isn't returned by DetectDocumentText
and GetDocumentTextDetection
.
The number of columns that a table cell spans. ColumnSpan
isn't returned by DetectDocumentText
and GetDocumentTextDetection
.
The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan
isn't returned by DetectDocumentText
and GetDocumentTextDetection
.
A list of child blocks of the current block. For example a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
0 - The block has no child blocks.
1 - The block has child blocks.
A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
0 - The block has no child blocks.
1 - The block has child blocks.
The selection status of a selectable element such as a radio button or checkbox.
" + "documentation": "The selection status of a selection element, such as an option button or check box.
" }, "Page": { "shape": "UInteger", - "documentation": "The page in which a block was detected. Page
is returned by asynchronous operations. Page values greater than 1 are only returned for multi-page documents that are in PDF format. A scanned image (JPG/PNG), even if it contains multiple document pages, is always considered to be a single-page document and the value of Page
is always 1. Synchronous operations don't return Page
as every input document is considered to be a single-page document.
The page on which a block was detected. Page
is returned by asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page
is always 1. Synchronous operations don't return Page
because every input document is considered to be a single-page document.
A Block
represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block
depends on the type of operation. In document-text detection (for example DetectDocumentText), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument), you can also get information about the fields, tables and selection elements that are detected in the document.
An array of Block
objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText, the array of Block
objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis, the array is returned over one or more responses.
For more information, see How Amazon Textract Works.
" + "documentation": "A Block
represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block
object depends on the type of operation. In text detection for documents (for example DetectDocumentText), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument), you can also get information about the fields, tables, and selection elements that are detected in the document.
An array of Block
objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText, the array of Block
objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis, the array is returned over one or more responses.
For more information, see How Amazon Textract Works.
" }, "BlockList": { "type": "list", @@ -392,7 +407,7 @@ "documentation": "The top coordinate of the bounding box as a ratio of overall document page height.
" } }, - "documentation": "The bounding box around the recognized text, key, value, table or table cell on a document page. The left
(x-coordinate) and top
(y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).
The top
and left
values returned are ratios of the overall document page size. For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is 350 x 50 pixels, the API returns a left
value of 0.5 (350/700) and a top
value of 0.25 (50/200).
The width
and height
values represent the dimensions of the bounding box as a ratio of the overall document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.
The bounding box around the detected page, text, key-value pair, table, table cell, or selection element on a document page. The left
(x-coordinate) and top
(y-coordinate) are coordinates that represent the top and left sides of the bounding box. Note that the upper-left corner of the image is the origin (0,0).
The top
and left
values returned are ratios of the overall document page size. For example, if the input image is 700 x 200 pixels, and the top-left coordinate of the bounding box is 350 x 50 pixels, the API returns a left
value of 0.5 (350/700) and a top
value of 0.25 (50/200).
The width
and height
values represent the dimensions of the bounding box as a ratio of the overall document page dimension. For example, if the document page size is 700 x 200 pixels, and the bounding box width is 70 pixels, the width returned is 0.1.
The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPG or PNG format.
If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes
field.
The input document as base64-encoded bytes or an Amazon S3 object. If you use the AWS CLI to call Amazon Textract operations, you can't pass image bytes. The document must be an image in JPEG or PNG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes that are passed using the Bytes
field.
Metadata about the document. Contains the number of pages that are detected in the document.
" + "documentation": "Metadata about the document. It contains the number of pages that are detected in the document.
" }, "Blocks": { "shape": "BlockList", - "documentation": "An array of Block objects containing the text detected in the document.
" + "documentation": "An array of Block
objects that contain the text that's detected in the document.
A blob of base-64 encoded documents bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPG format.
If you are using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes
field.
A blob of base64-encoded document bytes. The maximum size of a document that's provided in a blob of bytes is 5 MB. The document bytes must be in PNG or JPEG format.
If you're using an AWS SDK to call Amazon Textract, you might not need to base64-encode image bytes passed using the Bytes
field.
Identifies an S3 object as the document source. The maximum size of a document stored in an S3 bucket is 5 MB.
" + "documentation": "Identifies an S3 object as the document source. The maximum size of a document that's stored in an S3 bucket is 5 MB.
" } }, "documentation": "The input document, either as bytes or as an S3 object.
You pass image bytes to an Amazon Textract API operation by using the Bytes
property. For example, you would use the Bytes
property to pass a document loaded from a local file system. Image bytes passed by using the Bytes
property must be base64 encoded. Your code might not need to encode document file bytes if you're using an AWS SDK to call Amazon Textract API operations.
You pass images stored in an S3 bucket to an Amazon Textract API operation by using the S3Object
property. Documents stored in an S3 bucket don't need to be base64 encoded.
The AWS Region for the S3 bucket that contains the S3 object must match the AWS Region that you use for Amazon Textract operations.
If you use the AWS CLI to call Amazon Textract operations, passing image bytes using the Bytes property isn't supported. You must first upload the document to an Amazon S3 bucket, and then call the operation using the S3Object property.
For Amazon Textract to process an S3 object, the user must have permission to access the S3 object.
" @@ -447,14 +480,14 @@ "documentation": "The Amazon S3 bucket that contains the input document.
" } }, - "documentation": "The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations such as StartDocumentTextDetection.
The input document can be an image file in JPG or PNG format. It can also be a file in PDF format.
" + "documentation": "The Amazon S3 bucket that contains the document to be processed. It's used by asynchronous operations such as StartDocumentTextDetection.
The input document can be an image file in JPEG or PNG format. It can also be a file in PDF format.
" }, "DocumentMetadata": { "type": "structure", "members": { "Pages": { "shape": "UInteger", - "documentation": "The number of pages detected in the document.
" + "documentation": "The number of pages that are detected in the document.
" } }, "documentation": "Information about the input document.
" @@ -491,19 +524,23 @@ "Float": { "type": "float" }, + "FlowDefinitionArn": { + "type": "string", + "max": 256 + }, "Geometry": { "type": "structure", "members": { "BoundingBox": { "shape": "BoundingBox", - "documentation": "An axis-aligned coarse representation of the location of the recognized text on the document page.
" + "documentation": "An axis-aligned coarse representation of the location of the recognized item on the document page.
" }, "Polygon": { "shape": "Polygon", - "documentation": "Within the bounding box, a fine-grained polygon around the recognized text.
" + "documentation": "Within the bounding box, a fine-grained polygon around the recognized item.
" } }, - "documentation": "Information about where a recognized text, key, value, table, or table cell is located on a document page.
" + "documentation": "Information about where the following items are located on a document page: detected page, text, key-value pairs, tables, table cells, and selection elements.
" }, "GetDocumentAnalysisRequest": { "type": "structure", @@ -513,7 +550,7 @@ "members": { "JobId": { "shape": "JobId", - "documentation": "A unique identifier for the text-detection job. The JobId
is returned from StartDocumentAnalysis
.
A unique identifier for the text-detection job. The JobId
is returned from StartDocumentAnalysis
. A JobId
value is only valid for 7 days.
The results of the text analysis operation.
" + "documentation": "The results of the text-analysis operation.
" }, "Warnings": { "shape": "Warnings", - "documentation": "A list of warnings that occurred during the document analysis operation.
" + "documentation": "A list of warnings that occurred during the document-analysis operation.
" }, "StatusMessage": { "shape": "StatusMessage", - "documentation": "The current status of an asynchronous document analysis operation.
" + "documentation": "The current status of an asynchronous document-analysis operation.
" + }, + "AnalyzeDocumentModelVersion": { + "shape": "String", + "documentation": "" } } }, @@ -562,7 +603,7 @@ "members": { "JobId": { "shape": "JobId", - "documentation": "A unique identifier for the text detection job. The JobId
is returned from StartDocumentTextDetection
.
A unique identifier for the text detection job. The JobId
is returned from StartDocumentTextDetection
. A JobId
value is only valid for 7 days.
A list of warnings that occurred during the document text-detection operation.
" + "documentation": "A list of warnings that occurred during the text-detection operation for the document.
" }, "StatusMessage": { "shape": "StatusMessage", - "documentation": "The current status of an asynchronous document text-detection operation.
" + "documentation": "The current status of an asynchronous text-detection operation for the document.
" + }, + "DetectDocumentTextModelVersion": { + "shape": "String", + "documentation": "" } } }, + "HumanLoopActivationConditionsEvaluationResults": { + "type": "string", + "max": 10240 + }, + "HumanLoopActivationOutput": { + "type": "structure", + "members": { + "HumanLoopArn": { + "shape": "HumanLoopArn", + "documentation": "The Amazon Resource Name (ARN) of the HumanLoop created.
" + }, + "HumanLoopActivationReasons": { + "shape": "HumanLoopActivationReasons", + "documentation": "Shows if and why human review was needed.
" + }, + "HumanLoopActivationConditionsEvaluationResults": { + "shape": "HumanLoopActivationConditionsEvaluationResults", + "documentation": "Shows the result of condition evaluations, including those conditions which activated a human review.
", + "jsonvalue": true + } + }, + "documentation": "Shows the results of the human in the loop evaluation. If there is no HumanLoopArn, the input did not trigger human review.
" + }, + "HumanLoopActivationReason": { + "type": "string" + }, + "HumanLoopActivationReasons": { + "type": "list", + "member": { + "shape": "HumanLoopActivationReason" + }, + "min": 1 + }, + "HumanLoopArn": { + "type": "string", + "max": 256 + }, + "HumanLoopConfig": { + "type": "structure", + "required": [ + "HumanLoopName", + "FlowDefinitionArn" + ], + "members": { + "HumanLoopName": { + "shape": "HumanLoopName", + "documentation": "The name of the human workflow used for this image. This should be kept unique within a region.
" + }, + "FlowDefinitionArn": { + "shape": "FlowDefinitionArn", + "documentation": "The Amazon Resource Name (ARN) of the flow definition.
" + }, + "DataAttributes": { + "shape": "HumanLoopDataAttributes", + "documentation": "Sets attributes of the input data.
" + } + }, + "documentation": "Sets up the human review workflow the document will be sent to if one of the conditions is met. You can also set certain attributes of the image before review.
" + }, + "HumanLoopDataAttributes": { + "type": "structure", + "members": { + "ContentClassifiers": { + "shape": "ContentClassifiers", + "documentation": "Sets whether the input image is free of personally identifiable information or adult content.
" + } + }, + "documentation": "Allows you to set attributes of the image. Currently, you can declare an image as free of personally identifiable information and adult content.
" + }, + "HumanLoopName": { + "type": "string", + "max": 63, + "min": 1, + "pattern": "^[a-z0-9](-*[a-z0-9])*" + }, "IdList": { "type": "list", "member": { @@ -611,7 +731,7 @@ }, "ImageBlob": { "type": "blob", - "max": 5242880, + "max": 10485760, "min": 1 }, "JobId": { @@ -690,7 +810,7 @@ "documentation": "The value of the Y coordinate for a point on a Polygon
.
The X and Y coordinates of a point on a document page. The X and Y values returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point
objects, Polygon
, is returned by DetectDocumentText. Polygon
represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
The X and Y coordinates of a point on a document page. The X and Y values that are returned are ratios of the overall document page size. For example, if the input document is 700 x 200 and the operation returns X=0.5 and Y=0.25, then the point is at the (350,50) pixel coordinate on the document page.
An array of Point
objects, Polygon
, is returned by DetectDocumentText. Polygon
represents a fine-grained polygon around detected text. For more information, see Geometry in the Amazon Textract Developer Guide.
The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE
or CHILD
.
The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE
or CHILD
. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks.
The file name of the input document. It must be an image file (.JPG or .PNG format). Asynchronous operations also support PDF files.
" + "documentation": "The file name of the input document. Synchronous operations can use image files that are in JPEG or PNG format. Asynchronous operations also support PDF format files.
" }, "Version": { "shape": "S3ObjectVersion", @@ -793,15 +913,15 @@ }, "FeatureTypes": { "shape": "FeatureTypes", - "documentation": "A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected fields and the associated text. To perform both types of analysis, add TABLES and FORMS to FeatureTypes
. All selectable elements (SELECTION_ELEMENT
) that are detected are returned, whatever the value of FeatureTypes
.
A list of the types of analysis to perform. Add TABLES to the list to return information about the tables that are detected in the input document. Add FORMS to return detected form data. To perform both types of analysis, add TABLES and FORMS to FeatureTypes
. All lines and words detected in the document are included in the response (including text that isn't related to the value of FeatureTypes
).
The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidentally started more than once.
The idempotent token that you use to identify the start request. If you use the same token with multiple StartDocumentAnalysis
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag
to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag
to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).
The identifier for the document text detection job. Use JobId
to identify the job in a subsequent call to GetDocumentAnalysis
.
The identifier for the document text detection job. Use JobId
to identify the job in a subsequent call to GetDocumentAnalysis
. A JobId
value is only valid for 7 days.
The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidentally started more than once.
The idempotent token that's used to identify the start request. If you use the same token with multiple StartDocumentTextDetection
requests, the same JobId
is returned. Use ClientRequestToken
to prevent the same job from being accidentally started more than once. For more information, see Calling Amazon Textract Asynchronous Operations.
An identifier you specify that's included in the completion notification that's published to the Amazon SNS topic. For example, you can use JobTag
to identify the type of document, such as a tax form or a receipt, that the completion notification corresponds to.
An identifier that you specify that's included in the completion notification published to the Amazon SNS topic. For example, you can use JobTag
to identify the type of document that the completion notification corresponds to (such as a tax form or a receipt).
The identifier for the document text-detection job. Use JobId
to identify the job in a subsequent call to GetDocumentTextDetection
.
The identifier of the text detection job for the document. Use JobId
to identify the job in a subsequent call to GetDocumentTextDetection
. A JobId
value is only valid for 7 days.
A list of the pages that the warning applies to.
" } }, - "documentation": "A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document-text detection (StartDocumentTextDetection).
" + "documentation": "A warning about an issue that occurred during asynchronous text analysis (StartDocumentAnalysis) or asynchronous document text detection (StartDocumentTextDetection).
" }, "Warnings": { "type": "list", diff --git a/clients/all.d.ts b/clients/all.d.ts index 833b826d04..363375db3b 100644 --- a/clients/all.d.ts +++ b/clients/all.d.ts @@ -206,3 +206,11 @@ export import ElasticInference = require('./elasticinference'); export import Imagebuilder = require('./imagebuilder'); export import Schemas = require('./schemas'); export import AccessAnalyzer = require('./accessanalyzer'); +export import CodeGuruReviewer = require('./codegurureviewer'); +export import CodeGuruProfiler = require('./codeguruprofiler'); +export import ComputeOptimizer = require('./computeoptimizer'); +export import FraudDetector = require('./frauddetector'); +export import Kendra = require('./kendra'); +export import NetworkManager = require('./networkmanager'); +export import Outposts = require('./outposts'); +export import AugmentedAIRuntime = require('./augmentedairuntime'); diff --git a/clients/all.js b/clients/all.js index 5008856c63..f00b1c9346 100644 --- a/clients/all.js +++ b/clients/all.js @@ -207,5 +207,13 @@ module.exports = { ElasticInference: require('./elasticinference'), Imagebuilder: require('./imagebuilder'), Schemas: require('./schemas'), - AccessAnalyzer: require('./accessanalyzer') + AccessAnalyzer: require('./accessanalyzer'), + CodeGuruReviewer: require('./codegurureviewer'), + CodeGuruProfiler: require('./codeguruprofiler'), + ComputeOptimizer: require('./computeoptimizer'), + FraudDetector: require('./frauddetector'), + Kendra: require('./kendra'), + NetworkManager: require('./networkmanager'), + Outposts: require('./outposts'), + AugmentedAIRuntime: require('./augmentedairuntime') }; \ No newline at end of file diff --git a/clients/augmentedairuntime.d.ts b/clients/augmentedairuntime.d.ts new file mode 100644 index 0000000000..54206164c6 --- /dev/null +++ b/clients/augmentedairuntime.d.ts @@ -0,0 +1,263 @@ +import {Request} from '../lib/request'; +import {Response} from '../lib/response'; +import {AWSError} from '../lib/error'; +import {Service} from '../lib/service'; +import {ServiceConfigurationOptions} from '../lib/service'; +import {ConfigBase as Config} from '../lib/config'; +interface Blob {} +declare class AugmentedAIRuntime extends Service { + /** + * Constructs a service object. This object has one method for each API operation. + */ + constructor(options?: AugmentedAIRuntime.Types.ClientConfiguration) + config: Config & AugmentedAIRuntime.Types.ClientConfiguration; + /** + * Deletes the specified human loop for a flow definition. + */ + deleteHumanLoop(params: AugmentedAIRuntime.Types.DeleteHumanLoopRequest, callback?: (err: AWSError, data: AugmentedAIRuntime.Types.DeleteHumanLoopResponse) => void): Request