From e9178fb7f1c4fa8004acdca32ad102ed966108cd Mon Sep 17 00:00:00 2001 From: AwsSdkPhpAutomation Date: Mon, 25 Nov 2024 19:19:59 +0000 Subject: [PATCH] Update models for release --- .changes/3.330.1 | 17 ++ CHANGELOG.md | 6 + src/NetworkManager/NetworkManagerClient.php | 6 + src/data/directconnect/2012-10-25/api-2.json | 21 +++ .../directconnect/2012-10-25/api-2.json.php | 2 +- src/data/directconnect/2012-10-25/docs-2.json | 19 ++ .../directconnect/2012-10-25/docs-2.json.php | 2 +- src/data/networkmanager/2019-07-05/api-2.json | 129 +++++++++++++- .../networkmanager/2019-07-05/api-2.json.php | 2 +- .../networkmanager/2019-07-05/docs-2.json | 61 ++++++- .../networkmanager/2019-07-05/docs-2.json.php | 2 +- src/data/s3/2006-03-01/api-2.json | 10 ++ src/data/s3/2006-03-01/api-2.json.php | 2 +- src/data/s3/2006-03-01/docs-2.json | 6 +- src/data/s3/2006-03-01/docs-2.json.php | 2 +- src/data/s3/2006-03-01/examples-1.json | 164 +++++++++--------- src/data/s3/2006-03-01/examples-1.json.php | 2 +- 17 files changed, 359 insertions(+), 94 deletions(-) create mode 100644 .changes/3.330.1 diff --git a/.changes/3.330.1 b/.changes/3.330.1 new file mode 100644 index 0000000000..b622d2ca29 --- /dev/null +++ b/.changes/3.330.1 @@ -0,0 +1,17 @@ +[ + { + "type": "api-change", + "category": "DirectConnect", + "description": "Update DescribeDirectConnectGatewayAssociations API to return associated core network information if a Direct Connect gateway is attached to a Cloud WAN core network." + }, + { + "type": "api-change", + "category": "NetworkManager", + "description": "This release adds native Direct Connect integration on Cloud WAN enabling customers to directly attach their Direct Connect gateways to Cloud WAN without the need for an intermediate Transit Gateway." + }, + { + "type": "api-change", + "category": "S3", + "description": "Amazon Simple Storage Service \/ Features: Add support for ETag based conditional writes in PutObject and CompleteMultiPartUpload APIs to prevent unintended object modifications." + } +] diff --git a/CHANGELOG.md b/CHANGELOG.md index b18c8c11f8..393f7541f3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # CHANGELOG +## next release + +* `Aws\DirectConnect` - Update DescribeDirectConnectGatewayAssociations API to return associated core network information if a Direct Connect gateway is attached to a Cloud WAN core network. +* `Aws\NetworkManager` - This release adds native Direct Connect integration on Cloud WAN enabling customers to directly attach their Direct Connect gateways to Cloud WAN without the need for an intermediate Transit Gateway. +* `Aws\S3` - Amazon Simple Storage Service / Features: Add support for ETag based conditional writes in PutObject and CompleteMultiPartUpload APIs to prevent unintended object modifications. + ## 3.330.0 - 2024-11-22 * `Aws\NeptuneGraph` - Add 4 new APIs to support new Export features, allowing Parquet and CSV formats. Add new arguments in Import APIs to support Parquet import. Add a new query "neptune.read" to run algorithms without loading data into database diff --git a/src/NetworkManager/NetworkManagerClient.php b/src/NetworkManager/NetworkManagerClient.php index 962bb5580c..6b9c2887d0 100644 --- a/src/NetworkManager/NetworkManagerClient.php +++ b/src/NetworkManager/NetworkManagerClient.php @@ -25,6 +25,8 @@ * @method \GuzzleHttp\Promise\Promise createCoreNetworkAsync(array $args = []) * @method \Aws\Result createDevice(array $args = []) * @method \GuzzleHttp\Promise\Promise createDeviceAsync(array $args = []) + * @method \Aws\Result createDirectConnectGatewayAttachment(array $args = []) + * @method \GuzzleHttp\Promise\Promise createDirectConnectGatewayAttachmentAsync(array $args = []) * @method \Aws\Result createGlobalNetwork(array $args = []) * @method \GuzzleHttp\Promise\Promise createGlobalNetworkAsync(array $args = []) * @method \Aws\Result createLink(array $args = []) @@ -95,6 +97,8 @@ * @method \GuzzleHttp\Promise\Promise getCustomerGatewayAssociationsAsync(array $args = []) * @method \Aws\Result getDevices(array $args = []) * @method \GuzzleHttp\Promise\Promise getDevicesAsync(array $args = []) + * @method \Aws\Result getDirectConnectGatewayAttachment(array $args = []) + * @method \GuzzleHttp\Promise\Promise getDirectConnectGatewayAttachmentAsync(array $args = []) * @method \Aws\Result getLinkAssociations(array $args = []) * @method \GuzzleHttp\Promise\Promise getLinkAssociationsAsync(array $args = []) * @method \Aws\Result getLinks(array $args = []) @@ -165,6 +169,8 @@ * @method \GuzzleHttp\Promise\Promise updateCoreNetworkAsync(array $args = []) * @method \Aws\Result updateDevice(array $args = []) * @method \GuzzleHttp\Promise\Promise updateDeviceAsync(array $args = []) + * @method \Aws\Result updateDirectConnectGatewayAttachment(array $args = []) + * @method \GuzzleHttp\Promise\Promise updateDirectConnectGatewayAttachmentAsync(array $args = []) * @method \Aws\Result updateGlobalNetwork(array $args = []) * @method \GuzzleHttp\Promise\Promise updateGlobalNetworkAsync(array $args = []) * @method \Aws\Result updateLink(array $args = []) diff --git a/src/data/directconnect/2012-10-25/api-2.json b/src/data/directconnect/2012-10-25/api-2.json index d6b47158c1..41caecafe2 100644 --- a/src/data/directconnect/2012-10-25/api-2.json +++ b/src/data/directconnect/2012-10-25/api-2.json @@ -1025,6 +1025,14 @@ "connectionId":{"shape":"ConnectionId"} } }, + "AssociatedCoreNetwork":{ + "type":"structure", + "members":{ + "id":{"shape":"CoreNetworkIdentifier"}, + "ownerAccount":{"shape":"OwnerAccount"}, + "attachmentId":{"shape":"CoreNetworkAttachmentId"} + } + }, "AssociatedGateway":{ "type":"structure", "members":{ @@ -1220,6 +1228,18 @@ "connections":{"shape":"ConnectionList"} } }, + "CoreNetworkAttachmentId":{ + "type":"string", + "max":28, + "min":12, + "pattern":"^attachment-([0-9a-f]{1,17})$" + }, + "CoreNetworkIdentifier":{ + "type":"string", + "max":30, + "min":14, + "pattern":"^core-network-([0-9a-f]{1,17})$" + }, "Count":{"type":"integer"}, "CreateBGPPeerRequest":{ "type":"structure", @@ -1689,6 +1709,7 @@ "associatedGateway":{"shape":"AssociatedGateway"}, "associationId":{"shape":"DirectConnectGatewayAssociationId"}, "allowedPrefixesToDirectConnectGateway":{"shape":"RouteFilterPrefixList"}, + "associatedCoreNetwork":{"shape":"AssociatedCoreNetwork"}, "virtualGatewayId":{"shape":"VirtualGatewayId"}, "virtualGatewayRegion":{"shape":"VirtualGatewayRegion"}, "virtualGatewayOwnerAccount":{"shape":"OwnerAccount"} diff --git a/src/data/directconnect/2012-10-25/api-2.json.php b/src/data/directconnect/2012-10-25/api-2.json.php index 1bfb3c8ffb..c6eb3985f2 100644 --- a/src/data/directconnect/2012-10-25/api-2.json.php +++ b/src/data/directconnect/2012-10-25/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2012-10-25', 'endpointPrefix' => 'directconnect', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceFullName' => 'AWS Direct Connect', 'serviceId' => 'Direct Connect', 'signatureVersion' => 'v4', 'targetPrefix' => 'OvertureService', 'uid' => 'directconnect-2012-10-25', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'AcceptDirectConnectGatewayAssociationProposal' => [ 'name' => 'AcceptDirectConnectGatewayAssociationProposal', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AcceptDirectConnectGatewayAssociationProposalRequest', ], 'output' => [ 'shape' => 'AcceptDirectConnectGatewayAssociationProposalResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AllocateConnectionOnInterconnect' => [ 'name' => 'AllocateConnectionOnInterconnect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocateConnectionOnInterconnectRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], 'deprecated' => true, ], 'AllocateHostedConnection' => [ 'name' => 'AllocateHostedConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocateHostedConnectionRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AllocatePrivateVirtualInterface' => [ 'name' => 'AllocatePrivateVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocatePrivateVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'VirtualInterface', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AllocatePublicVirtualInterface' => [ 'name' => 'AllocatePublicVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocatePublicVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'VirtualInterface', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AllocateTransitVirtualInterface' => [ 'name' => 'AllocateTransitVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocateTransitVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'AllocateTransitVirtualInterfaceResult', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AssociateConnectionWithLag' => [ 'name' => 'AssociateConnectionWithLag', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateConnectionWithLagRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AssociateHostedConnection' => [ 'name' => 'AssociateHostedConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateHostedConnectionRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AssociateMacSecKey' => [ 'name' => 'AssociateMacSecKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateMacSecKeyRequest', ], 'output' => [ 'shape' => 'AssociateMacSecKeyResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AssociateVirtualInterface' => [ 'name' => 'AssociateVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'VirtualInterface', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'ConfirmConnection' => [ 'name' => 'ConfirmConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmConnectionRequest', ], 'output' => [ 'shape' => 'ConfirmConnectionResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'ConfirmCustomerAgreement' => [ 'name' => 'ConfirmCustomerAgreement', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmCustomerAgreementRequest', ], 'output' => [ 'shape' => 'ConfirmCustomerAgreementResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'ConfirmPrivateVirtualInterface' => [ 'name' => 'ConfirmPrivateVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmPrivateVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'ConfirmPrivateVirtualInterfaceResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'ConfirmPublicVirtualInterface' => [ 'name' => 'ConfirmPublicVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmPublicVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'ConfirmPublicVirtualInterfaceResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'ConfirmTransitVirtualInterface' => [ 'name' => 'ConfirmTransitVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmTransitVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'ConfirmTransitVirtualInterfaceResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateBGPPeer' => [ 'name' => 'CreateBGPPeer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBGPPeerRequest', ], 'output' => [ 'shape' => 'CreateBGPPeerResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateConnection' => [ 'name' => 'CreateConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateConnectionRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateDirectConnectGateway' => [ 'name' => 'CreateDirectConnectGateway', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDirectConnectGatewayRequest', ], 'output' => [ 'shape' => 'CreateDirectConnectGatewayResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateDirectConnectGatewayAssociation' => [ 'name' => 'CreateDirectConnectGatewayAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDirectConnectGatewayAssociationRequest', ], 'output' => [ 'shape' => 'CreateDirectConnectGatewayAssociationResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateDirectConnectGatewayAssociationProposal' => [ 'name' => 'CreateDirectConnectGatewayAssociationProposal', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDirectConnectGatewayAssociationProposalRequest', ], 'output' => [ 'shape' => 'CreateDirectConnectGatewayAssociationProposalResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateInterconnect' => [ 'name' => 'CreateInterconnect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInterconnectRequest', ], 'output' => [ 'shape' => 'Interconnect', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateLag' => [ 'name' => 'CreateLag', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLagRequest', ], 'output' => [ 'shape' => 'Lag', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreatePrivateVirtualInterface' => [ 'name' => 'CreatePrivateVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePrivateVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'VirtualInterface', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreatePublicVirtualInterface' => [ 'name' => 'CreatePublicVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePublicVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'VirtualInterface', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateTransitVirtualInterface' => [ 'name' => 'CreateTransitVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTransitVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'CreateTransitVirtualInterfaceResult', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteBGPPeer' => [ 'name' => 'DeleteBGPPeer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteBGPPeerRequest', ], 'output' => [ 'shape' => 'DeleteBGPPeerResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteConnection' => [ 'name' => 'DeleteConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConnectionRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteDirectConnectGateway' => [ 'name' => 'DeleteDirectConnectGateway', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDirectConnectGatewayRequest', ], 'output' => [ 'shape' => 'DeleteDirectConnectGatewayResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteDirectConnectGatewayAssociation' => [ 'name' => 'DeleteDirectConnectGatewayAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDirectConnectGatewayAssociationRequest', ], 'output' => [ 'shape' => 'DeleteDirectConnectGatewayAssociationResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteDirectConnectGatewayAssociationProposal' => [ 'name' => 'DeleteDirectConnectGatewayAssociationProposal', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDirectConnectGatewayAssociationProposalRequest', ], 'output' => [ 'shape' => 'DeleteDirectConnectGatewayAssociationProposalResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteInterconnect' => [ 'name' => 'DeleteInterconnect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInterconnectRequest', ], 'output' => [ 'shape' => 'DeleteInterconnectResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteLag' => [ 'name' => 'DeleteLag', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteLagRequest', ], 'output' => [ 'shape' => 'Lag', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteVirtualInterface' => [ 'name' => 'DeleteVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'DeleteVirtualInterfaceResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeConnectionLoa' => [ 'name' => 'DescribeConnectionLoa', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConnectionLoaRequest', ], 'output' => [ 'shape' => 'DescribeConnectionLoaResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], 'deprecated' => true, ], 'DescribeConnections' => [ 'name' => 'DescribeConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConnectionsRequest', ], 'output' => [ 'shape' => 'Connections', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeConnectionsOnInterconnect' => [ 'name' => 'DescribeConnectionsOnInterconnect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConnectionsOnInterconnectRequest', ], 'output' => [ 'shape' => 'Connections', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], 'deprecated' => true, ], 'DescribeCustomerMetadata' => [ 'name' => 'DescribeCustomerMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'output' => [ 'shape' => 'DescribeCustomerMetadataResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeDirectConnectGatewayAssociationProposals' => [ 'name' => 'DescribeDirectConnectGatewayAssociationProposals', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDirectConnectGatewayAssociationProposalsRequest', ], 'output' => [ 'shape' => 'DescribeDirectConnectGatewayAssociationProposalsResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeDirectConnectGatewayAssociations' => [ 'name' => 'DescribeDirectConnectGatewayAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDirectConnectGatewayAssociationsRequest', ], 'output' => [ 'shape' => 'DescribeDirectConnectGatewayAssociationsResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeDirectConnectGatewayAttachments' => [ 'name' => 'DescribeDirectConnectGatewayAttachments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDirectConnectGatewayAttachmentsRequest', ], 'output' => [ 'shape' => 'DescribeDirectConnectGatewayAttachmentsResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeDirectConnectGateways' => [ 'name' => 'DescribeDirectConnectGateways', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDirectConnectGatewaysRequest', ], 'output' => [ 'shape' => 'DescribeDirectConnectGatewaysResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeHostedConnections' => [ 'name' => 'DescribeHostedConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHostedConnectionsRequest', ], 'output' => [ 'shape' => 'Connections', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeInterconnectLoa' => [ 'name' => 'DescribeInterconnectLoa', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInterconnectLoaRequest', ], 'output' => [ 'shape' => 'DescribeInterconnectLoaResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], 'deprecated' => true, ], 'DescribeInterconnects' => [ 'name' => 'DescribeInterconnects', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInterconnectsRequest', ], 'output' => [ 'shape' => 'Interconnects', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeLags' => [ 'name' => 'DescribeLags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLagsRequest', ], 'output' => [ 'shape' => 'Lags', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeLoa' => [ 'name' => 'DescribeLoa', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLoaRequest', ], 'output' => [ 'shape' => 'Loa', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeLocations' => [ 'name' => 'DescribeLocations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'output' => [ 'shape' => 'Locations', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeRouterConfiguration' => [ 'name' => 'DescribeRouterConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRouterConfigurationRequest', ], 'output' => [ 'shape' => 'DescribeRouterConfigurationResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeTags' => [ 'name' => 'DescribeTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTagsRequest', ], 'output' => [ 'shape' => 'DescribeTagsResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeVirtualGateways' => [ 'name' => 'DescribeVirtualGateways', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'output' => [ 'shape' => 'VirtualGateways', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeVirtualInterfaces' => [ 'name' => 'DescribeVirtualInterfaces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeVirtualInterfacesRequest', ], 'output' => [ 'shape' => 'VirtualInterfaces', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DisassociateConnectionFromLag' => [ 'name' => 'DisassociateConnectionFromLag', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateConnectionFromLagRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DisassociateMacSecKey' => [ 'name' => 'DisassociateMacSecKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateMacSecKeyRequest', ], 'output' => [ 'shape' => 'DisassociateMacSecKeyResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'ListVirtualInterfaceTestHistory' => [ 'name' => 'ListVirtualInterfaceTestHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListVirtualInterfaceTestHistoryRequest', ], 'output' => [ 'shape' => 'ListVirtualInterfaceTestHistoryResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'StartBgpFailoverTest' => [ 'name' => 'StartBgpFailoverTest', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartBgpFailoverTestRequest', ], 'output' => [ 'shape' => 'StartBgpFailoverTestResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'StopBgpFailoverTest' => [ 'name' => 'StopBgpFailoverTest', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopBgpFailoverTestRequest', ], 'output' => [ 'shape' => 'StopBgpFailoverTestResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'UpdateConnection' => [ 'name' => 'UpdateConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateConnectionRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'UpdateDirectConnectGateway' => [ 'name' => 'UpdateDirectConnectGateway', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDirectConnectGatewayRequest', ], 'output' => [ 'shape' => 'UpdateDirectConnectGatewayResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'UpdateDirectConnectGatewayAssociation' => [ 'name' => 'UpdateDirectConnectGatewayAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDirectConnectGatewayAssociationRequest', ], 'output' => [ 'shape' => 'UpdateDirectConnectGatewayAssociationResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'UpdateLag' => [ 'name' => 'UpdateLag', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateLagRequest', ], 'output' => [ 'shape' => 'Lag', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'UpdateVirtualInterfaceAttributes' => [ 'name' => 'UpdateVirtualInterfaceAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateVirtualInterfaceAttributesRequest', ], 'output' => [ 'shape' => 'VirtualInterface', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], ], 'shapes' => [ 'ASN' => [ 'type' => 'integer', ], 'AcceptDirectConnectGatewayAssociationProposalRequest' => [ 'type' => 'structure', 'required' => [ 'directConnectGatewayId', 'proposalId', 'associatedGatewayOwnerAccount', ], 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'proposalId' => [ 'shape' => 'DirectConnectGatewayAssociationProposalId', ], 'associatedGatewayOwnerAccount' => [ 'shape' => 'OwnerAccount', ], 'overrideAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], ], ], 'AcceptDirectConnectGatewayAssociationProposalResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociation' => [ 'shape' => 'DirectConnectGatewayAssociation', ], ], ], 'AddressFamily' => [ 'type' => 'string', 'enum' => [ 'ipv4', 'ipv6', ], ], 'AgreementList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerAgreement', ], ], 'AgreementName' => [ 'type' => 'string', 'max' => 100, ], 'AllocateConnectionOnInterconnectRequest' => [ 'type' => 'structure', 'required' => [ 'bandwidth', 'connectionName', 'ownerAccount', 'interconnectId', 'vlan', ], 'members' => [ 'bandwidth' => [ 'shape' => 'Bandwidth', ], 'connectionName' => [ 'shape' => 'ConnectionName', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'interconnectId' => [ 'shape' => 'InterconnectId', ], 'vlan' => [ 'shape' => 'VLAN', ], ], ], 'AllocateHostedConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'ownerAccount', 'bandwidth', 'connectionName', 'vlan', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'bandwidth' => [ 'shape' => 'Bandwidth', ], 'connectionName' => [ 'shape' => 'ConnectionName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'AllocatePrivateVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'ownerAccount', 'newPrivateVirtualInterfaceAllocation', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'newPrivateVirtualInterfaceAllocation' => [ 'shape' => 'NewPrivateVirtualInterfaceAllocation', ], ], ], 'AllocatePublicVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'ownerAccount', 'newPublicVirtualInterfaceAllocation', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'newPublicVirtualInterfaceAllocation' => [ 'shape' => 'NewPublicVirtualInterfaceAllocation', ], ], ], 'AllocateTransitVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'ownerAccount', 'newTransitVirtualInterfaceAllocation', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'newTransitVirtualInterfaceAllocation' => [ 'shape' => 'NewTransitVirtualInterfaceAllocation', ], ], ], 'AllocateTransitVirtualInterfaceResult' => [ 'type' => 'structure', 'members' => [ 'virtualInterface' => [ 'shape' => 'VirtualInterface', ], ], ], 'AmazonAddress' => [ 'type' => 'string', ], 'AssociateConnectionWithLagRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'lagId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'lagId' => [ 'shape' => 'LagId', ], ], ], 'AssociateHostedConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'parentConnectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'parentConnectionId' => [ 'shape' => 'ConnectionId', ], ], ], 'AssociateMacSecKeyRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'secretARN' => [ 'shape' => 'SecretARN', ], 'ckn' => [ 'shape' => 'Ckn', ], 'cak' => [ 'shape' => 'Cak', ], ], ], 'AssociateMacSecKeyResponse' => [ 'type' => 'structure', 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'macSecKeys' => [ 'shape' => 'MacSecKeyList', ], ], ], 'AssociateVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', 'connectionId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'connectionId' => [ 'shape' => 'ConnectionId', ], ], ], 'AssociatedGateway' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'GatewayIdentifier', ], 'type' => [ 'shape' => 'GatewayType', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'region' => [ 'shape' => 'Region', ], ], ], 'AssociatedGatewayId' => [ 'type' => 'string', ], 'AvailableMacSecPortSpeeds' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortSpeed', ], ], 'AvailablePortSpeeds' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortSpeed', ], ], 'AwsDevice' => [ 'type' => 'string', 'deprecated' => true, ], 'AwsDeviceV2' => [ 'type' => 'string', ], 'AwsLogicalDeviceId' => [ 'type' => 'string', ], 'BGPAuthKey' => [ 'type' => 'string', ], 'BGPPeer' => [ 'type' => 'structure', 'members' => [ 'bgpPeerId' => [ 'shape' => 'BGPPeerId', ], 'asn' => [ 'shape' => 'ASN', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'bgpPeerState' => [ 'shape' => 'BGPPeerState', ], 'bgpStatus' => [ 'shape' => 'BGPStatus', ], 'awsDeviceV2' => [ 'shape' => 'AwsDeviceV2', ], 'awsLogicalDeviceId' => [ 'shape' => 'AwsLogicalDeviceId', ], ], ], 'BGPPeerId' => [ 'type' => 'string', ], 'BGPPeerIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BGPPeerId', ], ], 'BGPPeerList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BGPPeer', ], ], 'BGPPeerState' => [ 'type' => 'string', 'enum' => [ 'verifying', 'pending', 'available', 'deleting', 'deleted', ], ], 'BGPStatus' => [ 'type' => 'string', 'enum' => [ 'up', 'down', 'unknown', ], ], 'Bandwidth' => [ 'type' => 'string', ], 'BooleanFlag' => [ 'type' => 'boolean', ], 'CIDR' => [ 'type' => 'string', ], 'Cak' => [ 'type' => 'string', ], 'Ckn' => [ 'type' => 'string', ], 'ConfirmConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], ], ], 'ConfirmConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'connectionState' => [ 'shape' => 'ConnectionState', ], ], ], 'ConfirmCustomerAgreementRequest' => [ 'type' => 'structure', 'members' => [ 'agreementName' => [ 'shape' => 'AgreementName', ], ], ], 'ConfirmCustomerAgreementResponse' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'Status', ], ], ], 'ConfirmPrivateVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], ], ], 'ConfirmPrivateVirtualInterfaceResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceState' => [ 'shape' => 'VirtualInterfaceState', ], ], ], 'ConfirmPublicVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], ], ], 'ConfirmPublicVirtualInterfaceResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceState' => [ 'shape' => 'VirtualInterfaceState', ], ], ], 'ConfirmTransitVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', 'directConnectGatewayId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], ], ], 'ConfirmTransitVirtualInterfaceResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceState' => [ 'shape' => 'VirtualInterfaceState', ], ], ], 'Connection' => [ 'type' => 'structure', 'members' => [ 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'connectionId' => [ 'shape' => 'ConnectionId', ], 'connectionName' => [ 'shape' => 'ConnectionName', ], 'connectionState' => [ 'shape' => 'ConnectionState', ], 'region' => [ 'shape' => 'Region', ], 'location' => [ 'shape' => 'LocationCode', ], 'bandwidth' => [ 'shape' => 'Bandwidth', ], 'vlan' => [ 'shape' => 'VLAN', ], 'partnerName' => [ 'shape' => 'PartnerName', ], 'loaIssueTime' => [ 'shape' => 'LoaIssueTime', ], 'lagId' => [ 'shape' => 'LagId', ], 'awsDevice' => [ 'shape' => 'AwsDevice', ], 'jumboFrameCapable' => [ 'shape' => 'JumboFrameCapable', ], 'awsDeviceV2' => [ 'shape' => 'AwsDeviceV2', ], 'awsLogicalDeviceId' => [ 'shape' => 'AwsLogicalDeviceId', ], 'hasLogicalRedundancy' => [ 'shape' => 'HasLogicalRedundancy', ], 'tags' => [ 'shape' => 'TagList', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'macSecCapable' => [ 'shape' => 'MacSecCapable', ], 'portEncryptionStatus' => [ 'shape' => 'PortEncryptionStatus', ], 'encryptionMode' => [ 'shape' => 'EncryptionMode', ], 'macSecKeys' => [ 'shape' => 'MacSecKeyList', ], ], ], 'ConnectionId' => [ 'type' => 'string', ], 'ConnectionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Connection', ], ], 'ConnectionName' => [ 'type' => 'string', ], 'ConnectionState' => [ 'type' => 'string', 'enum' => [ 'ordering', 'requested', 'pending', 'available', 'down', 'deleting', 'deleted', 'rejected', 'unknown', ], ], 'Connections' => [ 'type' => 'structure', 'members' => [ 'connections' => [ 'shape' => 'ConnectionList', ], ], ], 'Count' => [ 'type' => 'integer', ], 'CreateBGPPeerRequest' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'newBGPPeer' => [ 'shape' => 'NewBGPPeer', ], ], ], 'CreateBGPPeerResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterface' => [ 'shape' => 'VirtualInterface', ], ], ], 'CreateConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'location', 'bandwidth', 'connectionName', ], 'members' => [ 'location' => [ 'shape' => 'LocationCode', ], 'bandwidth' => [ 'shape' => 'Bandwidth', ], 'connectionName' => [ 'shape' => 'ConnectionName', ], 'lagId' => [ 'shape' => 'LagId', ], 'tags' => [ 'shape' => 'TagList', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'requestMACSec' => [ 'shape' => 'RequestMACSec', ], ], ], 'CreateDirectConnectGatewayAssociationProposalRequest' => [ 'type' => 'structure', 'required' => [ 'directConnectGatewayId', 'directConnectGatewayOwnerAccount', 'gatewayId', ], 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'directConnectGatewayOwnerAccount' => [ 'shape' => 'OwnerAccount', ], 'gatewayId' => [ 'shape' => 'GatewayIdToAssociate', ], 'addAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], 'removeAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], ], ], 'CreateDirectConnectGatewayAssociationProposalResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociationProposal' => [ 'shape' => 'DirectConnectGatewayAssociationProposal', ], ], ], 'CreateDirectConnectGatewayAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'directConnectGatewayId', ], 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'gatewayId' => [ 'shape' => 'GatewayIdToAssociate', ], 'addAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], ], ], 'CreateDirectConnectGatewayAssociationResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociation' => [ 'shape' => 'DirectConnectGatewayAssociation', ], ], ], 'CreateDirectConnectGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'directConnectGatewayName', ], 'members' => [ 'directConnectGatewayName' => [ 'shape' => 'DirectConnectGatewayName', ], 'amazonSideAsn' => [ 'shape' => 'LongAsn', ], ], ], 'CreateDirectConnectGatewayResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGateway' => [ 'shape' => 'DirectConnectGateway', ], ], ], 'CreateInterconnectRequest' => [ 'type' => 'structure', 'required' => [ 'interconnectName', 'bandwidth', 'location', ], 'members' => [ 'interconnectName' => [ 'shape' => 'InterconnectName', ], 'bandwidth' => [ 'shape' => 'Bandwidth', ], 'location' => [ 'shape' => 'LocationCode', ], 'lagId' => [ 'shape' => 'LagId', ], 'tags' => [ 'shape' => 'TagList', ], 'providerName' => [ 'shape' => 'ProviderName', ], ], ], 'CreateLagRequest' => [ 'type' => 'structure', 'required' => [ 'numberOfConnections', 'location', 'connectionsBandwidth', 'lagName', ], 'members' => [ 'numberOfConnections' => [ 'shape' => 'Count', ], 'location' => [ 'shape' => 'LocationCode', ], 'connectionsBandwidth' => [ 'shape' => 'Bandwidth', ], 'lagName' => [ 'shape' => 'LagName', ], 'connectionId' => [ 'shape' => 'ConnectionId', ], 'tags' => [ 'shape' => 'TagList', ], 'childConnectionTags' => [ 'shape' => 'TagList', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'requestMACSec' => [ 'shape' => 'RequestMACSec', ], ], ], 'CreatePrivateVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'newPrivateVirtualInterface', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'newPrivateVirtualInterface' => [ 'shape' => 'NewPrivateVirtualInterface', ], ], ], 'CreatePublicVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'newPublicVirtualInterface', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'newPublicVirtualInterface' => [ 'shape' => 'NewPublicVirtualInterface', ], ], ], 'CreateTransitVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'newTransitVirtualInterface', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'newTransitVirtualInterface' => [ 'shape' => 'NewTransitVirtualInterface', ], ], ], 'CreateTransitVirtualInterfaceResult' => [ 'type' => 'structure', 'members' => [ 'virtualInterface' => [ 'shape' => 'VirtualInterface', ], ], ], 'CustomerAddress' => [ 'type' => 'string', ], 'CustomerAgreement' => [ 'type' => 'structure', 'members' => [ 'agreementName' => [ 'shape' => 'AgreementName', ], 'status' => [ 'shape' => 'Status', ], ], ], 'DeleteBGPPeerRequest' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'asn' => [ 'shape' => 'ASN', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'bgpPeerId' => [ 'shape' => 'BGPPeerId', ], ], ], 'DeleteBGPPeerResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterface' => [ 'shape' => 'VirtualInterface', ], ], ], 'DeleteConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], ], ], 'DeleteDirectConnectGatewayAssociationProposalRequest' => [ 'type' => 'structure', 'required' => [ 'proposalId', ], 'members' => [ 'proposalId' => [ 'shape' => 'DirectConnectGatewayAssociationProposalId', ], ], ], 'DeleteDirectConnectGatewayAssociationProposalResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociationProposal' => [ 'shape' => 'DirectConnectGatewayAssociationProposal', ], ], ], 'DeleteDirectConnectGatewayAssociationRequest' => [ 'type' => 'structure', 'members' => [ 'associationId' => [ 'shape' => 'DirectConnectGatewayAssociationId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], ], ], 'DeleteDirectConnectGatewayAssociationResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociation' => [ 'shape' => 'DirectConnectGatewayAssociation', ], ], ], 'DeleteDirectConnectGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'directConnectGatewayId', ], 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], ], ], 'DeleteDirectConnectGatewayResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGateway' => [ 'shape' => 'DirectConnectGateway', ], ], ], 'DeleteInterconnectRequest' => [ 'type' => 'structure', 'required' => [ 'interconnectId', ], 'members' => [ 'interconnectId' => [ 'shape' => 'InterconnectId', ], ], ], 'DeleteInterconnectResponse' => [ 'type' => 'structure', 'members' => [ 'interconnectState' => [ 'shape' => 'InterconnectState', ], ], ], 'DeleteLagRequest' => [ 'type' => 'structure', 'required' => [ 'lagId', ], 'members' => [ 'lagId' => [ 'shape' => 'LagId', ], ], ], 'DeleteVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], ], ], 'DeleteVirtualInterfaceResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceState' => [ 'shape' => 'VirtualInterfaceState', ], ], ], 'DescribeConnectionLoaRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'loaContentType' => [ 'shape' => 'LoaContentType', ], ], ], 'DescribeConnectionLoaResponse' => [ 'type' => 'structure', 'members' => [ 'loa' => [ 'shape' => 'Loa', ], ], ], 'DescribeConnectionsOnInterconnectRequest' => [ 'type' => 'structure', 'required' => [ 'interconnectId', ], 'members' => [ 'interconnectId' => [ 'shape' => 'InterconnectId', ], ], ], 'DescribeConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], ], ], 'DescribeCustomerMetadataResponse' => [ 'type' => 'structure', 'members' => [ 'agreements' => [ 'shape' => 'AgreementList', ], 'nniPartnerType' => [ 'shape' => 'NniPartnerType', ], ], ], 'DescribeDirectConnectGatewayAssociationProposalsRequest' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'proposalId' => [ 'shape' => 'DirectConnectGatewayAssociationProposalId', ], 'associatedGatewayId' => [ 'shape' => 'AssociatedGatewayId', ], 'maxResults' => [ 'shape' => 'MaxResultSetSize', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeDirectConnectGatewayAssociationProposalsResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociationProposals' => [ 'shape' => 'DirectConnectGatewayAssociationProposalList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeDirectConnectGatewayAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'associationId' => [ 'shape' => 'DirectConnectGatewayAssociationId', ], 'associatedGatewayId' => [ 'shape' => 'AssociatedGatewayId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'maxResults' => [ 'shape' => 'MaxResultSetSize', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], ], ], 'DescribeDirectConnectGatewayAssociationsResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociations' => [ 'shape' => 'DirectConnectGatewayAssociationList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeDirectConnectGatewayAttachmentsRequest' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'maxResults' => [ 'shape' => 'MaxResultSetSize', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeDirectConnectGatewayAttachmentsResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAttachments' => [ 'shape' => 'DirectConnectGatewayAttachmentList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeDirectConnectGatewaysRequest' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'maxResults' => [ 'shape' => 'MaxResultSetSize', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeDirectConnectGatewaysResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGateways' => [ 'shape' => 'DirectConnectGatewayList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeHostedConnectionsRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], ], ], 'DescribeInterconnectLoaRequest' => [ 'type' => 'structure', 'required' => [ 'interconnectId', ], 'members' => [ 'interconnectId' => [ 'shape' => 'InterconnectId', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'loaContentType' => [ 'shape' => 'LoaContentType', ], ], ], 'DescribeInterconnectLoaResponse' => [ 'type' => 'structure', 'members' => [ 'loa' => [ 'shape' => 'Loa', ], ], ], 'DescribeInterconnectsRequest' => [ 'type' => 'structure', 'members' => [ 'interconnectId' => [ 'shape' => 'InterconnectId', ], ], ], 'DescribeLagsRequest' => [ 'type' => 'structure', 'members' => [ 'lagId' => [ 'shape' => 'LagId', ], ], ], 'DescribeLoaRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'loaContentType' => [ 'shape' => 'LoaContentType', ], ], ], 'DescribeRouterConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'routerTypeIdentifier' => [ 'shape' => 'RouterTypeIdentifier', ], ], ], 'DescribeRouterConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'customerRouterConfig' => [ 'shape' => 'RouterConfig', ], 'router' => [ 'shape' => 'RouterType', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], ], ], 'DescribeTagsRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArns', ], 'members' => [ 'resourceArns' => [ 'shape' => 'ResourceArnList', ], ], ], 'DescribeTagsResponse' => [ 'type' => 'structure', 'members' => [ 'resourceTags' => [ 'shape' => 'ResourceTagList', ], ], ], 'DescribeVirtualInterfacesRequest' => [ 'type' => 'structure', 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], ], ], 'DirectConnectClientException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'DirectConnectGateway' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'directConnectGatewayName' => [ 'shape' => 'DirectConnectGatewayName', ], 'amazonSideAsn' => [ 'shape' => 'LongAsn', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'directConnectGatewayState' => [ 'shape' => 'DirectConnectGatewayState', ], 'stateChangeError' => [ 'shape' => 'StateChangeError', ], ], ], 'DirectConnectGatewayAssociation' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'directConnectGatewayOwnerAccount' => [ 'shape' => 'OwnerAccount', ], 'associationState' => [ 'shape' => 'DirectConnectGatewayAssociationState', ], 'stateChangeError' => [ 'shape' => 'StateChangeError', ], 'associatedGateway' => [ 'shape' => 'AssociatedGateway', ], 'associationId' => [ 'shape' => 'DirectConnectGatewayAssociationId', ], 'allowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], 'virtualGatewayRegion' => [ 'shape' => 'VirtualGatewayRegion', ], 'virtualGatewayOwnerAccount' => [ 'shape' => 'OwnerAccount', ], ], ], 'DirectConnectGatewayAssociationId' => [ 'type' => 'string', ], 'DirectConnectGatewayAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DirectConnectGatewayAssociation', ], ], 'DirectConnectGatewayAssociationProposal' => [ 'type' => 'structure', 'members' => [ 'proposalId' => [ 'shape' => 'DirectConnectGatewayAssociationProposalId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'directConnectGatewayOwnerAccount' => [ 'shape' => 'OwnerAccount', ], 'proposalState' => [ 'shape' => 'DirectConnectGatewayAssociationProposalState', ], 'associatedGateway' => [ 'shape' => 'AssociatedGateway', ], 'existingAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], 'requestedAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], ], ], 'DirectConnectGatewayAssociationProposalId' => [ 'type' => 'string', ], 'DirectConnectGatewayAssociationProposalList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DirectConnectGatewayAssociationProposal', ], ], 'DirectConnectGatewayAssociationProposalState' => [ 'type' => 'string', 'enum' => [ 'requested', 'accepted', 'deleted', ], ], 'DirectConnectGatewayAssociationState' => [ 'type' => 'string', 'enum' => [ 'associating', 'associated', 'disassociating', 'disassociated', 'updating', ], ], 'DirectConnectGatewayAttachment' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'virtualInterfaceRegion' => [ 'shape' => 'VirtualInterfaceRegion', ], 'virtualInterfaceOwnerAccount' => [ 'shape' => 'OwnerAccount', ], 'attachmentState' => [ 'shape' => 'DirectConnectGatewayAttachmentState', ], 'attachmentType' => [ 'shape' => 'DirectConnectGatewayAttachmentType', ], 'stateChangeError' => [ 'shape' => 'StateChangeError', ], ], ], 'DirectConnectGatewayAttachmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DirectConnectGatewayAttachment', ], ], 'DirectConnectGatewayAttachmentState' => [ 'type' => 'string', 'enum' => [ 'attaching', 'attached', 'detaching', 'detached', ], ], 'DirectConnectGatewayAttachmentType' => [ 'type' => 'string', 'enum' => [ 'TransitVirtualInterface', 'PrivateVirtualInterface', ], ], 'DirectConnectGatewayId' => [ 'type' => 'string', ], 'DirectConnectGatewayList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DirectConnectGateway', ], ], 'DirectConnectGatewayName' => [ 'type' => 'string', ], 'DirectConnectGatewayState' => [ 'type' => 'string', 'enum' => [ 'pending', 'available', 'deleting', 'deleted', ], ], 'DirectConnectServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'DisassociateConnectionFromLagRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'lagId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'lagId' => [ 'shape' => 'LagId', ], ], ], 'DisassociateMacSecKeyRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'secretARN', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'secretARN' => [ 'shape' => 'SecretARN', ], ], ], 'DisassociateMacSecKeyResponse' => [ 'type' => 'structure', 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'macSecKeys' => [ 'shape' => 'MacSecKeyList', ], ], ], 'DuplicateTagKeysException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'EnableSiteLink' => [ 'type' => 'boolean', ], 'EncryptionMode' => [ 'type' => 'string', ], 'EndTime' => [ 'type' => 'timestamp', ], 'ErrorMessage' => [ 'type' => 'string', ], 'FailureTestHistoryStatus' => [ 'type' => 'string', ], 'GatewayIdToAssociate' => [ 'type' => 'string', ], 'GatewayIdentifier' => [ 'type' => 'string', ], 'GatewayType' => [ 'type' => 'string', 'enum' => [ 'virtualPrivateGateway', 'transitGateway', ], ], 'HasLogicalRedundancy' => [ 'type' => 'string', 'enum' => [ 'unknown', 'yes', 'no', ], ], 'Interconnect' => [ 'type' => 'structure', 'members' => [ 'interconnectId' => [ 'shape' => 'InterconnectId', ], 'interconnectName' => [ 'shape' => 'InterconnectName', ], 'interconnectState' => [ 'shape' => 'InterconnectState', ], 'region' => [ 'shape' => 'Region', ], 'location' => [ 'shape' => 'LocationCode', ], 'bandwidth' => [ 'shape' => 'Bandwidth', ], 'loaIssueTime' => [ 'shape' => 'LoaIssueTime', ], 'lagId' => [ 'shape' => 'LagId', ], 'awsDevice' => [ 'shape' => 'AwsDevice', ], 'jumboFrameCapable' => [ 'shape' => 'JumboFrameCapable', ], 'awsDeviceV2' => [ 'shape' => 'AwsDeviceV2', ], 'awsLogicalDeviceId' => [ 'shape' => 'AwsLogicalDeviceId', ], 'hasLogicalRedundancy' => [ 'shape' => 'HasLogicalRedundancy', ], 'tags' => [ 'shape' => 'TagList', ], 'providerName' => [ 'shape' => 'ProviderName', ], ], ], 'InterconnectId' => [ 'type' => 'string', ], 'InterconnectList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Interconnect', ], ], 'InterconnectName' => [ 'type' => 'string', ], 'InterconnectState' => [ 'type' => 'string', 'enum' => [ 'requested', 'pending', 'available', 'down', 'deleting', 'deleted', 'unknown', ], ], 'Interconnects' => [ 'type' => 'structure', 'members' => [ 'interconnects' => [ 'shape' => 'InterconnectList', ], ], ], 'JumboFrameCapable' => [ 'type' => 'boolean', ], 'Lag' => [ 'type' => 'structure', 'members' => [ 'connectionsBandwidth' => [ 'shape' => 'Bandwidth', ], 'numberOfConnections' => [ 'shape' => 'Count', ], 'lagId' => [ 'shape' => 'LagId', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'lagName' => [ 'shape' => 'LagName', ], 'lagState' => [ 'shape' => 'LagState', ], 'location' => [ 'shape' => 'LocationCode', ], 'region' => [ 'shape' => 'Region', ], 'minimumLinks' => [ 'shape' => 'Count', ], 'awsDevice' => [ 'shape' => 'AwsDevice', ], 'awsDeviceV2' => [ 'shape' => 'AwsDeviceV2', ], 'awsLogicalDeviceId' => [ 'shape' => 'AwsLogicalDeviceId', ], 'connections' => [ 'shape' => 'ConnectionList', ], 'allowsHostedConnections' => [ 'shape' => 'BooleanFlag', ], 'jumboFrameCapable' => [ 'shape' => 'JumboFrameCapable', ], 'hasLogicalRedundancy' => [ 'shape' => 'HasLogicalRedundancy', ], 'tags' => [ 'shape' => 'TagList', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'macSecCapable' => [ 'shape' => 'MacSecCapable', ], 'encryptionMode' => [ 'shape' => 'EncryptionMode', ], 'macSecKeys' => [ 'shape' => 'MacSecKeyList', ], ], ], 'LagId' => [ 'type' => 'string', ], 'LagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Lag', ], ], 'LagName' => [ 'type' => 'string', ], 'LagState' => [ 'type' => 'string', 'enum' => [ 'requested', 'pending', 'available', 'down', 'deleting', 'deleted', 'unknown', ], ], 'Lags' => [ 'type' => 'structure', 'members' => [ 'lags' => [ 'shape' => 'LagList', ], ], ], 'ListVirtualInterfaceTestHistoryRequest' => [ 'type' => 'structure', 'members' => [ 'testId' => [ 'shape' => 'TestId', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'bgpPeers' => [ 'shape' => 'BGPPeerIdList', ], 'status' => [ 'shape' => 'FailureTestHistoryStatus', ], 'maxResults' => [ 'shape' => 'MaxResultSetSize', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListVirtualInterfaceTestHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceTestHistory' => [ 'shape' => 'VirtualInterfaceTestHistoryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'Loa' => [ 'type' => 'structure', 'members' => [ 'loaContent' => [ 'shape' => 'LoaContent', ], 'loaContentType' => [ 'shape' => 'LoaContentType', ], ], ], 'LoaContent' => [ 'type' => 'blob', ], 'LoaContentType' => [ 'type' => 'string', 'enum' => [ 'application/pdf', ], ], 'LoaIssueTime' => [ 'type' => 'timestamp', ], 'Location' => [ 'type' => 'structure', 'members' => [ 'locationCode' => [ 'shape' => 'LocationCode', ], 'locationName' => [ 'shape' => 'LocationName', ], 'region' => [ 'shape' => 'Region', ], 'availablePortSpeeds' => [ 'shape' => 'AvailablePortSpeeds', ], 'availableProviders' => [ 'shape' => 'ProviderList', ], 'availableMacSecPortSpeeds' => [ 'shape' => 'AvailableMacSecPortSpeeds', ], ], ], 'LocationCode' => [ 'type' => 'string', ], 'LocationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Location', ], ], 'LocationName' => [ 'type' => 'string', ], 'Locations' => [ 'type' => 'structure', 'members' => [ 'locations' => [ 'shape' => 'LocationList', ], ], ], 'LongAsn' => [ 'type' => 'long', ], 'MTU' => [ 'type' => 'integer', ], 'MacSecCapable' => [ 'type' => 'boolean', ], 'MacSecKey' => [ 'type' => 'structure', 'members' => [ 'secretARN' => [ 'shape' => 'SecretARN', ], 'ckn' => [ 'shape' => 'Ckn', ], 'state' => [ 'shape' => 'State', ], 'startOn' => [ 'shape' => 'StartOnDate', ], ], ], 'MacSecKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MacSecKey', ], ], 'MaxResultSetSize' => [ 'type' => 'integer', 'box' => true, ], 'NewBGPPeer' => [ 'type' => 'structure', 'members' => [ 'asn' => [ 'shape' => 'ASN', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], ], ], 'NewPrivateVirtualInterface' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceName', 'vlan', 'asn', ], 'members' => [ 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'mtu' => [ 'shape' => 'MTU', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'tags' => [ 'shape' => 'TagList', ], 'enableSiteLink' => [ 'shape' => 'EnableSiteLink', ], ], ], 'NewPrivateVirtualInterfaceAllocation' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceName', 'vlan', 'asn', ], 'members' => [ 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'mtu' => [ 'shape' => 'MTU', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'NewPublicVirtualInterface' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceName', 'vlan', 'asn', ], 'members' => [ 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'routeFilterPrefixes' => [ 'shape' => 'RouteFilterPrefixList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'NewPublicVirtualInterfaceAllocation' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceName', 'vlan', 'asn', ], 'members' => [ 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'routeFilterPrefixes' => [ 'shape' => 'RouteFilterPrefixList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'NewTransitVirtualInterface' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'mtu' => [ 'shape' => 'MTU', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'tags' => [ 'shape' => 'TagList', ], 'enableSiteLink' => [ 'shape' => 'EnableSiteLink', ], ], ], 'NewTransitVirtualInterfaceAllocation' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'mtu' => [ 'shape' => 'MTU', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'NniPartnerType' => [ 'type' => 'string', 'enum' => [ 'v1', 'v2', 'nonPartner', ], ], 'OwnerAccount' => [ 'type' => 'string', ], 'PaginationToken' => [ 'type' => 'string', ], 'PartnerName' => [ 'type' => 'string', ], 'Platform' => [ 'type' => 'string', ], 'PortEncryptionStatus' => [ 'type' => 'string', ], 'PortSpeed' => [ 'type' => 'string', ], 'ProviderList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProviderName', ], ], 'ProviderName' => [ 'type' => 'string', ], 'Region' => [ 'type' => 'string', ], 'RequestMACSec' => [ 'type' => 'boolean', ], 'ResourceArn' => [ 'type' => 'string', ], 'ResourceArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceArn', ], ], 'ResourceTag' => [ 'type' => 'structure', 'members' => [ 'resourceArn' => [ 'shape' => 'ResourceArn', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'ResourceTagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceTag', ], ], 'RouteFilterPrefix' => [ 'type' => 'structure', 'members' => [ 'cidr' => [ 'shape' => 'CIDR', ], ], ], 'RouteFilterPrefixList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RouteFilterPrefix', ], ], 'RouterConfig' => [ 'type' => 'string', ], 'RouterType' => [ 'type' => 'structure', 'members' => [ 'vendor' => [ 'shape' => 'Vendor', ], 'platform' => [ 'shape' => 'Platform', ], 'software' => [ 'shape' => 'Software', ], 'xsltTemplateName' => [ 'shape' => 'XsltTemplateName', ], 'xsltTemplateNameForMacSec' => [ 'shape' => 'XsltTemplateNameForMacSec', ], 'routerTypeIdentifier' => [ 'shape' => 'RouterTypeIdentifier', ], ], ], 'RouterTypeIdentifier' => [ 'type' => 'string', ], 'SecretARN' => [ 'type' => 'string', ], 'SiteLinkEnabled' => [ 'type' => 'boolean', ], 'Software' => [ 'type' => 'string', ], 'StartBgpFailoverTestRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'bgpPeers' => [ 'shape' => 'BGPPeerIdList', ], 'testDurationInMinutes' => [ 'shape' => 'TestDuration', ], ], ], 'StartBgpFailoverTestResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceTest' => [ 'shape' => 'VirtualInterfaceTestHistory', ], ], ], 'StartOnDate' => [ 'type' => 'string', ], 'StartTime' => [ 'type' => 'timestamp', ], 'State' => [ 'type' => 'string', ], 'StateChangeError' => [ 'type' => 'string', ], 'Status' => [ 'type' => 'string', 'max' => 30, ], 'StopBgpFailoverTestRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], ], ], 'StopBgpFailoverTestResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceTest' => [ 'shape' => 'VirtualInterfaceTestHistory', ], ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'key', ], 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ResourceArn', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TestDuration' => [ 'type' => 'integer', 'box' => true, ], 'TestId' => [ 'type' => 'string', ], 'TooManyTagsException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ResourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'connectionName' => [ 'shape' => 'ConnectionName', ], 'encryptionMode' => [ 'shape' => 'EncryptionMode', ], ], ], 'UpdateDirectConnectGatewayAssociationRequest' => [ 'type' => 'structure', 'members' => [ 'associationId' => [ 'shape' => 'DirectConnectGatewayAssociationId', ], 'addAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], 'removeAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], ], ], 'UpdateDirectConnectGatewayAssociationResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociation' => [ 'shape' => 'DirectConnectGatewayAssociation', ], ], ], 'UpdateDirectConnectGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'directConnectGatewayId', 'newDirectConnectGatewayName', ], 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'newDirectConnectGatewayName' => [ 'shape' => 'DirectConnectGatewayName', ], ], ], 'UpdateDirectConnectGatewayResponse' => [ 'type' => 'structure', 'members' => [ 'directConnectGateway' => [ 'shape' => 'DirectConnectGateway', ], ], ], 'UpdateLagRequest' => [ 'type' => 'structure', 'required' => [ 'lagId', ], 'members' => [ 'lagId' => [ 'shape' => 'LagId', ], 'lagName' => [ 'shape' => 'LagName', ], 'minimumLinks' => [ 'shape' => 'Count', ], 'encryptionMode' => [ 'shape' => 'EncryptionMode', ], ], ], 'UpdateVirtualInterfaceAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'mtu' => [ 'shape' => 'MTU', ], 'enableSiteLink' => [ 'shape' => 'EnableSiteLink', ], 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], ], ], 'VLAN' => [ 'type' => 'integer', ], 'Vendor' => [ 'type' => 'string', ], 'VirtualGateway' => [ 'type' => 'structure', 'members' => [ 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], 'virtualGatewayState' => [ 'shape' => 'VirtualGatewayState', ], ], ], 'VirtualGatewayId' => [ 'type' => 'string', ], 'VirtualGatewayList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VirtualGateway', ], ], 'VirtualGatewayRegion' => [ 'type' => 'string', 'deprecated' => true, ], 'VirtualGatewayState' => [ 'type' => 'string', ], 'VirtualGateways' => [ 'type' => 'structure', 'members' => [ 'virtualGateways' => [ 'shape' => 'VirtualGatewayList', ], ], ], 'VirtualInterface' => [ 'type' => 'structure', 'members' => [ 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'location' => [ 'shape' => 'LocationCode', ], 'connectionId' => [ 'shape' => 'ConnectionId', ], 'virtualInterfaceType' => [ 'shape' => 'VirtualInterfaceType', ], 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'amazonSideAsn' => [ 'shape' => 'LongAsn', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'virtualInterfaceState' => [ 'shape' => 'VirtualInterfaceState', ], 'customerRouterConfig' => [ 'shape' => 'RouterConfig', ], 'mtu' => [ 'shape' => 'MTU', ], 'jumboFrameCapable' => [ 'shape' => 'JumboFrameCapable', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'routeFilterPrefixes' => [ 'shape' => 'RouteFilterPrefixList', ], 'bgpPeers' => [ 'shape' => 'BGPPeerList', ], 'region' => [ 'shape' => 'Region', ], 'awsDeviceV2' => [ 'shape' => 'AwsDeviceV2', ], 'awsLogicalDeviceId' => [ 'shape' => 'AwsLogicalDeviceId', ], 'tags' => [ 'shape' => 'TagList', ], 'siteLinkEnabled' => [ 'shape' => 'SiteLinkEnabled', ], ], ], 'VirtualInterfaceId' => [ 'type' => 'string', ], 'VirtualInterfaceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VirtualInterface', ], ], 'VirtualInterfaceName' => [ 'type' => 'string', ], 'VirtualInterfaceRegion' => [ 'type' => 'string', ], 'VirtualInterfaceState' => [ 'type' => 'string', 'enum' => [ 'confirming', 'verifying', 'pending', 'available', 'down', 'deleting', 'deleted', 'rejected', 'unknown', ], ], 'VirtualInterfaceTestHistory' => [ 'type' => 'structure', 'members' => [ 'testId' => [ 'shape' => 'TestId', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'bgpPeers' => [ 'shape' => 'BGPPeerIdList', ], 'status' => [ 'shape' => 'FailureTestHistoryStatus', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'testDurationInMinutes' => [ 'shape' => 'TestDuration', ], 'startTime' => [ 'shape' => 'StartTime', ], 'endTime' => [ 'shape' => 'EndTime', ], ], ], 'VirtualInterfaceTestHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VirtualInterfaceTestHistory', ], ], 'VirtualInterfaceType' => [ 'type' => 'string', ], 'VirtualInterfaces' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaces' => [ 'shape' => 'VirtualInterfaceList', ], ], ], 'XsltTemplateName' => [ 'type' => 'string', ], 'XsltTemplateNameForMacSec' => [ 'type' => 'string', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2012-10-25', 'endpointPrefix' => 'directconnect', 'jsonVersion' => '1.1', 'protocol' => 'json', 'protocols' => [ 'json', ], 'serviceFullName' => 'AWS Direct Connect', 'serviceId' => 'Direct Connect', 'signatureVersion' => 'v4', 'targetPrefix' => 'OvertureService', 'uid' => 'directconnect-2012-10-25', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'AcceptDirectConnectGatewayAssociationProposal' => [ 'name' => 'AcceptDirectConnectGatewayAssociationProposal', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AcceptDirectConnectGatewayAssociationProposalRequest', ], 'output' => [ 'shape' => 'AcceptDirectConnectGatewayAssociationProposalResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AllocateConnectionOnInterconnect' => [ 'name' => 'AllocateConnectionOnInterconnect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocateConnectionOnInterconnectRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], 'deprecated' => true, ], 'AllocateHostedConnection' => [ 'name' => 'AllocateHostedConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocateHostedConnectionRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AllocatePrivateVirtualInterface' => [ 'name' => 'AllocatePrivateVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocatePrivateVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'VirtualInterface', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AllocatePublicVirtualInterface' => [ 'name' => 'AllocatePublicVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocatePublicVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'VirtualInterface', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AllocateTransitVirtualInterface' => [ 'name' => 'AllocateTransitVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AllocateTransitVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'AllocateTransitVirtualInterfaceResult', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AssociateConnectionWithLag' => [ 'name' => 'AssociateConnectionWithLag', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateConnectionWithLagRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AssociateHostedConnection' => [ 'name' => 'AssociateHostedConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateHostedConnectionRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AssociateMacSecKey' => [ 'name' => 'AssociateMacSecKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateMacSecKeyRequest', ], 'output' => [ 'shape' => 'AssociateMacSecKeyResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'AssociateVirtualInterface' => [ 'name' => 'AssociateVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'AssociateVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'VirtualInterface', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'ConfirmConnection' => [ 'name' => 'ConfirmConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmConnectionRequest', ], 'output' => [ 'shape' => 'ConfirmConnectionResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'ConfirmCustomerAgreement' => [ 'name' => 'ConfirmCustomerAgreement', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmCustomerAgreementRequest', ], 'output' => [ 'shape' => 'ConfirmCustomerAgreementResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'ConfirmPrivateVirtualInterface' => [ 'name' => 'ConfirmPrivateVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmPrivateVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'ConfirmPrivateVirtualInterfaceResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'ConfirmPublicVirtualInterface' => [ 'name' => 'ConfirmPublicVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmPublicVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'ConfirmPublicVirtualInterfaceResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'ConfirmTransitVirtualInterface' => [ 'name' => 'ConfirmTransitVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ConfirmTransitVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'ConfirmTransitVirtualInterfaceResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateBGPPeer' => [ 'name' => 'CreateBGPPeer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateBGPPeerRequest', ], 'output' => [ 'shape' => 'CreateBGPPeerResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateConnection' => [ 'name' => 'CreateConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateConnectionRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateDirectConnectGateway' => [ 'name' => 'CreateDirectConnectGateway', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDirectConnectGatewayRequest', ], 'output' => [ 'shape' => 'CreateDirectConnectGatewayResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateDirectConnectGatewayAssociation' => [ 'name' => 'CreateDirectConnectGatewayAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDirectConnectGatewayAssociationRequest', ], 'output' => [ 'shape' => 'CreateDirectConnectGatewayAssociationResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateDirectConnectGatewayAssociationProposal' => [ 'name' => 'CreateDirectConnectGatewayAssociationProposal', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateDirectConnectGatewayAssociationProposalRequest', ], 'output' => [ 'shape' => 'CreateDirectConnectGatewayAssociationProposalResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateInterconnect' => [ 'name' => 'CreateInterconnect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateInterconnectRequest', ], 'output' => [ 'shape' => 'Interconnect', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateLag' => [ 'name' => 'CreateLag', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateLagRequest', ], 'output' => [ 'shape' => 'Lag', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreatePrivateVirtualInterface' => [ 'name' => 'CreatePrivateVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePrivateVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'VirtualInterface', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreatePublicVirtualInterface' => [ 'name' => 'CreatePublicVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreatePublicVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'VirtualInterface', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'CreateTransitVirtualInterface' => [ 'name' => 'CreateTransitVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'CreateTransitVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'CreateTransitVirtualInterfaceResult', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteBGPPeer' => [ 'name' => 'DeleteBGPPeer', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteBGPPeerRequest', ], 'output' => [ 'shape' => 'DeleteBGPPeerResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteConnection' => [ 'name' => 'DeleteConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteConnectionRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteDirectConnectGateway' => [ 'name' => 'DeleteDirectConnectGateway', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDirectConnectGatewayRequest', ], 'output' => [ 'shape' => 'DeleteDirectConnectGatewayResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteDirectConnectGatewayAssociation' => [ 'name' => 'DeleteDirectConnectGatewayAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDirectConnectGatewayAssociationRequest', ], 'output' => [ 'shape' => 'DeleteDirectConnectGatewayAssociationResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteDirectConnectGatewayAssociationProposal' => [ 'name' => 'DeleteDirectConnectGatewayAssociationProposal', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteDirectConnectGatewayAssociationProposalRequest', ], 'output' => [ 'shape' => 'DeleteDirectConnectGatewayAssociationProposalResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteInterconnect' => [ 'name' => 'DeleteInterconnect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteInterconnectRequest', ], 'output' => [ 'shape' => 'DeleteInterconnectResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteLag' => [ 'name' => 'DeleteLag', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteLagRequest', ], 'output' => [ 'shape' => 'Lag', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DeleteVirtualInterface' => [ 'name' => 'DeleteVirtualInterface', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DeleteVirtualInterfaceRequest', ], 'output' => [ 'shape' => 'DeleteVirtualInterfaceResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeConnectionLoa' => [ 'name' => 'DescribeConnectionLoa', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConnectionLoaRequest', ], 'output' => [ 'shape' => 'DescribeConnectionLoaResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], 'deprecated' => true, ], 'DescribeConnections' => [ 'name' => 'DescribeConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConnectionsRequest', ], 'output' => [ 'shape' => 'Connections', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeConnectionsOnInterconnect' => [ 'name' => 'DescribeConnectionsOnInterconnect', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeConnectionsOnInterconnectRequest', ], 'output' => [ 'shape' => 'Connections', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], 'deprecated' => true, ], 'DescribeCustomerMetadata' => [ 'name' => 'DescribeCustomerMetadata', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'output' => [ 'shape' => 'DescribeCustomerMetadataResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeDirectConnectGatewayAssociationProposals' => [ 'name' => 'DescribeDirectConnectGatewayAssociationProposals', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDirectConnectGatewayAssociationProposalsRequest', ], 'output' => [ 'shape' => 'DescribeDirectConnectGatewayAssociationProposalsResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeDirectConnectGatewayAssociations' => [ 'name' => 'DescribeDirectConnectGatewayAssociations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDirectConnectGatewayAssociationsRequest', ], 'output' => [ 'shape' => 'DescribeDirectConnectGatewayAssociationsResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeDirectConnectGatewayAttachments' => [ 'name' => 'DescribeDirectConnectGatewayAttachments', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDirectConnectGatewayAttachmentsRequest', ], 'output' => [ 'shape' => 'DescribeDirectConnectGatewayAttachmentsResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeDirectConnectGateways' => [ 'name' => 'DescribeDirectConnectGateways', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeDirectConnectGatewaysRequest', ], 'output' => [ 'shape' => 'DescribeDirectConnectGatewaysResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeHostedConnections' => [ 'name' => 'DescribeHostedConnections', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeHostedConnectionsRequest', ], 'output' => [ 'shape' => 'Connections', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeInterconnectLoa' => [ 'name' => 'DescribeInterconnectLoa', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInterconnectLoaRequest', ], 'output' => [ 'shape' => 'DescribeInterconnectLoaResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], 'deprecated' => true, ], 'DescribeInterconnects' => [ 'name' => 'DescribeInterconnects', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeInterconnectsRequest', ], 'output' => [ 'shape' => 'Interconnects', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeLags' => [ 'name' => 'DescribeLags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLagsRequest', ], 'output' => [ 'shape' => 'Lags', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeLoa' => [ 'name' => 'DescribeLoa', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeLoaRequest', ], 'output' => [ 'shape' => 'Loa', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeLocations' => [ 'name' => 'DescribeLocations', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'output' => [ 'shape' => 'Locations', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeRouterConfiguration' => [ 'name' => 'DescribeRouterConfiguration', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeRouterConfigurationRequest', ], 'output' => [ 'shape' => 'DescribeRouterConfigurationResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeTags' => [ 'name' => 'DescribeTags', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeTagsRequest', ], 'output' => [ 'shape' => 'DescribeTagsResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeVirtualGateways' => [ 'name' => 'DescribeVirtualGateways', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'output' => [ 'shape' => 'VirtualGateways', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DescribeVirtualInterfaces' => [ 'name' => 'DescribeVirtualInterfaces', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DescribeVirtualInterfacesRequest', ], 'output' => [ 'shape' => 'VirtualInterfaces', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DisassociateConnectionFromLag' => [ 'name' => 'DisassociateConnectionFromLag', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateConnectionFromLagRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'DisassociateMacSecKey' => [ 'name' => 'DisassociateMacSecKey', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'DisassociateMacSecKeyRequest', ], 'output' => [ 'shape' => 'DisassociateMacSecKeyResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'ListVirtualInterfaceTestHistory' => [ 'name' => 'ListVirtualInterfaceTestHistory', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListVirtualInterfaceTestHistoryRequest', ], 'output' => [ 'shape' => 'ListVirtualInterfaceTestHistoryResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'StartBgpFailoverTest' => [ 'name' => 'StartBgpFailoverTest', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StartBgpFailoverTestRequest', ], 'output' => [ 'shape' => 'StartBgpFailoverTestResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'StopBgpFailoverTest' => [ 'name' => 'StopBgpFailoverTest', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'StopBgpFailoverTestRequest', ], 'output' => [ 'shape' => 'StopBgpFailoverTestResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'TagResource' => [ 'name' => 'TagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'TagResourceRequest', ], 'output' => [ 'shape' => 'TagResourceResponse', ], 'errors' => [ [ 'shape' => 'DuplicateTagKeysException', ], [ 'shape' => 'TooManyTagsException', ], [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'UntagResource' => [ 'name' => 'UntagResource', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UntagResourceRequest', ], 'output' => [ 'shape' => 'UntagResourceResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'UpdateConnection' => [ 'name' => 'UpdateConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateConnectionRequest', ], 'output' => [ 'shape' => 'Connection', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'UpdateDirectConnectGateway' => [ 'name' => 'UpdateDirectConnectGateway', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDirectConnectGatewayRequest', ], 'output' => [ 'shape' => 'UpdateDirectConnectGatewayResponse', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'UpdateDirectConnectGatewayAssociation' => [ 'name' => 'UpdateDirectConnectGatewayAssociation', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateDirectConnectGatewayAssociationRequest', ], 'output' => [ 'shape' => 'UpdateDirectConnectGatewayAssociationResult', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'UpdateLag' => [ 'name' => 'UpdateLag', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateLagRequest', ], 'output' => [ 'shape' => 'Lag', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], 'UpdateVirtualInterfaceAttributes' => [ 'name' => 'UpdateVirtualInterfaceAttributes', 'http' => [ 'method' => 'POST', 'requestUri' => '/', ], 'input' => [ 'shape' => 'UpdateVirtualInterfaceAttributesRequest', ], 'output' => [ 'shape' => 'VirtualInterface', ], 'errors' => [ [ 'shape' => 'DirectConnectServerException', ], [ 'shape' => 'DirectConnectClientException', ], ], ], ], 'shapes' => [ 'ASN' => [ 'type' => 'integer', ], 'AcceptDirectConnectGatewayAssociationProposalRequest' => [ 'type' => 'structure', 'required' => [ 'directConnectGatewayId', 'proposalId', 'associatedGatewayOwnerAccount', ], 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'proposalId' => [ 'shape' => 'DirectConnectGatewayAssociationProposalId', ], 'associatedGatewayOwnerAccount' => [ 'shape' => 'OwnerAccount', ], 'overrideAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], ], ], 'AcceptDirectConnectGatewayAssociationProposalResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociation' => [ 'shape' => 'DirectConnectGatewayAssociation', ], ], ], 'AddressFamily' => [ 'type' => 'string', 'enum' => [ 'ipv4', 'ipv6', ], ], 'AgreementList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerAgreement', ], ], 'AgreementName' => [ 'type' => 'string', 'max' => 100, ], 'AllocateConnectionOnInterconnectRequest' => [ 'type' => 'structure', 'required' => [ 'bandwidth', 'connectionName', 'ownerAccount', 'interconnectId', 'vlan', ], 'members' => [ 'bandwidth' => [ 'shape' => 'Bandwidth', ], 'connectionName' => [ 'shape' => 'ConnectionName', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'interconnectId' => [ 'shape' => 'InterconnectId', ], 'vlan' => [ 'shape' => 'VLAN', ], ], ], 'AllocateHostedConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'ownerAccount', 'bandwidth', 'connectionName', 'vlan', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'bandwidth' => [ 'shape' => 'Bandwidth', ], 'connectionName' => [ 'shape' => 'ConnectionName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'AllocatePrivateVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'ownerAccount', 'newPrivateVirtualInterfaceAllocation', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'newPrivateVirtualInterfaceAllocation' => [ 'shape' => 'NewPrivateVirtualInterfaceAllocation', ], ], ], 'AllocatePublicVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'ownerAccount', 'newPublicVirtualInterfaceAllocation', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'newPublicVirtualInterfaceAllocation' => [ 'shape' => 'NewPublicVirtualInterfaceAllocation', ], ], ], 'AllocateTransitVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'ownerAccount', 'newTransitVirtualInterfaceAllocation', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'newTransitVirtualInterfaceAllocation' => [ 'shape' => 'NewTransitVirtualInterfaceAllocation', ], ], ], 'AllocateTransitVirtualInterfaceResult' => [ 'type' => 'structure', 'members' => [ 'virtualInterface' => [ 'shape' => 'VirtualInterface', ], ], ], 'AmazonAddress' => [ 'type' => 'string', ], 'AssociateConnectionWithLagRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'lagId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'lagId' => [ 'shape' => 'LagId', ], ], ], 'AssociateHostedConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'parentConnectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'parentConnectionId' => [ 'shape' => 'ConnectionId', ], ], ], 'AssociateMacSecKeyRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'secretARN' => [ 'shape' => 'SecretARN', ], 'ckn' => [ 'shape' => 'Ckn', ], 'cak' => [ 'shape' => 'Cak', ], ], ], 'AssociateMacSecKeyResponse' => [ 'type' => 'structure', 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'macSecKeys' => [ 'shape' => 'MacSecKeyList', ], ], ], 'AssociateVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', 'connectionId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'connectionId' => [ 'shape' => 'ConnectionId', ], ], ], 'AssociatedCoreNetwork' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'CoreNetworkIdentifier', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'attachmentId' => [ 'shape' => 'CoreNetworkAttachmentId', ], ], ], 'AssociatedGateway' => [ 'type' => 'structure', 'members' => [ 'id' => [ 'shape' => 'GatewayIdentifier', ], 'type' => [ 'shape' => 'GatewayType', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'region' => [ 'shape' => 'Region', ], ], ], 'AssociatedGatewayId' => [ 'type' => 'string', ], 'AvailableMacSecPortSpeeds' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortSpeed', ], ], 'AvailablePortSpeeds' => [ 'type' => 'list', 'member' => [ 'shape' => 'PortSpeed', ], ], 'AwsDevice' => [ 'type' => 'string', 'deprecated' => true, ], 'AwsDeviceV2' => [ 'type' => 'string', ], 'AwsLogicalDeviceId' => [ 'type' => 'string', ], 'BGPAuthKey' => [ 'type' => 'string', ], 'BGPPeer' => [ 'type' => 'structure', 'members' => [ 'bgpPeerId' => [ 'shape' => 'BGPPeerId', ], 'asn' => [ 'shape' => 'ASN', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'bgpPeerState' => [ 'shape' => 'BGPPeerState', ], 'bgpStatus' => [ 'shape' => 'BGPStatus', ], 'awsDeviceV2' => [ 'shape' => 'AwsDeviceV2', ], 'awsLogicalDeviceId' => [ 'shape' => 'AwsLogicalDeviceId', ], ], ], 'BGPPeerId' => [ 'type' => 'string', ], 'BGPPeerIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BGPPeerId', ], ], 'BGPPeerList' => [ 'type' => 'list', 'member' => [ 'shape' => 'BGPPeer', ], ], 'BGPPeerState' => [ 'type' => 'string', 'enum' => [ 'verifying', 'pending', 'available', 'deleting', 'deleted', ], ], 'BGPStatus' => [ 'type' => 'string', 'enum' => [ 'up', 'down', 'unknown', ], ], 'Bandwidth' => [ 'type' => 'string', ], 'BooleanFlag' => [ 'type' => 'boolean', ], 'CIDR' => [ 'type' => 'string', ], 'Cak' => [ 'type' => 'string', ], 'Ckn' => [ 'type' => 'string', ], 'ConfirmConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], ], ], 'ConfirmConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'connectionState' => [ 'shape' => 'ConnectionState', ], ], ], 'ConfirmCustomerAgreementRequest' => [ 'type' => 'structure', 'members' => [ 'agreementName' => [ 'shape' => 'AgreementName', ], ], ], 'ConfirmCustomerAgreementResponse' => [ 'type' => 'structure', 'members' => [ 'status' => [ 'shape' => 'Status', ], ], ], 'ConfirmPrivateVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], ], ], 'ConfirmPrivateVirtualInterfaceResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceState' => [ 'shape' => 'VirtualInterfaceState', ], ], ], 'ConfirmPublicVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], ], ], 'ConfirmPublicVirtualInterfaceResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceState' => [ 'shape' => 'VirtualInterfaceState', ], ], ], 'ConfirmTransitVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', 'directConnectGatewayId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], ], ], 'ConfirmTransitVirtualInterfaceResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceState' => [ 'shape' => 'VirtualInterfaceState', ], ], ], 'Connection' => [ 'type' => 'structure', 'members' => [ 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'connectionId' => [ 'shape' => 'ConnectionId', ], 'connectionName' => [ 'shape' => 'ConnectionName', ], 'connectionState' => [ 'shape' => 'ConnectionState', ], 'region' => [ 'shape' => 'Region', ], 'location' => [ 'shape' => 'LocationCode', ], 'bandwidth' => [ 'shape' => 'Bandwidth', ], 'vlan' => [ 'shape' => 'VLAN', ], 'partnerName' => [ 'shape' => 'PartnerName', ], 'loaIssueTime' => [ 'shape' => 'LoaIssueTime', ], 'lagId' => [ 'shape' => 'LagId', ], 'awsDevice' => [ 'shape' => 'AwsDevice', ], 'jumboFrameCapable' => [ 'shape' => 'JumboFrameCapable', ], 'awsDeviceV2' => [ 'shape' => 'AwsDeviceV2', ], 'awsLogicalDeviceId' => [ 'shape' => 'AwsLogicalDeviceId', ], 'hasLogicalRedundancy' => [ 'shape' => 'HasLogicalRedundancy', ], 'tags' => [ 'shape' => 'TagList', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'macSecCapable' => [ 'shape' => 'MacSecCapable', ], 'portEncryptionStatus' => [ 'shape' => 'PortEncryptionStatus', ], 'encryptionMode' => [ 'shape' => 'EncryptionMode', ], 'macSecKeys' => [ 'shape' => 'MacSecKeyList', ], ], ], 'ConnectionId' => [ 'type' => 'string', ], 'ConnectionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Connection', ], ], 'ConnectionName' => [ 'type' => 'string', ], 'ConnectionState' => [ 'type' => 'string', 'enum' => [ 'ordering', 'requested', 'pending', 'available', 'down', 'deleting', 'deleted', 'rejected', 'unknown', ], ], 'Connections' => [ 'type' => 'structure', 'members' => [ 'connections' => [ 'shape' => 'ConnectionList', ], ], ], 'CoreNetworkAttachmentId' => [ 'type' => 'string', 'max' => 28, 'min' => 12, 'pattern' => '^attachment-([0-9a-f]{1,17})$', ], 'CoreNetworkIdentifier' => [ 'type' => 'string', 'max' => 30, 'min' => 14, 'pattern' => '^core-network-([0-9a-f]{1,17})$', ], 'Count' => [ 'type' => 'integer', ], 'CreateBGPPeerRequest' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'newBGPPeer' => [ 'shape' => 'NewBGPPeer', ], ], ], 'CreateBGPPeerResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterface' => [ 'shape' => 'VirtualInterface', ], ], ], 'CreateConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'location', 'bandwidth', 'connectionName', ], 'members' => [ 'location' => [ 'shape' => 'LocationCode', ], 'bandwidth' => [ 'shape' => 'Bandwidth', ], 'connectionName' => [ 'shape' => 'ConnectionName', ], 'lagId' => [ 'shape' => 'LagId', ], 'tags' => [ 'shape' => 'TagList', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'requestMACSec' => [ 'shape' => 'RequestMACSec', ], ], ], 'CreateDirectConnectGatewayAssociationProposalRequest' => [ 'type' => 'structure', 'required' => [ 'directConnectGatewayId', 'directConnectGatewayOwnerAccount', 'gatewayId', ], 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'directConnectGatewayOwnerAccount' => [ 'shape' => 'OwnerAccount', ], 'gatewayId' => [ 'shape' => 'GatewayIdToAssociate', ], 'addAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], 'removeAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], ], ], 'CreateDirectConnectGatewayAssociationProposalResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociationProposal' => [ 'shape' => 'DirectConnectGatewayAssociationProposal', ], ], ], 'CreateDirectConnectGatewayAssociationRequest' => [ 'type' => 'structure', 'required' => [ 'directConnectGatewayId', ], 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'gatewayId' => [ 'shape' => 'GatewayIdToAssociate', ], 'addAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], ], ], 'CreateDirectConnectGatewayAssociationResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociation' => [ 'shape' => 'DirectConnectGatewayAssociation', ], ], ], 'CreateDirectConnectGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'directConnectGatewayName', ], 'members' => [ 'directConnectGatewayName' => [ 'shape' => 'DirectConnectGatewayName', ], 'amazonSideAsn' => [ 'shape' => 'LongAsn', ], ], ], 'CreateDirectConnectGatewayResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGateway' => [ 'shape' => 'DirectConnectGateway', ], ], ], 'CreateInterconnectRequest' => [ 'type' => 'structure', 'required' => [ 'interconnectName', 'bandwidth', 'location', ], 'members' => [ 'interconnectName' => [ 'shape' => 'InterconnectName', ], 'bandwidth' => [ 'shape' => 'Bandwidth', ], 'location' => [ 'shape' => 'LocationCode', ], 'lagId' => [ 'shape' => 'LagId', ], 'tags' => [ 'shape' => 'TagList', ], 'providerName' => [ 'shape' => 'ProviderName', ], ], ], 'CreateLagRequest' => [ 'type' => 'structure', 'required' => [ 'numberOfConnections', 'location', 'connectionsBandwidth', 'lagName', ], 'members' => [ 'numberOfConnections' => [ 'shape' => 'Count', ], 'location' => [ 'shape' => 'LocationCode', ], 'connectionsBandwidth' => [ 'shape' => 'Bandwidth', ], 'lagName' => [ 'shape' => 'LagName', ], 'connectionId' => [ 'shape' => 'ConnectionId', ], 'tags' => [ 'shape' => 'TagList', ], 'childConnectionTags' => [ 'shape' => 'TagList', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'requestMACSec' => [ 'shape' => 'RequestMACSec', ], ], ], 'CreatePrivateVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'newPrivateVirtualInterface', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'newPrivateVirtualInterface' => [ 'shape' => 'NewPrivateVirtualInterface', ], ], ], 'CreatePublicVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'newPublicVirtualInterface', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'newPublicVirtualInterface' => [ 'shape' => 'NewPublicVirtualInterface', ], ], ], 'CreateTransitVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'newTransitVirtualInterface', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'newTransitVirtualInterface' => [ 'shape' => 'NewTransitVirtualInterface', ], ], ], 'CreateTransitVirtualInterfaceResult' => [ 'type' => 'structure', 'members' => [ 'virtualInterface' => [ 'shape' => 'VirtualInterface', ], ], ], 'CustomerAddress' => [ 'type' => 'string', ], 'CustomerAgreement' => [ 'type' => 'structure', 'members' => [ 'agreementName' => [ 'shape' => 'AgreementName', ], 'status' => [ 'shape' => 'Status', ], ], ], 'DeleteBGPPeerRequest' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'asn' => [ 'shape' => 'ASN', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'bgpPeerId' => [ 'shape' => 'BGPPeerId', ], ], ], 'DeleteBGPPeerResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterface' => [ 'shape' => 'VirtualInterface', ], ], ], 'DeleteConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], ], ], 'DeleteDirectConnectGatewayAssociationProposalRequest' => [ 'type' => 'structure', 'required' => [ 'proposalId', ], 'members' => [ 'proposalId' => [ 'shape' => 'DirectConnectGatewayAssociationProposalId', ], ], ], 'DeleteDirectConnectGatewayAssociationProposalResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociationProposal' => [ 'shape' => 'DirectConnectGatewayAssociationProposal', ], ], ], 'DeleteDirectConnectGatewayAssociationRequest' => [ 'type' => 'structure', 'members' => [ 'associationId' => [ 'shape' => 'DirectConnectGatewayAssociationId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], ], ], 'DeleteDirectConnectGatewayAssociationResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociation' => [ 'shape' => 'DirectConnectGatewayAssociation', ], ], ], 'DeleteDirectConnectGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'directConnectGatewayId', ], 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], ], ], 'DeleteDirectConnectGatewayResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGateway' => [ 'shape' => 'DirectConnectGateway', ], ], ], 'DeleteInterconnectRequest' => [ 'type' => 'structure', 'required' => [ 'interconnectId', ], 'members' => [ 'interconnectId' => [ 'shape' => 'InterconnectId', ], ], ], 'DeleteInterconnectResponse' => [ 'type' => 'structure', 'members' => [ 'interconnectState' => [ 'shape' => 'InterconnectState', ], ], ], 'DeleteLagRequest' => [ 'type' => 'structure', 'required' => [ 'lagId', ], 'members' => [ 'lagId' => [ 'shape' => 'LagId', ], ], ], 'DeleteVirtualInterfaceRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], ], ], 'DeleteVirtualInterfaceResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceState' => [ 'shape' => 'VirtualInterfaceState', ], ], ], 'DescribeConnectionLoaRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'loaContentType' => [ 'shape' => 'LoaContentType', ], ], ], 'DescribeConnectionLoaResponse' => [ 'type' => 'structure', 'members' => [ 'loa' => [ 'shape' => 'Loa', ], ], ], 'DescribeConnectionsOnInterconnectRequest' => [ 'type' => 'structure', 'required' => [ 'interconnectId', ], 'members' => [ 'interconnectId' => [ 'shape' => 'InterconnectId', ], ], ], 'DescribeConnectionsRequest' => [ 'type' => 'structure', 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], ], ], 'DescribeCustomerMetadataResponse' => [ 'type' => 'structure', 'members' => [ 'agreements' => [ 'shape' => 'AgreementList', ], 'nniPartnerType' => [ 'shape' => 'NniPartnerType', ], ], ], 'DescribeDirectConnectGatewayAssociationProposalsRequest' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'proposalId' => [ 'shape' => 'DirectConnectGatewayAssociationProposalId', ], 'associatedGatewayId' => [ 'shape' => 'AssociatedGatewayId', ], 'maxResults' => [ 'shape' => 'MaxResultSetSize', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeDirectConnectGatewayAssociationProposalsResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociationProposals' => [ 'shape' => 'DirectConnectGatewayAssociationProposalList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeDirectConnectGatewayAssociationsRequest' => [ 'type' => 'structure', 'members' => [ 'associationId' => [ 'shape' => 'DirectConnectGatewayAssociationId', ], 'associatedGatewayId' => [ 'shape' => 'AssociatedGatewayId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'maxResults' => [ 'shape' => 'MaxResultSetSize', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], ], ], 'DescribeDirectConnectGatewayAssociationsResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociations' => [ 'shape' => 'DirectConnectGatewayAssociationList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeDirectConnectGatewayAttachmentsRequest' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'maxResults' => [ 'shape' => 'MaxResultSetSize', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeDirectConnectGatewayAttachmentsResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAttachments' => [ 'shape' => 'DirectConnectGatewayAttachmentList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeDirectConnectGatewaysRequest' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'maxResults' => [ 'shape' => 'MaxResultSetSize', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeDirectConnectGatewaysResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGateways' => [ 'shape' => 'DirectConnectGatewayList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'DescribeHostedConnectionsRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], ], ], 'DescribeInterconnectLoaRequest' => [ 'type' => 'structure', 'required' => [ 'interconnectId', ], 'members' => [ 'interconnectId' => [ 'shape' => 'InterconnectId', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'loaContentType' => [ 'shape' => 'LoaContentType', ], ], ], 'DescribeInterconnectLoaResponse' => [ 'type' => 'structure', 'members' => [ 'loa' => [ 'shape' => 'Loa', ], ], ], 'DescribeInterconnectsRequest' => [ 'type' => 'structure', 'members' => [ 'interconnectId' => [ 'shape' => 'InterconnectId', ], ], ], 'DescribeLagsRequest' => [ 'type' => 'structure', 'members' => [ 'lagId' => [ 'shape' => 'LagId', ], ], ], 'DescribeLoaRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'loaContentType' => [ 'shape' => 'LoaContentType', ], ], ], 'DescribeRouterConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'routerTypeIdentifier' => [ 'shape' => 'RouterTypeIdentifier', ], ], ], 'DescribeRouterConfigurationResponse' => [ 'type' => 'structure', 'members' => [ 'customerRouterConfig' => [ 'shape' => 'RouterConfig', ], 'router' => [ 'shape' => 'RouterType', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], ], ], 'DescribeTagsRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArns', ], 'members' => [ 'resourceArns' => [ 'shape' => 'ResourceArnList', ], ], ], 'DescribeTagsResponse' => [ 'type' => 'structure', 'members' => [ 'resourceTags' => [ 'shape' => 'ResourceTagList', ], ], ], 'DescribeVirtualInterfacesRequest' => [ 'type' => 'structure', 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], ], ], 'DirectConnectClientException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'DirectConnectGateway' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'directConnectGatewayName' => [ 'shape' => 'DirectConnectGatewayName', ], 'amazonSideAsn' => [ 'shape' => 'LongAsn', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'directConnectGatewayState' => [ 'shape' => 'DirectConnectGatewayState', ], 'stateChangeError' => [ 'shape' => 'StateChangeError', ], ], ], 'DirectConnectGatewayAssociation' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'directConnectGatewayOwnerAccount' => [ 'shape' => 'OwnerAccount', ], 'associationState' => [ 'shape' => 'DirectConnectGatewayAssociationState', ], 'stateChangeError' => [ 'shape' => 'StateChangeError', ], 'associatedGateway' => [ 'shape' => 'AssociatedGateway', ], 'associationId' => [ 'shape' => 'DirectConnectGatewayAssociationId', ], 'allowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], 'associatedCoreNetwork' => [ 'shape' => 'AssociatedCoreNetwork', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], 'virtualGatewayRegion' => [ 'shape' => 'VirtualGatewayRegion', ], 'virtualGatewayOwnerAccount' => [ 'shape' => 'OwnerAccount', ], ], ], 'DirectConnectGatewayAssociationId' => [ 'type' => 'string', ], 'DirectConnectGatewayAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DirectConnectGatewayAssociation', ], ], 'DirectConnectGatewayAssociationProposal' => [ 'type' => 'structure', 'members' => [ 'proposalId' => [ 'shape' => 'DirectConnectGatewayAssociationProposalId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'directConnectGatewayOwnerAccount' => [ 'shape' => 'OwnerAccount', ], 'proposalState' => [ 'shape' => 'DirectConnectGatewayAssociationProposalState', ], 'associatedGateway' => [ 'shape' => 'AssociatedGateway', ], 'existingAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], 'requestedAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], ], ], 'DirectConnectGatewayAssociationProposalId' => [ 'type' => 'string', ], 'DirectConnectGatewayAssociationProposalList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DirectConnectGatewayAssociationProposal', ], ], 'DirectConnectGatewayAssociationProposalState' => [ 'type' => 'string', 'enum' => [ 'requested', 'accepted', 'deleted', ], ], 'DirectConnectGatewayAssociationState' => [ 'type' => 'string', 'enum' => [ 'associating', 'associated', 'disassociating', 'disassociated', 'updating', ], ], 'DirectConnectGatewayAttachment' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'virtualInterfaceRegion' => [ 'shape' => 'VirtualInterfaceRegion', ], 'virtualInterfaceOwnerAccount' => [ 'shape' => 'OwnerAccount', ], 'attachmentState' => [ 'shape' => 'DirectConnectGatewayAttachmentState', ], 'attachmentType' => [ 'shape' => 'DirectConnectGatewayAttachmentType', ], 'stateChangeError' => [ 'shape' => 'StateChangeError', ], ], ], 'DirectConnectGatewayAttachmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DirectConnectGatewayAttachment', ], ], 'DirectConnectGatewayAttachmentState' => [ 'type' => 'string', 'enum' => [ 'attaching', 'attached', 'detaching', 'detached', ], ], 'DirectConnectGatewayAttachmentType' => [ 'type' => 'string', 'enum' => [ 'TransitVirtualInterface', 'PrivateVirtualInterface', ], ], 'DirectConnectGatewayId' => [ 'type' => 'string', ], 'DirectConnectGatewayList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DirectConnectGateway', ], ], 'DirectConnectGatewayName' => [ 'type' => 'string', ], 'DirectConnectGatewayState' => [ 'type' => 'string', 'enum' => [ 'pending', 'available', 'deleting', 'deleted', ], ], 'DirectConnectServerException' => [ 'type' => 'structure', 'members' => [ 'message' => [ 'shape' => 'ErrorMessage', ], ], 'exception' => true, ], 'DisassociateConnectionFromLagRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'lagId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'lagId' => [ 'shape' => 'LagId', ], ], ], 'DisassociateMacSecKeyRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', 'secretARN', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'secretARN' => [ 'shape' => 'SecretARN', ], ], ], 'DisassociateMacSecKeyResponse' => [ 'type' => 'structure', 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'macSecKeys' => [ 'shape' => 'MacSecKeyList', ], ], ], 'DuplicateTagKeysException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'EnableSiteLink' => [ 'type' => 'boolean', ], 'EncryptionMode' => [ 'type' => 'string', ], 'EndTime' => [ 'type' => 'timestamp', ], 'ErrorMessage' => [ 'type' => 'string', ], 'FailureTestHistoryStatus' => [ 'type' => 'string', ], 'GatewayIdToAssociate' => [ 'type' => 'string', ], 'GatewayIdentifier' => [ 'type' => 'string', ], 'GatewayType' => [ 'type' => 'string', 'enum' => [ 'virtualPrivateGateway', 'transitGateway', ], ], 'HasLogicalRedundancy' => [ 'type' => 'string', 'enum' => [ 'unknown', 'yes', 'no', ], ], 'Interconnect' => [ 'type' => 'structure', 'members' => [ 'interconnectId' => [ 'shape' => 'InterconnectId', ], 'interconnectName' => [ 'shape' => 'InterconnectName', ], 'interconnectState' => [ 'shape' => 'InterconnectState', ], 'region' => [ 'shape' => 'Region', ], 'location' => [ 'shape' => 'LocationCode', ], 'bandwidth' => [ 'shape' => 'Bandwidth', ], 'loaIssueTime' => [ 'shape' => 'LoaIssueTime', ], 'lagId' => [ 'shape' => 'LagId', ], 'awsDevice' => [ 'shape' => 'AwsDevice', ], 'jumboFrameCapable' => [ 'shape' => 'JumboFrameCapable', ], 'awsDeviceV2' => [ 'shape' => 'AwsDeviceV2', ], 'awsLogicalDeviceId' => [ 'shape' => 'AwsLogicalDeviceId', ], 'hasLogicalRedundancy' => [ 'shape' => 'HasLogicalRedundancy', ], 'tags' => [ 'shape' => 'TagList', ], 'providerName' => [ 'shape' => 'ProviderName', ], ], ], 'InterconnectId' => [ 'type' => 'string', ], 'InterconnectList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Interconnect', ], ], 'InterconnectName' => [ 'type' => 'string', ], 'InterconnectState' => [ 'type' => 'string', 'enum' => [ 'requested', 'pending', 'available', 'down', 'deleting', 'deleted', 'unknown', ], ], 'Interconnects' => [ 'type' => 'structure', 'members' => [ 'interconnects' => [ 'shape' => 'InterconnectList', ], ], ], 'JumboFrameCapable' => [ 'type' => 'boolean', ], 'Lag' => [ 'type' => 'structure', 'members' => [ 'connectionsBandwidth' => [ 'shape' => 'Bandwidth', ], 'numberOfConnections' => [ 'shape' => 'Count', ], 'lagId' => [ 'shape' => 'LagId', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'lagName' => [ 'shape' => 'LagName', ], 'lagState' => [ 'shape' => 'LagState', ], 'location' => [ 'shape' => 'LocationCode', ], 'region' => [ 'shape' => 'Region', ], 'minimumLinks' => [ 'shape' => 'Count', ], 'awsDevice' => [ 'shape' => 'AwsDevice', ], 'awsDeviceV2' => [ 'shape' => 'AwsDeviceV2', ], 'awsLogicalDeviceId' => [ 'shape' => 'AwsLogicalDeviceId', ], 'connections' => [ 'shape' => 'ConnectionList', ], 'allowsHostedConnections' => [ 'shape' => 'BooleanFlag', ], 'jumboFrameCapable' => [ 'shape' => 'JumboFrameCapable', ], 'hasLogicalRedundancy' => [ 'shape' => 'HasLogicalRedundancy', ], 'tags' => [ 'shape' => 'TagList', ], 'providerName' => [ 'shape' => 'ProviderName', ], 'macSecCapable' => [ 'shape' => 'MacSecCapable', ], 'encryptionMode' => [ 'shape' => 'EncryptionMode', ], 'macSecKeys' => [ 'shape' => 'MacSecKeyList', ], ], ], 'LagId' => [ 'type' => 'string', ], 'LagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Lag', ], ], 'LagName' => [ 'type' => 'string', ], 'LagState' => [ 'type' => 'string', 'enum' => [ 'requested', 'pending', 'available', 'down', 'deleting', 'deleted', 'unknown', ], ], 'Lags' => [ 'type' => 'structure', 'members' => [ 'lags' => [ 'shape' => 'LagList', ], ], ], 'ListVirtualInterfaceTestHistoryRequest' => [ 'type' => 'structure', 'members' => [ 'testId' => [ 'shape' => 'TestId', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'bgpPeers' => [ 'shape' => 'BGPPeerIdList', ], 'status' => [ 'shape' => 'FailureTestHistoryStatus', ], 'maxResults' => [ 'shape' => 'MaxResultSetSize', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'ListVirtualInterfaceTestHistoryResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceTestHistory' => [ 'shape' => 'VirtualInterfaceTestHistoryList', ], 'nextToken' => [ 'shape' => 'PaginationToken', ], ], ], 'Loa' => [ 'type' => 'structure', 'members' => [ 'loaContent' => [ 'shape' => 'LoaContent', ], 'loaContentType' => [ 'shape' => 'LoaContentType', ], ], ], 'LoaContent' => [ 'type' => 'blob', ], 'LoaContentType' => [ 'type' => 'string', 'enum' => [ 'application/pdf', ], ], 'LoaIssueTime' => [ 'type' => 'timestamp', ], 'Location' => [ 'type' => 'structure', 'members' => [ 'locationCode' => [ 'shape' => 'LocationCode', ], 'locationName' => [ 'shape' => 'LocationName', ], 'region' => [ 'shape' => 'Region', ], 'availablePortSpeeds' => [ 'shape' => 'AvailablePortSpeeds', ], 'availableProviders' => [ 'shape' => 'ProviderList', ], 'availableMacSecPortSpeeds' => [ 'shape' => 'AvailableMacSecPortSpeeds', ], ], ], 'LocationCode' => [ 'type' => 'string', ], 'LocationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Location', ], ], 'LocationName' => [ 'type' => 'string', ], 'Locations' => [ 'type' => 'structure', 'members' => [ 'locations' => [ 'shape' => 'LocationList', ], ], ], 'LongAsn' => [ 'type' => 'long', ], 'MTU' => [ 'type' => 'integer', ], 'MacSecCapable' => [ 'type' => 'boolean', ], 'MacSecKey' => [ 'type' => 'structure', 'members' => [ 'secretARN' => [ 'shape' => 'SecretARN', ], 'ckn' => [ 'shape' => 'Ckn', ], 'state' => [ 'shape' => 'State', ], 'startOn' => [ 'shape' => 'StartOnDate', ], ], ], 'MacSecKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MacSecKey', ], ], 'MaxResultSetSize' => [ 'type' => 'integer', 'box' => true, ], 'NewBGPPeer' => [ 'type' => 'structure', 'members' => [ 'asn' => [ 'shape' => 'ASN', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], ], ], 'NewPrivateVirtualInterface' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceName', 'vlan', 'asn', ], 'members' => [ 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'mtu' => [ 'shape' => 'MTU', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'tags' => [ 'shape' => 'TagList', ], 'enableSiteLink' => [ 'shape' => 'EnableSiteLink', ], ], ], 'NewPrivateVirtualInterfaceAllocation' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceName', 'vlan', 'asn', ], 'members' => [ 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'mtu' => [ 'shape' => 'MTU', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'NewPublicVirtualInterface' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceName', 'vlan', 'asn', ], 'members' => [ 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'routeFilterPrefixes' => [ 'shape' => 'RouteFilterPrefixList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'NewPublicVirtualInterfaceAllocation' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceName', 'vlan', 'asn', ], 'members' => [ 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'routeFilterPrefixes' => [ 'shape' => 'RouteFilterPrefixList', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'NewTransitVirtualInterface' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'mtu' => [ 'shape' => 'MTU', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'tags' => [ 'shape' => 'TagList', ], 'enableSiteLink' => [ 'shape' => 'EnableSiteLink', ], ], ], 'NewTransitVirtualInterfaceAllocation' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'mtu' => [ 'shape' => 'MTU', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'NniPartnerType' => [ 'type' => 'string', 'enum' => [ 'v1', 'v2', 'nonPartner', ], ], 'OwnerAccount' => [ 'type' => 'string', ], 'PaginationToken' => [ 'type' => 'string', ], 'PartnerName' => [ 'type' => 'string', ], 'Platform' => [ 'type' => 'string', ], 'PortEncryptionStatus' => [ 'type' => 'string', ], 'PortSpeed' => [ 'type' => 'string', ], 'ProviderList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ProviderName', ], ], 'ProviderName' => [ 'type' => 'string', ], 'Region' => [ 'type' => 'string', ], 'RequestMACSec' => [ 'type' => 'boolean', ], 'ResourceArn' => [ 'type' => 'string', ], 'ResourceArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceArn', ], ], 'ResourceTag' => [ 'type' => 'structure', 'members' => [ 'resourceArn' => [ 'shape' => 'ResourceArn', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'ResourceTagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ResourceTag', ], ], 'RouteFilterPrefix' => [ 'type' => 'structure', 'members' => [ 'cidr' => [ 'shape' => 'CIDR', ], ], ], 'RouteFilterPrefixList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RouteFilterPrefix', ], ], 'RouterConfig' => [ 'type' => 'string', ], 'RouterType' => [ 'type' => 'structure', 'members' => [ 'vendor' => [ 'shape' => 'Vendor', ], 'platform' => [ 'shape' => 'Platform', ], 'software' => [ 'shape' => 'Software', ], 'xsltTemplateName' => [ 'shape' => 'XsltTemplateName', ], 'xsltTemplateNameForMacSec' => [ 'shape' => 'XsltTemplateNameForMacSec', ], 'routerTypeIdentifier' => [ 'shape' => 'RouterTypeIdentifier', ], ], ], 'RouterTypeIdentifier' => [ 'type' => 'string', ], 'SecretARN' => [ 'type' => 'string', ], 'SiteLinkEnabled' => [ 'type' => 'boolean', ], 'Software' => [ 'type' => 'string', ], 'StartBgpFailoverTestRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'bgpPeers' => [ 'shape' => 'BGPPeerIdList', ], 'testDurationInMinutes' => [ 'shape' => 'TestDuration', ], ], ], 'StartBgpFailoverTestResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceTest' => [ 'shape' => 'VirtualInterfaceTestHistory', ], ], ], 'StartOnDate' => [ 'type' => 'string', ], 'StartTime' => [ 'type' => 'timestamp', ], 'State' => [ 'type' => 'string', ], 'StateChangeError' => [ 'type' => 'string', ], 'Status' => [ 'type' => 'string', 'max' => 30, ], 'StopBgpFailoverTestRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], ], ], 'StopBgpFailoverTestResponse' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaceTest' => [ 'shape' => 'VirtualInterfaceTestHistory', ], ], ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'key', ], 'members' => [ 'key' => [ 'shape' => 'TagKey', ], 'value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 128, 'min' => 1, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], 'min' => 1, ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tags', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ResourceArn', ], 'tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$', ], 'TestDuration' => [ 'type' => 'integer', 'box' => true, ], 'TestId' => [ 'type' => 'string', ], 'TooManyTagsException' => [ 'type' => 'structure', 'members' => [], 'exception' => true, ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'resourceArn', 'tagKeys', ], 'members' => [ 'resourceArn' => [ 'shape' => 'ResourceArn', ], 'tagKeys' => [ 'shape' => 'TagKeyList', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'connectionId', ], 'members' => [ 'connectionId' => [ 'shape' => 'ConnectionId', ], 'connectionName' => [ 'shape' => 'ConnectionName', ], 'encryptionMode' => [ 'shape' => 'EncryptionMode', ], ], ], 'UpdateDirectConnectGatewayAssociationRequest' => [ 'type' => 'structure', 'members' => [ 'associationId' => [ 'shape' => 'DirectConnectGatewayAssociationId', ], 'addAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], 'removeAllowedPrefixesToDirectConnectGateway' => [ 'shape' => 'RouteFilterPrefixList', ], ], ], 'UpdateDirectConnectGatewayAssociationResult' => [ 'type' => 'structure', 'members' => [ 'directConnectGatewayAssociation' => [ 'shape' => 'DirectConnectGatewayAssociation', ], ], ], 'UpdateDirectConnectGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'directConnectGatewayId', 'newDirectConnectGatewayName', ], 'members' => [ 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'newDirectConnectGatewayName' => [ 'shape' => 'DirectConnectGatewayName', ], ], ], 'UpdateDirectConnectGatewayResponse' => [ 'type' => 'structure', 'members' => [ 'directConnectGateway' => [ 'shape' => 'DirectConnectGateway', ], ], ], 'UpdateLagRequest' => [ 'type' => 'structure', 'required' => [ 'lagId', ], 'members' => [ 'lagId' => [ 'shape' => 'LagId', ], 'lagName' => [ 'shape' => 'LagName', ], 'minimumLinks' => [ 'shape' => 'Count', ], 'encryptionMode' => [ 'shape' => 'EncryptionMode', ], ], ], 'UpdateVirtualInterfaceAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'virtualInterfaceId', ], 'members' => [ 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'mtu' => [ 'shape' => 'MTU', ], 'enableSiteLink' => [ 'shape' => 'EnableSiteLink', ], 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], ], ], 'VLAN' => [ 'type' => 'integer', ], 'Vendor' => [ 'type' => 'string', ], 'VirtualGateway' => [ 'type' => 'structure', 'members' => [ 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], 'virtualGatewayState' => [ 'shape' => 'VirtualGatewayState', ], ], ], 'VirtualGatewayId' => [ 'type' => 'string', ], 'VirtualGatewayList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VirtualGateway', ], ], 'VirtualGatewayRegion' => [ 'type' => 'string', 'deprecated' => true, ], 'VirtualGatewayState' => [ 'type' => 'string', ], 'VirtualGateways' => [ 'type' => 'structure', 'members' => [ 'virtualGateways' => [ 'shape' => 'VirtualGatewayList', ], ], ], 'VirtualInterface' => [ 'type' => 'structure', 'members' => [ 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'location' => [ 'shape' => 'LocationCode', ], 'connectionId' => [ 'shape' => 'ConnectionId', ], 'virtualInterfaceType' => [ 'shape' => 'VirtualInterfaceType', ], 'virtualInterfaceName' => [ 'shape' => 'VirtualInterfaceName', ], 'vlan' => [ 'shape' => 'VLAN', ], 'asn' => [ 'shape' => 'ASN', ], 'amazonSideAsn' => [ 'shape' => 'LongAsn', ], 'authKey' => [ 'shape' => 'BGPAuthKey', ], 'amazonAddress' => [ 'shape' => 'AmazonAddress', ], 'customerAddress' => [ 'shape' => 'CustomerAddress', ], 'addressFamily' => [ 'shape' => 'AddressFamily', ], 'virtualInterfaceState' => [ 'shape' => 'VirtualInterfaceState', ], 'customerRouterConfig' => [ 'shape' => 'RouterConfig', ], 'mtu' => [ 'shape' => 'MTU', ], 'jumboFrameCapable' => [ 'shape' => 'JumboFrameCapable', ], 'virtualGatewayId' => [ 'shape' => 'VirtualGatewayId', ], 'directConnectGatewayId' => [ 'shape' => 'DirectConnectGatewayId', ], 'routeFilterPrefixes' => [ 'shape' => 'RouteFilterPrefixList', ], 'bgpPeers' => [ 'shape' => 'BGPPeerList', ], 'region' => [ 'shape' => 'Region', ], 'awsDeviceV2' => [ 'shape' => 'AwsDeviceV2', ], 'awsLogicalDeviceId' => [ 'shape' => 'AwsLogicalDeviceId', ], 'tags' => [ 'shape' => 'TagList', ], 'siteLinkEnabled' => [ 'shape' => 'SiteLinkEnabled', ], ], ], 'VirtualInterfaceId' => [ 'type' => 'string', ], 'VirtualInterfaceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VirtualInterface', ], ], 'VirtualInterfaceName' => [ 'type' => 'string', ], 'VirtualInterfaceRegion' => [ 'type' => 'string', ], 'VirtualInterfaceState' => [ 'type' => 'string', 'enum' => [ 'confirming', 'verifying', 'pending', 'available', 'down', 'deleting', 'deleted', 'rejected', 'unknown', ], ], 'VirtualInterfaceTestHistory' => [ 'type' => 'structure', 'members' => [ 'testId' => [ 'shape' => 'TestId', ], 'virtualInterfaceId' => [ 'shape' => 'VirtualInterfaceId', ], 'bgpPeers' => [ 'shape' => 'BGPPeerIdList', ], 'status' => [ 'shape' => 'FailureTestHistoryStatus', ], 'ownerAccount' => [ 'shape' => 'OwnerAccount', ], 'testDurationInMinutes' => [ 'shape' => 'TestDuration', ], 'startTime' => [ 'shape' => 'StartTime', ], 'endTime' => [ 'shape' => 'EndTime', ], ], ], 'VirtualInterfaceTestHistoryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'VirtualInterfaceTestHistory', ], ], 'VirtualInterfaceType' => [ 'type' => 'string', ], 'VirtualInterfaces' => [ 'type' => 'structure', 'members' => [ 'virtualInterfaces' => [ 'shape' => 'VirtualInterfaceList', ], ], ], 'XsltTemplateName' => [ 'type' => 'string', ], 'XsltTemplateNameForMacSec' => [ 'type' => 'string', ], ],]; diff --git a/src/data/directconnect/2012-10-25/docs-2.json b/src/data/directconnect/2012-10-25/docs-2.json index a9e76850f7..2e587d779b 100644 --- a/src/data/directconnect/2012-10-25/docs-2.json +++ b/src/data/directconnect/2012-10-25/docs-2.json @@ -188,6 +188,12 @@ "refs": { } }, + "AssociatedCoreNetwork": { + "base": "

The Amazon Web Services Cloud WAN core network that the Direct Connect attachment is associated with.

", + "refs": { + "DirectConnectGatewayAssociation$associatedCoreNetwork": "

The ID of the Cloud WAN core network associated with the Direct Connect attachment.

" + } + }, "AssociatedGateway": { "base": "

Information about the associated gateway.

", "refs": { @@ -451,6 +457,18 @@ "refs": { } }, + "CoreNetworkAttachmentId": { + "base": null, + "refs": { + "AssociatedCoreNetwork$attachmentId": "

the ID of the Direct Connect attachment

" + } + }, + "CoreNetworkIdentifier": { + "base": null, + "refs": { + "AssociatedCoreNetwork$id": "

The ID of the Cloud WAN core network.

" + } + }, "Count": { "base": null, "refs": { @@ -1257,6 +1275,7 @@ "AllocatePrivateVirtualInterfaceRequest$ownerAccount": "

The ID of the Amazon Web Services account that owns the virtual private interface.

", "AllocatePublicVirtualInterfaceRequest$ownerAccount": "

The ID of the Amazon Web Services account that owns the public virtual interface.

", "AllocateTransitVirtualInterfaceRequest$ownerAccount": "

The ID of the Amazon Web Services account that owns the transit virtual interface.

", + "AssociatedCoreNetwork$ownerAccount": "

The account owner of the Cloud WAN core network.

", "AssociatedGateway$ownerAccount": "

The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.

", "Connection$ownerAccount": "

The ID of the Amazon Web Services account that owns the connection.

", "CreateDirectConnectGatewayAssociationProposalRequest$directConnectGatewayOwnerAccount": "

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

", diff --git a/src/data/directconnect/2012-10-25/docs-2.json.php b/src/data/directconnect/2012-10-25/docs-2.json.php index 61122ab9e8..1799fd1093 100644 --- a/src/data/directconnect/2012-10-25/docs-2.json.php +++ b/src/data/directconnect/2012-10-25/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router. With this connection in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.

', 'operations' => [ 'AcceptDirectConnectGatewayAssociationProposal' => '

Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.

', 'AllocateConnectionOnInterconnect' => '

Deprecated. Use AllocateHostedConnection instead.

Creates a hosted connection on an interconnect.

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.

Intended for use by Direct Connect Partners only.

', 'AllocateHostedConnection' => '

Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.

Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.

Intended for use by Direct Connect Partners only.

', 'AllocatePrivateVirtualInterface' => '

Provisions a private virtual interface to be owned by the specified Amazon Web Services account.

Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.

', 'AllocatePublicVirtualInterface' => '

Provisions a public virtual interface to be owned by the specified Amazon Web Services account.

The owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services account.

Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.

When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

', 'AllocateTransitVirtualInterface' => '

Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.

The owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account.

After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.

', 'AssociateConnectionWithLag' => '

Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services is interrupted). The connection must be hosted on the same Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that\'s currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.

Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.

For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.

', 'AssociateHostedConnection' => '

Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection\'s connectivity to Amazon Web Services as it is being migrated.

Intended for use by Direct Connect Partners only.

', 'AssociateMacSecKey' => '

Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.

You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request.

For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide.

', 'AssociateVirtualInterface' => '

Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to Amazon Web Services is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.

Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection.

To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association.

', 'ConfirmConnection' => '

Confirms the creation of the specified hosted connection on an interconnect.

Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms creation of the hosted connection.

', 'ConfirmCustomerAgreement' => '

The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).

', 'ConfirmPrivateVirtualInterface' => '

Accepts ownership of a private virtual interface created by another Amazon Web Services account.

After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.

', 'ConfirmPublicVirtualInterface' => '

Accepts ownership of a public virtual interface created by another Amazon Web Services account.

After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic.

', 'ConfirmTransitVirtualInterface' => '

Accepts ownership of a transit virtual interface created by another Amazon Web Services account.

After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.

', 'CreateBGPPeer' => '

Creates a BGP peer on the specified virtual interface.

You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family.

If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.

When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

If you let Amazon Web Services auto-assign IPv4 addresses, a /30 CIDR will be allocated from 169.254.0.0/16. Amazon Web Services does not recommend this option if you intend to use the customer router peer IP address as the source and destination for traffic. Instead you should use RFC 1918 or other addressing, and specify the address yourself. For more information about RFC 1918 see Address Allocation for Private Internets.

For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.

', 'CreateConnection' => '

Creates a connection between a customer network and a specific Direct Connect location.

A connection links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router.

To find the locations for your Region, use DescribeLocations.

You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.

', 'CreateDirectConnectGateway' => '

Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any Amazon Web Services Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different Amazon Web Services Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.

', 'CreateDirectConnectGatewayAssociation' => '

Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.

', 'CreateDirectConnectGatewayAssociationProposal' => '

Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.

You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any Amazon Web Services account.

', 'CreateInterconnect' => '

Creates an interconnect between an Direct Connect Partner\'s network and a specific Direct Connect location.

An interconnect is a connection that is capable of hosting other connections. The Direct Connect Partner can use an interconnect to provide Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner\'s network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner\'s router, the other to an Direct Connect router.

You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created.

For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner.

Intended for use by Direct Connect Partners only.

', 'CreateLag' => '

Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.

All connections in a LAG must use the same bandwidth (either 1Gbps, 10Gbps, 100Gbps, or 400Gbps) and must terminate at the same Direct Connect endpoint.

You can have up to 10 dedicated connections per location. Regardless of this limit, if you request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is created..

You can specify an existing physical dedicated connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any virtual interfaces associated with the dedicated connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.

If the Amazon Web Services account used to create a LAG is a registered Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.

', 'CreatePrivateVirtualInterface' => '

Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.

Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn\'t updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

', 'CreatePublicVirtualInterface' => '

Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A public virtual interface supports sending traffic to public services of Amazon Web Services such as Amazon S3.

When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.

', 'CreateTransitVirtualInterface' => '

Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.

If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails.

A jumbo MTU value must be either 1500 or 8500. No other values will be accepted. Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn\'t updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

', 'DeleteBGPPeer' => '

Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.

You cannot delete the last BGP peer from a virtual interface.

', 'DeleteConnection' => '

Deletes the specified connection.

Deleting a connection only stops the Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the Direct Connect location, you must cancel your service with them separately.

', 'DeleteDirectConnectGateway' => '

Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways associated with the Direct Connect gateway.

', 'DeleteDirectConnectGatewayAssociation' => '

Deletes the association between the specified Direct Connect gateway and virtual private gateway.

We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.

', 'DeleteDirectConnectGatewayAssociationProposal' => '

Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.

', 'DeleteInterconnect' => '

Deletes the specified interconnect.

Intended for use by Direct Connect Partners only.

', 'DeleteLag' => '

Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.

', 'DeleteVirtualInterface' => '

Deletes a virtual interface.

', 'DescribeConnectionLoa' => '

Deprecated. Use DescribeLoa instead.

Gets the LOA-CFA for a connection.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.

', 'DescribeConnections' => '

Displays the specified connection or all connections in this Region.

', 'DescribeConnectionsOnInterconnect' => '

Deprecated. Use DescribeHostedConnections instead.

Lists the connections that have been provisioned on the specified interconnect.

Intended for use by Direct Connect Partners only.

', 'DescribeCustomerMetadata' => '

Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.

', 'DescribeDirectConnectGatewayAssociationProposals' => '

Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

', 'DescribeDirectConnectGatewayAssociations' => '

Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:

', 'DescribeDirectConnectGatewayAttachments' => '

Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.

', 'DescribeDirectConnectGateways' => '

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

', 'DescribeHostedConnections' => '

Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).

Intended for use by Direct Connect Partners only.

', 'DescribeInterconnectLoa' => '

Deprecated. Use DescribeLoa instead.

Gets the LOA-CFA for the specified interconnect.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.

', 'DescribeInterconnects' => '

Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.

', 'DescribeLags' => '

Describes all your link aggregation groups (LAG) or the specified LAG.

', 'DescribeLoa' => '

Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.

', 'DescribeLocations' => '

Lists the Direct Connect locations in the current Amazon Web Services Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.

', 'DescribeRouterConfiguration' => '

Details about the router.

', 'DescribeTags' => '

Describes the tags associated with the specified Direct Connect resources.

', 'DescribeVirtualGateways' => '

Deprecated. Use DescribeVpnGateways instead. See DescribeVPNGateways in the Amazon Elastic Compute Cloud API Reference.

Lists the virtual private gateways owned by the Amazon Web Services account.

You can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.

', 'DescribeVirtualInterfaces' => '

Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.

A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.

', 'DisassociateConnectionFromLag' => '

Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an Direct Connect Partner is automatically converted to an interconnect.

If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it\'s the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.

', 'DisassociateMacSecKey' => '

Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.

', 'ListVirtualInterfaceTestHistory' => '

Lists the virtual interface failover test history.

', 'StartBgpFailoverTest' => '

Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages.

You can run the test on public, private, transit, and hosted virtual interfaces.

You can use ListVirtualInterfaceTestHistory to view the virtual interface test history.

If you need to stop the test before the test interval completes, use StopBgpFailoverTest.

', 'StopBgpFailoverTest' => '

Stops the virtual interface failover test.

', 'TagResource' => '

Adds the specified tags to the specified Direct Connect resource. Each resource can have a maximum of 50 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

', 'UntagResource' => '

Removes one or more tags from the specified Direct Connect resource.

', 'UpdateConnection' => '

Updates the Direct Connect dedicated connection configuration.

You can update the following parameters for a connection:

', 'UpdateDirectConnectGateway' => '

Updates the name of a current Direct Connect gateway.

', 'UpdateDirectConnectGatewayAssociation' => '

Updates the specified attributes of the Direct Connect gateway association.

Add or remove prefixes from the association.

', 'UpdateLag' => '

Updates the attributes of the specified link aggregation group (LAG).

You can update the following LAG attributes:

If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational.

', 'UpdateVirtualInterfaceAttributes' => '

Updates the specified attributes of the specified virtual private interface.

Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn\'t updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

', ], 'shapes' => [ 'ASN' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

', 'DeleteBGPPeerRequest$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

', 'NewBGPPeer$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

', 'NewPrivateVirtualInterface$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', 'NewPrivateVirtualInterfaceAllocation$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', 'NewPublicVirtualInterface$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', 'NewPublicVirtualInterfaceAllocation$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', 'NewTransitVirtualInterface$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', 'NewTransitVirtualInterfaceAllocation$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', 'VirtualInterface$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', ], ], 'AcceptDirectConnectGatewayAssociationProposalRequest' => [ 'base' => NULL, 'refs' => [], ], 'AcceptDirectConnectGatewayAssociationProposalResult' => [ 'base' => NULL, 'refs' => [], ], 'AddressFamily' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$addressFamily' => '

The address family for the BGP peer.

', 'NewBGPPeer$addressFamily' => '

The address family for the BGP peer.

', 'NewPrivateVirtualInterface$addressFamily' => '

The address family for the BGP peer.

', 'NewPrivateVirtualInterfaceAllocation$addressFamily' => '

The address family for the BGP peer.

', 'NewPublicVirtualInterface$addressFamily' => '

The address family for the BGP peer.

', 'NewPublicVirtualInterfaceAllocation$addressFamily' => '

The address family for the BGP peer.

', 'NewTransitVirtualInterface$addressFamily' => '

The address family for the BGP peer.

', 'NewTransitVirtualInterfaceAllocation$addressFamily' => '

The address family for the BGP peer.

', 'VirtualInterface$addressFamily' => '

The address family for the BGP peer.

', ], ], 'AgreementList' => [ 'base' => NULL, 'refs' => [ 'DescribeCustomerMetadataResponse$agreements' => '

The list of customer agreements.

', ], ], 'AgreementName' => [ 'base' => NULL, 'refs' => [ 'ConfirmCustomerAgreementRequest$agreementName' => '

The name of the customer agreement.

', 'CustomerAgreement$agreementName' => '

The name of the agreement.

', ], ], 'AllocateConnectionOnInterconnectRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocateHostedConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocatePrivateVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocatePublicVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocateTransitVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocateTransitVirtualInterfaceResult' => [ 'base' => NULL, 'refs' => [], ], 'AmazonAddress' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewBGPPeer$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewPrivateVirtualInterface$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewPrivateVirtualInterfaceAllocation$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewPublicVirtualInterface$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewPublicVirtualInterfaceAllocation$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewTransitVirtualInterface$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewTransitVirtualInterfaceAllocation$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'VirtualInterface$amazonAddress' => '

The IP address assigned to the Amazon interface.

', ], ], 'AssociateConnectionWithLagRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateHostedConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateMacSecKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateMacSecKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociatedGateway' => [ 'base' => '

Information about the associated gateway.

', 'refs' => [ 'DirectConnectGatewayAssociation$associatedGateway' => '

Information about the associated gateway.

', 'DirectConnectGatewayAssociationProposal$associatedGateway' => '

Information about the associated gateway.

', ], ], 'AssociatedGatewayId' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewayAssociationProposalsRequest$associatedGatewayId' => '

The ID of the associated gateway.

', 'DescribeDirectConnectGatewayAssociationsRequest$associatedGatewayId' => '

The ID of the associated gateway.

', ], ], 'AvailableMacSecPortSpeeds' => [ 'base' => NULL, 'refs' => [ 'Location$availableMacSecPortSpeeds' => '

The available MAC Security (MACsec) port speeds for the location.

', ], ], 'AvailablePortSpeeds' => [ 'base' => NULL, 'refs' => [ 'Location$availablePortSpeeds' => '

The available port speeds for the location.

', ], ], 'AwsDevice' => [ 'base' => NULL, 'refs' => [ 'Connection$awsDevice' => '

The Direct Connect endpoint on which the physical connection terminates.

', 'Interconnect$awsDevice' => '

The Direct Connect endpoint on which the physical connection terminates.

', 'Lag$awsDevice' => '

The Direct Connect endpoint that hosts the LAG.

', ], ], 'AwsDeviceV2' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$awsDeviceV2' => '

The Direct Connect endpoint that terminates the BGP peer.

', 'Connection$awsDeviceV2' => '

The Direct Connect endpoint that terminates the physical connection.

', 'Interconnect$awsDeviceV2' => '

The Direct Connect endpoint that terminates the physical connection.

', 'Lag$awsDeviceV2' => '

The Direct Connect endpoint that hosts the LAG.

', 'VirtualInterface$awsDeviceV2' => '

The Direct Connect endpoint that terminates the physical connection.

', ], ], 'AwsLogicalDeviceId' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$awsLogicalDeviceId' => '

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

', 'Connection$awsLogicalDeviceId' => '

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

', 'Interconnect$awsLogicalDeviceId' => '

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

', 'Lag$awsLogicalDeviceId' => '

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

', 'VirtualInterface$awsLogicalDeviceId' => '

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

', ], ], 'BGPAuthKey' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewBGPPeer$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewPrivateVirtualInterface$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewPrivateVirtualInterfaceAllocation$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewPublicVirtualInterface$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewPublicVirtualInterfaceAllocation$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewTransitVirtualInterface$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewTransitVirtualInterfaceAllocation$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'VirtualInterface$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', ], ], 'BGPPeer' => [ 'base' => '

Information about a BGP peer.

', 'refs' => [ 'BGPPeerList$member' => NULL, ], ], 'BGPPeerId' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$bgpPeerId' => '

The ID of the BGP peer.

', 'BGPPeerIdList$member' => NULL, 'DeleteBGPPeerRequest$bgpPeerId' => '

The ID of the BGP peer.

', ], ], 'BGPPeerIdList' => [ 'base' => NULL, 'refs' => [ 'ListVirtualInterfaceTestHistoryRequest$bgpPeers' => '

The BGP peers that were placed in the DOWN state during the virtual interface failover test.

', 'StartBgpFailoverTestRequest$bgpPeers' => '

The BGP peers to place in the DOWN state.

', 'VirtualInterfaceTestHistory$bgpPeers' => '

The BGP peers that were put in the DOWN state as part of the virtual interface failover test.

', ], ], 'BGPPeerList' => [ 'base' => NULL, 'refs' => [ 'VirtualInterface$bgpPeers' => '

The BGP peers configured on this virtual interface.

', ], ], 'BGPPeerState' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$bgpPeerState' => '

The state of the BGP peer. The following are the possible values:

', ], ], 'BGPStatus' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$bgpStatus' => '

The status of the BGP peer. The following are the possible values:

', ], ], 'Bandwidth' => [ 'base' => NULL, 'refs' => [ 'AllocateConnectionOnInterconnectRequest$bandwidth' => '

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

', 'AllocateHostedConnectionRequest$bandwidth' => '

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps, and 25Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps, 10Gbps, or 25Gbps hosted connection.

', 'Connection$bandwidth' => '

The bandwidth of the connection.

', 'CreateConnectionRequest$bandwidth' => '

The bandwidth of the connection.

', 'CreateInterconnectRequest$bandwidth' => '

The port bandwidth, in Gbps. The possible values are 1, 10, and 100.

', 'CreateLagRequest$connectionsBandwidth' => '

The bandwidth of the individual physical dedicated connections bundled by the LAG. The possible values are 1Gbps,10Gbps, 100Gbps, and 400Gbps.

', 'Interconnect$bandwidth' => '

The bandwidth of the connection.

', 'Lag$connectionsBandwidth' => '

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..

', ], ], 'BooleanFlag' => [ 'base' => NULL, 'refs' => [ 'Lag$allowsHostedConnections' => '

Indicates whether the LAG can host other connections.

', ], ], 'CIDR' => [ 'base' => NULL, 'refs' => [ 'RouteFilterPrefix$cidr' => '

The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

', ], ], 'Cak' => [ 'base' => NULL, 'refs' => [ 'AssociateMacSecKeyRequest$cak' => '

The MAC Security (MACsec) CAK to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.

', ], ], 'Ckn' => [ 'base' => NULL, 'refs' => [ 'AssociateMacSecKeyRequest$ckn' => '

The MAC Security (MACsec) CKN to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.

', 'MacSecKey$ckn' => '

The Connection Key Name (CKN) for the MAC Security secret key.

', ], ], 'ConfirmConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmCustomerAgreementRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmCustomerAgreementResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmPrivateVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmPrivateVirtualInterfaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmPublicVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmPublicVirtualInterfaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmTransitVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmTransitVirtualInterfaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Connection' => [ 'base' => '

Information about an Direct Connect connection.

', 'refs' => [ 'ConnectionList$member' => NULL, ], ], 'ConnectionId' => [ 'base' => NULL, 'refs' => [ 'AllocateHostedConnectionRequest$connectionId' => '

The ID of the interconnect or LAG.

', 'AllocatePrivateVirtualInterfaceRequest$connectionId' => '

The ID of the connection on which the private virtual interface is provisioned.

', 'AllocatePublicVirtualInterfaceRequest$connectionId' => '

The ID of the connection on which the public virtual interface is provisioned.

', 'AllocateTransitVirtualInterfaceRequest$connectionId' => '

The ID of the connection on which the transit virtual interface is provisioned.

', 'AssociateConnectionWithLagRequest$connectionId' => '

The ID of the connection.

', 'AssociateHostedConnectionRequest$connectionId' => '

The ID of the hosted connection.

', 'AssociateHostedConnectionRequest$parentConnectionId' => '

The ID of the interconnect or the LAG.

', 'AssociateMacSecKeyRequest$connectionId' => '

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

', 'AssociateMacSecKeyResponse$connectionId' => '

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

', 'AssociateVirtualInterfaceRequest$connectionId' => '

The ID of the LAG or connection.

', 'ConfirmConnectionRequest$connectionId' => '

The ID of the hosted connection.

', 'Connection$connectionId' => '

The ID of the connection.

', 'CreateLagRequest$connectionId' => '

The ID of an existing dedicated connection to migrate to the LAG.

', 'CreatePrivateVirtualInterfaceRequest$connectionId' => '

The ID of the connection.

', 'CreatePublicVirtualInterfaceRequest$connectionId' => '

The ID of the connection.

', 'CreateTransitVirtualInterfaceRequest$connectionId' => '

The ID of the connection.

', 'DeleteConnectionRequest$connectionId' => '

The ID of the connection.

', 'DescribeConnectionLoaRequest$connectionId' => '

The ID of the connection.

', 'DescribeConnectionsRequest$connectionId' => '

The ID of the connection.

', 'DescribeHostedConnectionsRequest$connectionId' => '

The ID of the interconnect or LAG.

', 'DescribeLoaRequest$connectionId' => '

The ID of a connection, LAG, or interconnect.

', 'DescribeVirtualInterfacesRequest$connectionId' => '

The ID of the connection.

', 'DisassociateConnectionFromLagRequest$connectionId' => '

The ID of the connection.

', 'DisassociateMacSecKeyRequest$connectionId' => '

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

', 'DisassociateMacSecKeyResponse$connectionId' => '

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

', 'UpdateConnectionRequest$connectionId' => '

The ID of the dedicated connection.

You can use DescribeConnections to retrieve the connection ID.

', 'VirtualInterface$connectionId' => '

The ID of the connection.

', ], ], 'ConnectionList' => [ 'base' => NULL, 'refs' => [ 'Connections$connections' => '

The connections.

', 'Lag$connections' => '

The connections bundled by the LAG.

', ], ], 'ConnectionName' => [ 'base' => NULL, 'refs' => [ 'AllocateConnectionOnInterconnectRequest$connectionName' => '

The name of the provisioned connection.

', 'AllocateHostedConnectionRequest$connectionName' => '

The name of the hosted connection.

', 'Connection$connectionName' => '

The name of the connection.

', 'CreateConnectionRequest$connectionName' => '

The name of the connection.

', 'UpdateConnectionRequest$connectionName' => '

The name of the connection.

', ], ], 'ConnectionState' => [ 'base' => NULL, 'refs' => [ 'ConfirmConnectionResponse$connectionState' => '

The state of the connection. The following are the possible values:

', 'Connection$connectionState' => '

The state of the connection. The following are the possible values:

', ], ], 'Connections' => [ 'base' => NULL, 'refs' => [], ], 'Count' => [ 'base' => NULL, 'refs' => [ 'CreateLagRequest$numberOfConnections' => '

The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1Gbps or 10Gbps, or two when the port speed is 100Gbps or 400Gbps.

', 'Lag$numberOfConnections' => '

The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.

', 'Lag$minimumLinks' => '

The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

', 'UpdateLagRequest$minimumLinks' => '

The minimum number of physical connections that must be operational for the LAG itself to be operational.

', ], ], 'CreateBGPPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBGPPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayAssociationProposalRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayAssociationProposalResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayAssociationResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateInterconnectRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLagRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePrivateVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePublicVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransitVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransitVirtualInterfaceResult' => [ 'base' => NULL, 'refs' => [], ], 'CustomerAddress' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$customerAddress' => '

The IP address assigned to the customer interface.

', 'DeleteBGPPeerRequest$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewBGPPeer$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewPrivateVirtualInterface$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewPrivateVirtualInterfaceAllocation$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewPublicVirtualInterface$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewPublicVirtualInterfaceAllocation$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewTransitVirtualInterface$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewTransitVirtualInterfaceAllocation$customerAddress' => '

The IP address assigned to the customer interface.

', 'VirtualInterface$customerAddress' => '

The IP address assigned to the customer interface.

', ], ], 'CustomerAgreement' => [ 'base' => '

The name and status of a customer agreement.

', 'refs' => [ 'AgreementList$member' => NULL, ], ], 'DeleteBGPPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBGPPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDirectConnectGatewayAssociationProposalRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDirectConnectGatewayAssociationProposalResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDirectConnectGatewayAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDirectConnectGatewayAssociationResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDirectConnectGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDirectConnectGatewayResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInterconnectRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInterconnectResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLagRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVirtualInterfaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectionLoaRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectionLoaResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectionsOnInterconnectRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCustomerMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewayAssociationProposalsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewayAssociationProposalsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewayAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewayAssociationsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewayAttachmentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewayAttachmentsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewaysRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewaysResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHostedConnectionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInterconnectLoaRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInterconnectLoaResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInterconnectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLoaRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRouterConfigurationRequest' => [ 'base' => '

Provides the details about a virtual interface\'s router.

', 'refs' => [], ], 'DescribeRouterConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTagsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVirtualInterfacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DirectConnectClientException' => [ 'base' => '

One or more parameters are not valid.

', 'refs' => [], ], 'DirectConnectGateway' => [ 'base' => '

Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.

', 'refs' => [ 'CreateDirectConnectGatewayResult$directConnectGateway' => '

The Direct Connect gateway.

', 'DeleteDirectConnectGatewayResult$directConnectGateway' => '

The Direct Connect gateway.

', 'DirectConnectGatewayList$member' => NULL, 'UpdateDirectConnectGatewayResponse$directConnectGateway' => '

Informaiton about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateways or transit gateways.

', ], ], 'DirectConnectGatewayAssociation' => [ 'base' => '

Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.

', 'refs' => [ 'AcceptDirectConnectGatewayAssociationProposalResult$directConnectGatewayAssociation' => '

Information about an association between a Direct Connect gateway and a virtual gateway or transit gateway.

', 'CreateDirectConnectGatewayAssociationResult$directConnectGatewayAssociation' => '

The association to be created.

', 'DeleteDirectConnectGatewayAssociationResult$directConnectGatewayAssociation' => '

Information about the deleted association.

', 'DirectConnectGatewayAssociationList$member' => NULL, 'UpdateDirectConnectGatewayAssociationResult$directConnectGatewayAssociation' => '

Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.

', ], ], 'DirectConnectGatewayAssociationId' => [ 'base' => NULL, 'refs' => [ 'DeleteDirectConnectGatewayAssociationRequest$associationId' => '

The ID of the Direct Connect gateway association.

', 'DescribeDirectConnectGatewayAssociationsRequest$associationId' => '

The ID of the Direct Connect gateway association.

', 'DirectConnectGatewayAssociation$associationId' => '

The ID of the Direct Connect gateway association.

', 'UpdateDirectConnectGatewayAssociationRequest$associationId' => '

The ID of the Direct Connect gateway association.

', ], ], 'DirectConnectGatewayAssociationList' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewayAssociationsResult$directConnectGatewayAssociations' => '

Information about the associations.

', ], ], 'DirectConnectGatewayAssociationProposal' => [ 'base' => '

Information about the proposal request to attach a virtual private gateway to a Direct Connect gateway.

', 'refs' => [ 'CreateDirectConnectGatewayAssociationProposalResult$directConnectGatewayAssociationProposal' => '

Information about the Direct Connect gateway proposal.

', 'DeleteDirectConnectGatewayAssociationProposalResult$directConnectGatewayAssociationProposal' => '

The ID of the associated gateway.

', 'DirectConnectGatewayAssociationProposalList$member' => NULL, ], ], 'DirectConnectGatewayAssociationProposalId' => [ 'base' => NULL, 'refs' => [ 'AcceptDirectConnectGatewayAssociationProposalRequest$proposalId' => '

The ID of the request proposal.

', 'DeleteDirectConnectGatewayAssociationProposalRequest$proposalId' => '

The ID of the proposal.

', 'DescribeDirectConnectGatewayAssociationProposalsRequest$proposalId' => '

The ID of the proposal.

', 'DirectConnectGatewayAssociationProposal$proposalId' => '

The ID of the association proposal.

', ], ], 'DirectConnectGatewayAssociationProposalList' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewayAssociationProposalsResult$directConnectGatewayAssociationProposals' => '

Describes the Direct Connect gateway association proposals.

', ], ], 'DirectConnectGatewayAssociationProposalState' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGatewayAssociationProposal$proposalState' => '

The state of the proposal. The following are possible values:

', ], ], 'DirectConnectGatewayAssociationState' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGatewayAssociation$associationState' => '

The state of the association. The following are the possible values:

', ], ], 'DirectConnectGatewayAttachment' => [ 'base' => '

Information about an attachment between a Direct Connect gateway and a virtual interface.

', 'refs' => [ 'DirectConnectGatewayAttachmentList$member' => NULL, ], ], 'DirectConnectGatewayAttachmentList' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewayAttachmentsResult$directConnectGatewayAttachments' => '

The attachments.

', ], ], 'DirectConnectGatewayAttachmentState' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGatewayAttachment$attachmentState' => '

The state of the attachment. The following are the possible values:

', ], ], 'DirectConnectGatewayAttachmentType' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGatewayAttachment$attachmentType' => '

The type of attachment.

', ], ], 'DirectConnectGatewayId' => [ 'base' => NULL, 'refs' => [ 'AcceptDirectConnectGatewayAssociationProposalRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'ConfirmPrivateVirtualInterfaceRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'ConfirmTransitVirtualInterfaceRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'CreateDirectConnectGatewayAssociationProposalRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'CreateDirectConnectGatewayAssociationRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DeleteDirectConnectGatewayAssociationRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DeleteDirectConnectGatewayRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DescribeDirectConnectGatewayAssociationProposalsRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DescribeDirectConnectGatewayAssociationsRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DescribeDirectConnectGatewayAttachmentsRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DescribeDirectConnectGatewaysRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DirectConnectGateway$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DirectConnectGatewayAssociation$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DirectConnectGatewayAssociationProposal$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DirectConnectGatewayAttachment$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'NewPrivateVirtualInterface$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'NewTransitVirtualInterface$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'UpdateDirectConnectGatewayRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway to update.

', 'VirtualInterface$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', ], ], 'DirectConnectGatewayList' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewaysResult$directConnectGateways' => '

The Direct Connect gateways.

', ], ], 'DirectConnectGatewayName' => [ 'base' => NULL, 'refs' => [ 'CreateDirectConnectGatewayRequest$directConnectGatewayName' => '

The name of the Direct Connect gateway.

', 'DirectConnectGateway$directConnectGatewayName' => '

The name of the Direct Connect gateway.

', 'UpdateDirectConnectGatewayRequest$newDirectConnectGatewayName' => '

The new name for the Direct Connect gateway.

', ], ], 'DirectConnectGatewayState' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGateway$directConnectGatewayState' => '

The state of the Direct Connect gateway. The following are the possible values:

', ], ], 'DirectConnectServerException' => [ 'base' => '

A server-side error occurred.

', 'refs' => [], ], 'DisassociateConnectionFromLagRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateMacSecKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateMacSecKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DuplicateTagKeysException' => [ 'base' => '

A tag key was specified more than once.

', 'refs' => [], ], 'EnableSiteLink' => [ 'base' => NULL, 'refs' => [ 'NewPrivateVirtualInterface$enableSiteLink' => '

Indicates whether to enable or disable SiteLink.

', 'NewTransitVirtualInterface$enableSiteLink' => '

Indicates whether to enable or disable SiteLink.

', 'UpdateVirtualInterfaceAttributesRequest$enableSiteLink' => '

Indicates whether to enable or disable SiteLink.

', ], ], 'EncryptionMode' => [ 'base' => NULL, 'refs' => [ 'Connection$encryptionMode' => '

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

', 'Lag$encryptionMode' => '

The LAG MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

', 'UpdateConnectionRequest$encryptionMode' => '

The connection MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

', 'UpdateLagRequest$encryptionMode' => '

The LAG MAC Security (MACsec) encryption mode.

Amazon Web Services applies the value to all connections which are part of the LAG.

', ], ], 'EndTime' => [ 'base' => NULL, 'refs' => [ 'VirtualInterfaceTestHistory$endTime' => '

The time that the virtual interface moves out of the DOWN state.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'DirectConnectClientException$message' => NULL, 'DirectConnectServerException$message' => NULL, ], ], 'FailureTestHistoryStatus' => [ 'base' => NULL, 'refs' => [ 'ListVirtualInterfaceTestHistoryRequest$status' => '

The status of the virtual interface failover test.

', 'VirtualInterfaceTestHistory$status' => '

The status of the virtual interface failover test.

', ], ], 'GatewayIdToAssociate' => [ 'base' => NULL, 'refs' => [ 'CreateDirectConnectGatewayAssociationProposalRequest$gatewayId' => '

The ID of the virtual private gateway or transit gateway.

', 'CreateDirectConnectGatewayAssociationRequest$gatewayId' => '

The ID of the virtual private gateway or transit gateway.

', ], ], 'GatewayIdentifier' => [ 'base' => NULL, 'refs' => [ 'AssociatedGateway$id' => '

The ID of the associated gateway.

', ], ], 'GatewayType' => [ 'base' => NULL, 'refs' => [ 'AssociatedGateway$type' => '

The type of associated gateway.

', ], ], 'HasLogicalRedundancy' => [ 'base' => NULL, 'refs' => [ 'Connection$hasLogicalRedundancy' => '

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

', 'Interconnect$hasLogicalRedundancy' => '

Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

', 'Lag$hasLogicalRedundancy' => '

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

', ], ], 'Interconnect' => [ 'base' => '

Information about an interconnect.

', 'refs' => [ 'InterconnectList$member' => NULL, ], ], 'InterconnectId' => [ 'base' => NULL, 'refs' => [ 'AllocateConnectionOnInterconnectRequest$interconnectId' => '

The ID of the interconnect on which the connection will be provisioned.

', 'DeleteInterconnectRequest$interconnectId' => '

The ID of the interconnect.

', 'DescribeConnectionsOnInterconnectRequest$interconnectId' => '

The ID of the interconnect.

', 'DescribeInterconnectLoaRequest$interconnectId' => '

The ID of the interconnect.

', 'DescribeInterconnectsRequest$interconnectId' => '

The ID of the interconnect.

', 'Interconnect$interconnectId' => '

The ID of the interconnect.

', ], ], 'InterconnectList' => [ 'base' => NULL, 'refs' => [ 'Interconnects$interconnects' => '

The interconnects.

', ], ], 'InterconnectName' => [ 'base' => NULL, 'refs' => [ 'CreateInterconnectRequest$interconnectName' => '

The name of the interconnect.

', 'Interconnect$interconnectName' => '

The name of the interconnect.

', ], ], 'InterconnectState' => [ 'base' => NULL, 'refs' => [ 'DeleteInterconnectResponse$interconnectState' => '

The state of the interconnect. The following are the possible values:

', 'Interconnect$interconnectState' => '

The state of the interconnect. The following are the possible values:

', ], ], 'Interconnects' => [ 'base' => NULL, 'refs' => [], ], 'JumboFrameCapable' => [ 'base' => NULL, 'refs' => [ 'Connection$jumboFrameCapable' => '

Indicates whether jumbo frames are supported.

', 'Interconnect$jumboFrameCapable' => '

Indicates whether jumbo frames are supported.

', 'Lag$jumboFrameCapable' => '

Indicates whether jumbo frames are supported.

', 'VirtualInterface$jumboFrameCapable' => '

Indicates whether jumbo frames are supported.

', ], ], 'Lag' => [ 'base' => '

Information about a link aggregation group (LAG).

', 'refs' => [ 'LagList$member' => NULL, ], ], 'LagId' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectionWithLagRequest$lagId' => '

The ID of the LAG with which to associate the connection.

', 'Connection$lagId' => '

The ID of the LAG.

', 'CreateConnectionRequest$lagId' => '

The ID of the LAG.

', 'CreateInterconnectRequest$lagId' => '

The ID of the LAG.

', 'DeleteLagRequest$lagId' => '

The ID of the LAG.

', 'DescribeLagsRequest$lagId' => '

The ID of the LAG.

', 'DisassociateConnectionFromLagRequest$lagId' => '

The ID of the LAG.

', 'Interconnect$lagId' => '

The ID of the LAG.

', 'Lag$lagId' => '

The ID of the LAG.

', 'UpdateLagRequest$lagId' => '

The ID of the LAG.

', ], ], 'LagList' => [ 'base' => NULL, 'refs' => [ 'Lags$lags' => '

The LAGs.

', ], ], 'LagName' => [ 'base' => NULL, 'refs' => [ 'CreateLagRequest$lagName' => '

The name of the LAG.

', 'Lag$lagName' => '

The name of the LAG.

', 'UpdateLagRequest$lagName' => '

The name of the LAG.

', ], ], 'LagState' => [ 'base' => NULL, 'refs' => [ 'Lag$lagState' => '

The state of the LAG. The following are the possible values:

', ], ], 'Lags' => [ 'base' => NULL, 'refs' => [], ], 'ListVirtualInterfaceTestHistoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVirtualInterfaceTestHistoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'Loa' => [ 'base' => '

Information about a Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for a connection.

', 'refs' => [ 'DescribeConnectionLoaResponse$loa' => '

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

', 'DescribeInterconnectLoaResponse$loa' => '

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

', ], ], 'LoaContent' => [ 'base' => NULL, 'refs' => [ 'Loa$loaContent' => '

The binary contents of the LOA-CFA document.

', ], ], 'LoaContentType' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectionLoaRequest$loaContentType' => '

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

', 'DescribeInterconnectLoaRequest$loaContentType' => '

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

', 'DescribeLoaRequest$loaContentType' => '

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

', 'Loa$loaContentType' => '

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

', ], ], 'LoaIssueTime' => [ 'base' => NULL, 'refs' => [ 'Connection$loaIssueTime' => '

The time of the most recent call to DescribeLoa for this connection.

', 'Interconnect$loaIssueTime' => '

The time of the most recent call to DescribeLoa for this connection.

', ], ], 'Location' => [ 'base' => '

Information about an Direct Connect location.

', 'refs' => [ 'LocationList$member' => NULL, ], ], 'LocationCode' => [ 'base' => NULL, 'refs' => [ 'Connection$location' => '

The location of the connection.

', 'CreateConnectionRequest$location' => '

The location of the connection.

', 'CreateInterconnectRequest$location' => '

The location of the interconnect.

', 'CreateLagRequest$location' => '

The location for the LAG.

', 'Interconnect$location' => '

The location of the connection.

', 'Lag$location' => '

The location of the LAG.

', 'Location$locationCode' => '

The code for the location.

', 'VirtualInterface$location' => '

The location of the connection.

', ], ], 'LocationList' => [ 'base' => NULL, 'refs' => [ 'Locations$locations' => '

The locations.

', ], ], 'LocationName' => [ 'base' => NULL, 'refs' => [ 'Location$locationName' => '

The name of the location. This includes the name of the colocation partner and the physical site of the building.

', ], ], 'Locations' => [ 'base' => NULL, 'refs' => [], ], 'LongAsn' => [ 'base' => NULL, 'refs' => [ 'CreateDirectConnectGatewayRequest$amazonSideAsn' => '

The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.

', 'DirectConnectGateway$amazonSideAsn' => '

The autonomous system number (ASN) for the Amazon side of the connection.

', 'VirtualInterface$amazonSideAsn' => '

The autonomous system number (ASN) for the Amazon side of the connection.

', ], ], 'MTU' => [ 'base' => NULL, 'refs' => [ 'NewPrivateVirtualInterface$mtu' => '

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

', 'NewPrivateVirtualInterfaceAllocation$mtu' => '

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

', 'NewTransitVirtualInterface$mtu' => '

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

', 'NewTransitVirtualInterfaceAllocation$mtu' => '

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

', 'UpdateVirtualInterfaceAttributesRequest$mtu' => '

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

', 'VirtualInterface$mtu' => '

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

', ], ], 'MacSecCapable' => [ 'base' => NULL, 'refs' => [ 'Connection$macSecCapable' => '

Indicates whether the connection supports MAC Security (MACsec).

', 'Lag$macSecCapable' => '

Indicates whether the LAG supports MAC Security (MACsec).

', ], ], 'MacSecKey' => [ 'base' => '

Information about the MAC Security (MACsec) secret key.

', 'refs' => [ 'MacSecKeyList$member' => NULL, ], ], 'MacSecKeyList' => [ 'base' => NULL, 'refs' => [ 'AssociateMacSecKeyResponse$macSecKeys' => '

The MAC Security (MACsec) security keys associated with the dedicated connection.

', 'Connection$macSecKeys' => '

The MAC Security (MACsec) security keys associated with the connection.

', 'DisassociateMacSecKeyResponse$macSecKeys' => '

The MAC Security (MACsec) security keys no longer associated with the dedicated connection.

', 'Lag$macSecKeys' => '

The MAC Security (MACsec) security keys associated with the LAG.

', ], ], 'MaxResultSetSize' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewayAssociationProposalsRequest$maxResults' => '

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

', 'DescribeDirectConnectGatewayAssociationsRequest$maxResults' => '

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

', 'DescribeDirectConnectGatewayAttachmentsRequest$maxResults' => '

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

', 'DescribeDirectConnectGatewaysRequest$maxResults' => '

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

', 'ListVirtualInterfaceTestHistoryRequest$maxResults' => '

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

', ], ], 'NewBGPPeer' => [ 'base' => '

Information about a new BGP peer.

', 'refs' => [ 'CreateBGPPeerRequest$newBGPPeer' => '

Information about the BGP peer.

', ], ], 'NewPrivateVirtualInterface' => [ 'base' => '

Information about a private virtual interface.

', 'refs' => [ 'CreatePrivateVirtualInterfaceRequest$newPrivateVirtualInterface' => '

Information about the private virtual interface.

', ], ], 'NewPrivateVirtualInterfaceAllocation' => [ 'base' => '

Information about a private virtual interface to be provisioned on a connection.

', 'refs' => [ 'AllocatePrivateVirtualInterfaceRequest$newPrivateVirtualInterfaceAllocation' => '

Information about the private virtual interface.

', ], ], 'NewPublicVirtualInterface' => [ 'base' => '

Information about a public virtual interface.

', 'refs' => [ 'CreatePublicVirtualInterfaceRequest$newPublicVirtualInterface' => '

Information about the public virtual interface.

', ], ], 'NewPublicVirtualInterfaceAllocation' => [ 'base' => '

Information about a public virtual interface to be provisioned on a connection.

', 'refs' => [ 'AllocatePublicVirtualInterfaceRequest$newPublicVirtualInterfaceAllocation' => '

Information about the public virtual interface.

', ], ], 'NewTransitVirtualInterface' => [ 'base' => '

Information about a transit virtual interface.

', 'refs' => [ 'CreateTransitVirtualInterfaceRequest$newTransitVirtualInterface' => '

Information about the transit virtual interface.

', ], ], 'NewTransitVirtualInterfaceAllocation' => [ 'base' => '

Information about a transit virtual interface to be provisioned on a connection.

', 'refs' => [ 'AllocateTransitVirtualInterfaceRequest$newTransitVirtualInterfaceAllocation' => '

Information about the transit virtual interface.

', ], ], 'NniPartnerType' => [ 'base' => NULL, 'refs' => [ 'DescribeCustomerMetadataResponse$nniPartnerType' => '

The type of network-to-network interface (NNI) partner. The partner type will be one of the following:

', ], ], 'OwnerAccount' => [ 'base' => NULL, 'refs' => [ 'AcceptDirectConnectGatewayAssociationProposalRequest$associatedGatewayOwnerAccount' => '

The ID of the Amazon Web Services account that owns the virtual private gateway or transit gateway.

', 'AllocateConnectionOnInterconnectRequest$ownerAccount' => '

The ID of the Amazon Web Services account of the customer for whom the connection will be provisioned.

', 'AllocateHostedConnectionRequest$ownerAccount' => '

The ID of the Amazon Web Services account ID of the customer for the connection.

', 'AllocatePrivateVirtualInterfaceRequest$ownerAccount' => '

The ID of the Amazon Web Services account that owns the virtual private interface.

', 'AllocatePublicVirtualInterfaceRequest$ownerAccount' => '

The ID of the Amazon Web Services account that owns the public virtual interface.

', 'AllocateTransitVirtualInterfaceRequest$ownerAccount' => '

The ID of the Amazon Web Services account that owns the transit virtual interface.

', 'AssociatedGateway$ownerAccount' => '

The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.

', 'Connection$ownerAccount' => '

The ID of the Amazon Web Services account that owns the connection.

', 'CreateDirectConnectGatewayAssociationProposalRequest$directConnectGatewayOwnerAccount' => '

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

', 'DirectConnectGateway$ownerAccount' => '

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

', 'DirectConnectGatewayAssociation$directConnectGatewayOwnerAccount' => '

The ID of the Amazon Web Services account that owns the associated gateway.

', 'DirectConnectGatewayAssociation$virtualGatewayOwnerAccount' => '

The ID of the Amazon Web Services account that owns the virtual private gateway.

', 'DirectConnectGatewayAssociationProposal$directConnectGatewayOwnerAccount' => '

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

', 'DirectConnectGatewayAttachment$virtualInterfaceOwnerAccount' => '

The ID of the Amazon Web Services account that owns the virtual interface.

', 'Lag$ownerAccount' => '

The ID of the Amazon Web Services account that owns the LAG.

', 'VirtualInterface$ownerAccount' => '

The ID of the Amazon Web Services account that owns the virtual interface.

', 'VirtualInterfaceTestHistory$ownerAccount' => '

The owner ID of the tested virtual interface.

', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewayAssociationProposalsRequest$nextToken' => '

The token for the next page of results.

', 'DescribeDirectConnectGatewayAssociationProposalsResult$nextToken' => '

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

', 'DescribeDirectConnectGatewayAssociationsRequest$nextToken' => '

The token provided in the previous call to retrieve the next page.

', 'DescribeDirectConnectGatewayAssociationsResult$nextToken' => '

The token to retrieve the next page.

', 'DescribeDirectConnectGatewayAttachmentsRequest$nextToken' => '

The token provided in the previous call to retrieve the next page.

', 'DescribeDirectConnectGatewayAttachmentsResult$nextToken' => '

The token to retrieve the next page.

', 'DescribeDirectConnectGatewaysRequest$nextToken' => '

The token provided in the previous call to retrieve the next page.

', 'DescribeDirectConnectGatewaysResult$nextToken' => '

The token to retrieve the next page.

', 'ListVirtualInterfaceTestHistoryRequest$nextToken' => '

The token for the next page of results.

', 'ListVirtualInterfaceTestHistoryResponse$nextToken' => '

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

', ], ], 'PartnerName' => [ 'base' => NULL, 'refs' => [ 'Connection$partnerName' => '

The name of the Direct Connect service provider associated with the connection.

', ], ], 'Platform' => [ 'base' => NULL, 'refs' => [ 'RouterType$platform' => '

The virtual interface router platform.

', ], ], 'PortEncryptionStatus' => [ 'base' => NULL, 'refs' => [ 'Connection$portEncryptionStatus' => '

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

', ], ], 'PortSpeed' => [ 'base' => NULL, 'refs' => [ 'AvailableMacSecPortSpeeds$member' => NULL, 'AvailablePortSpeeds$member' => NULL, ], ], 'ProviderList' => [ 'base' => NULL, 'refs' => [ 'Location$availableProviders' => '

The name of the service provider for the location.

', ], ], 'ProviderName' => [ 'base' => NULL, 'refs' => [ 'Connection$providerName' => '

The name of the service provider associated with the connection.

', 'CreateConnectionRequest$providerName' => '

The name of the service provider associated with the requested connection.

', 'CreateInterconnectRequest$providerName' => '

The name of the service provider associated with the interconnect.

', 'CreateLagRequest$providerName' => '

The name of the service provider associated with the LAG.

', 'DescribeConnectionLoaRequest$providerName' => '

The name of the APN partner or service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

', 'DescribeInterconnectLoaRequest$providerName' => '

The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

', 'DescribeLoaRequest$providerName' => '

The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

', 'Interconnect$providerName' => '

The name of the service provider associated with the interconnect.

', 'Lag$providerName' => '

The name of the service provider associated with the LAG.

', 'ProviderList$member' => NULL, ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'AssociatedGateway$region' => '

The Region where the associated gateway is located.

', 'Connection$region' => '

The Amazon Web Services Region where the connection is located.

', 'Interconnect$region' => '

The Amazon Web Services Region where the connection is located.

', 'Lag$region' => '

The Amazon Web Services Region where the connection is located.

', 'Location$region' => '

The Amazon Web Services Region for the location.

', 'VirtualInterface$region' => '

The Amazon Web Services Region where the virtual interface is located.

', ], ], 'RequestMACSec' => [ 'base' => NULL, 'refs' => [ 'CreateConnectionRequest$requestMACSec' => '

Indicates whether you want the connection to support MAC Security (MACsec).

MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

', 'CreateLagRequest$requestMACSec' => '

Indicates whether the connection will support MAC Security (MACsec).

All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'ResourceArnList$member' => NULL, 'ResourceTag$resourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'TagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'UntagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', ], ], 'ResourceArnList' => [ 'base' => NULL, 'refs' => [ 'DescribeTagsRequest$resourceArns' => '

The Amazon Resource Names (ARNs) of the resources.

', ], ], 'ResourceTag' => [ 'base' => '

Information about a tag associated with an Direct Connect resource.

', 'refs' => [ 'ResourceTagList$member' => NULL, ], ], 'ResourceTagList' => [ 'base' => NULL, 'refs' => [ 'DescribeTagsResponse$resourceTags' => '

Information about the tags.

', ], ], 'RouteFilterPrefix' => [ 'base' => '

Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

', 'refs' => [ 'RouteFilterPrefixList$member' => NULL, ], ], 'RouteFilterPrefixList' => [ 'base' => NULL, 'refs' => [ 'AcceptDirectConnectGatewayAssociationProposalRequest$overrideAllowedPrefixesToDirectConnectGateway' => '

Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.

', 'CreateDirectConnectGatewayAssociationProposalRequest$addAllowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

', 'CreateDirectConnectGatewayAssociationProposalRequest$removeAllowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

', 'CreateDirectConnectGatewayAssociationRequest$addAllowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to advertise to the Direct Connect gateway

This parameter is required when you create an association to a transit gateway.

For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.

', 'DirectConnectGatewayAssociation$allowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

', 'DirectConnectGatewayAssociationProposal$existingAllowedPrefixesToDirectConnectGateway' => '

The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

', 'DirectConnectGatewayAssociationProposal$requestedAllowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

', 'NewPublicVirtualInterface$routeFilterPrefixes' => '

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

', 'NewPublicVirtualInterfaceAllocation$routeFilterPrefixes' => '

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

', 'UpdateDirectConnectGatewayAssociationRequest$addAllowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

', 'UpdateDirectConnectGatewayAssociationRequest$removeAllowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

', 'VirtualInterface$routeFilterPrefixes' => '

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

', ], ], 'RouterConfig' => [ 'base' => NULL, 'refs' => [ 'DescribeRouterConfigurationResponse$customerRouterConfig' => '

The customer router configuration.

', 'VirtualInterface$customerRouterConfig' => '

The customer router configuration.

', ], ], 'RouterType' => [ 'base' => '

Information about the virtual router.

', 'refs' => [ 'DescribeRouterConfigurationResponse$router' => '

The details about the router.

', ], ], 'RouterTypeIdentifier' => [ 'base' => NULL, 'refs' => [ 'DescribeRouterConfigurationRequest$routerTypeIdentifier' => '

Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

', 'RouterType$routerTypeIdentifier' => '

Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

', ], ], 'SecretARN' => [ 'base' => NULL, 'refs' => [ 'AssociateMacSecKeyRequest$secretARN' => '

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.

You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.

If you use this request parameter, you do not use the ckn and cak request parameters.

', 'DisassociateMacSecKeyRequest$secretARN' => '

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

You can use DescribeConnections to retrieve the ARN of the MAC Security (MACsec) secret key.

', 'MacSecKey$secretARN' => '

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

', ], ], 'SiteLinkEnabled' => [ 'base' => NULL, 'refs' => [ 'VirtualInterface$siteLinkEnabled' => '

Indicates whether SiteLink is enabled.

', ], ], 'Software' => [ 'base' => NULL, 'refs' => [ 'RouterType$software' => '

The router software.

', ], ], 'StartBgpFailoverTestRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartBgpFailoverTestResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartOnDate' => [ 'base' => NULL, 'refs' => [ 'MacSecKey$startOn' => '

The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.

', ], ], 'StartTime' => [ 'base' => NULL, 'refs' => [ 'VirtualInterfaceTestHistory$startTime' => '

The time that the virtual interface moves to the DOWN state.

', ], ], 'State' => [ 'base' => NULL, 'refs' => [ 'MacSecKey$state' => '

The state of the MAC Security (MACsec) secret key.

The possible values are:

', ], ], 'StateChangeError' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGateway$stateChangeError' => '

The error message if the state of an object failed to advance.

', 'DirectConnectGatewayAssociation$stateChangeError' => '

The error message if the state of an object failed to advance.

', 'DirectConnectGatewayAttachment$stateChangeError' => '

The error message if the state of an object failed to advance.

', ], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'ConfirmCustomerAgreementResponse$status' => '

The status of the customer agreement when the connection was created. This will be either signed or unsigned.

', 'CustomerAgreement$status' => '

The status of the customer agreement. This will be either signed or unsigned

', ], ], 'StopBgpFailoverTestRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopBgpFailoverTestResponse' => [ 'base' => NULL, 'refs' => [], ], 'Tag' => [ 'base' => '

Information about a tag.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => '

The key.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

The tag keys of the tags to remove.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AllocateHostedConnectionRequest$tags' => '

The tags associated with the connection.

', 'Connection$tags' => '

The tags associated with the connection.

', 'CreateConnectionRequest$tags' => '

The tags to associate with the lag.

', 'CreateInterconnectRequest$tags' => '

The tags to associate with the interconnect.

', 'CreateLagRequest$tags' => '

The tags to associate with the LAG.

', 'CreateLagRequest$childConnectionTags' => '

The tags to associate with the automtically created LAGs.

', 'Interconnect$tags' => '

The tags associated with the interconnect.

', 'Lag$tags' => '

The tags associated with the LAG.

', 'NewPrivateVirtualInterface$tags' => '

The tags associated with the private virtual interface.

', 'NewPrivateVirtualInterfaceAllocation$tags' => '

The tags associated with the private virtual interface.

', 'NewPublicVirtualInterface$tags' => '

The tags associated with the public virtual interface.

', 'NewPublicVirtualInterfaceAllocation$tags' => '

The tags associated with the public virtual interface.

', 'NewTransitVirtualInterface$tags' => '

The tags associated with the transitive virtual interface.

', 'NewTransitVirtualInterfaceAllocation$tags' => '

The tags associated with the transitive virtual interface.

', 'ResourceTag$tags' => '

The tags.

', 'TagResourceRequest$tags' => '

The tags to add.

', 'VirtualInterface$tags' => '

The tags associated with the virtual interface.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => '

The value.

', ], ], 'TestDuration' => [ 'base' => NULL, 'refs' => [ 'StartBgpFailoverTestRequest$testDurationInMinutes' => '

The time in minutes that the virtual interface failover test will last.

Maximum value: 4,320 minutes (72 hours).

Default: 180 minutes (3 hours).

', 'VirtualInterfaceTestHistory$testDurationInMinutes' => '

The time that the virtual interface failover test ran in minutes.

', ], ], 'TestId' => [ 'base' => NULL, 'refs' => [ 'ListVirtualInterfaceTestHistoryRequest$testId' => '

The ID of the virtual interface failover test.

', 'VirtualInterfaceTestHistory$testId' => '

The ID of the virtual interface failover test.

', ], ], 'TooManyTagsException' => [ 'base' => '

You have reached the limit on the number of tags that can be assigned.

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDirectConnectGatewayAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDirectConnectGatewayAssociationResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDirectConnectGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDirectConnectGatewayResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLagRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVirtualInterfaceAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'VLAN' => [ 'base' => NULL, 'refs' => [ 'AllocateConnectionOnInterconnectRequest$vlan' => '

The dedicated VLAN provisioned to the connection.

', 'AllocateHostedConnectionRequest$vlan' => '

The dedicated VLAN provisioned to the hosted connection.

', 'Connection$vlan' => '

The ID of the VLAN.

', 'NewPrivateVirtualInterface$vlan' => '

The ID of the VLAN.

', 'NewPrivateVirtualInterfaceAllocation$vlan' => '

The ID of the VLAN.

', 'NewPublicVirtualInterface$vlan' => '

The ID of the VLAN.

', 'NewPublicVirtualInterfaceAllocation$vlan' => '

The ID of the VLAN.

', 'NewTransitVirtualInterface$vlan' => '

The ID of the VLAN.

', 'NewTransitVirtualInterfaceAllocation$vlan' => '

The ID of the VLAN.

', 'VirtualInterface$vlan' => '

The ID of the VLAN.

', ], ], 'Vendor' => [ 'base' => NULL, 'refs' => [ 'RouterType$vendor' => '

The vendor for the virtual interface\'s router.

', ], ], 'VirtualGateway' => [ 'base' => '

Information about a virtual private gateway for a private virtual interface.

', 'refs' => [ 'VirtualGatewayList$member' => NULL, ], ], 'VirtualGatewayId' => [ 'base' => NULL, 'refs' => [ 'ConfirmPrivateVirtualInterfaceRequest$virtualGatewayId' => '

The ID of the virtual private gateway.

', 'CreateDirectConnectGatewayAssociationRequest$virtualGatewayId' => '

The ID of the virtual private gateway.

', 'DeleteDirectConnectGatewayAssociationRequest$virtualGatewayId' => '

The ID of the virtual private gateway.

', 'DescribeDirectConnectGatewayAssociationsRequest$virtualGatewayId' => '

The ID of the virtual private gateway or transit gateway.

', 'DirectConnectGatewayAssociation$virtualGatewayId' => '

The ID of the virtual private gateway. Applies only to private virtual interfaces.

', 'NewPrivateVirtualInterface$virtualGatewayId' => '

The ID of the virtual private gateway.

', 'VirtualGateway$virtualGatewayId' => '

The ID of the virtual private gateway.

', 'VirtualInterface$virtualGatewayId' => '

The ID of the virtual private gateway. Applies only to private virtual interfaces.

', ], ], 'VirtualGatewayList' => [ 'base' => NULL, 'refs' => [ 'VirtualGateways$virtualGateways' => '

The virtual private gateways.

', ], ], 'VirtualGatewayRegion' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGatewayAssociation$virtualGatewayRegion' => '

The Amazon Web Services Region where the virtual private gateway is located.

', ], ], 'VirtualGatewayState' => [ 'base' => NULL, 'refs' => [ 'VirtualGateway$virtualGatewayState' => '

The state of the virtual private gateway. The following are the possible values:

', ], ], 'VirtualGateways' => [ 'base' => NULL, 'refs' => [], ], 'VirtualInterface' => [ 'base' => '

Information about a virtual interface.

', 'refs' => [ 'AllocateTransitVirtualInterfaceResult$virtualInterface' => '

Information about the transit virtual interface.

', 'CreateBGPPeerResponse$virtualInterface' => '

The virtual interface.

', 'CreateTransitVirtualInterfaceResult$virtualInterface' => '

Information about a virtual interface.

', 'DeleteBGPPeerResponse$virtualInterface' => '

The virtual interface.

', 'VirtualInterfaceList$member' => NULL, ], ], 'VirtualInterfaceId' => [ 'base' => NULL, 'refs' => [ 'AssociateVirtualInterfaceRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'ConfirmPrivateVirtualInterfaceRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'ConfirmPublicVirtualInterfaceRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'ConfirmTransitVirtualInterfaceRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'CreateBGPPeerRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'DeleteBGPPeerRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'DeleteVirtualInterfaceRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'DescribeDirectConnectGatewayAttachmentsRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'DescribeRouterConfigurationRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'DescribeRouterConfigurationResponse$virtualInterfaceId' => '

The ID assigned to the virtual interface.

', 'DescribeVirtualInterfacesRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'DirectConnectGatewayAttachment$virtualInterfaceId' => '

The ID of the virtual interface.

', 'ListVirtualInterfaceTestHistoryRequest$virtualInterfaceId' => '

The ID of the virtual interface that was tested.

', 'StartBgpFailoverTestRequest$virtualInterfaceId' => '

The ID of the virtual interface you want to test.

', 'StopBgpFailoverTestRequest$virtualInterfaceId' => '

The ID of the virtual interface you no longer want to test.

', 'UpdateVirtualInterfaceAttributesRequest$virtualInterfaceId' => '

The ID of the virtual private interface.

', 'VirtualInterface$virtualInterfaceId' => '

The ID of the virtual interface.

', 'VirtualInterfaceTestHistory$virtualInterfaceId' => '

The ID of the tested virtual interface.

', ], ], 'VirtualInterfaceList' => [ 'base' => NULL, 'refs' => [ 'VirtualInterfaces$virtualInterfaces' => '

The virtual interfaces

', ], ], 'VirtualInterfaceName' => [ 'base' => NULL, 'refs' => [ 'DescribeRouterConfigurationResponse$virtualInterfaceName' => '

Provides the details about a virtual interface\'s router.

', 'NewPrivateVirtualInterface$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', 'NewPrivateVirtualInterfaceAllocation$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', 'NewPublicVirtualInterface$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', 'NewPublicVirtualInterfaceAllocation$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', 'NewTransitVirtualInterface$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', 'NewTransitVirtualInterfaceAllocation$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', 'UpdateVirtualInterfaceAttributesRequest$virtualInterfaceName' => '

The name of the virtual private interface.

', 'VirtualInterface$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', ], ], 'VirtualInterfaceRegion' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGatewayAttachment$virtualInterfaceRegion' => '

The Amazon Web Services Region where the virtual interface is located.

', ], ], 'VirtualInterfaceState' => [ 'base' => NULL, 'refs' => [ 'ConfirmPrivateVirtualInterfaceResponse$virtualInterfaceState' => '

The state of the virtual interface. The following are the possible values:

', 'ConfirmPublicVirtualInterfaceResponse$virtualInterfaceState' => '

The state of the virtual interface. The following are the possible values:

', 'ConfirmTransitVirtualInterfaceResponse$virtualInterfaceState' => '

The state of the virtual interface. The following are the possible values:

', 'DeleteVirtualInterfaceResponse$virtualInterfaceState' => '

The state of the virtual interface. The following are the possible values:

', 'VirtualInterface$virtualInterfaceState' => '

The state of the virtual interface. The following are the possible values:

', ], ], 'VirtualInterfaceTestHistory' => [ 'base' => '

Information about the virtual interface failover test.

', 'refs' => [ 'StartBgpFailoverTestResponse$virtualInterfaceTest' => '

Information about the virtual interface failover test.

', 'StopBgpFailoverTestResponse$virtualInterfaceTest' => '

Information about the virtual interface failover test.

', 'VirtualInterfaceTestHistoryList$member' => NULL, ], ], 'VirtualInterfaceTestHistoryList' => [ 'base' => NULL, 'refs' => [ 'ListVirtualInterfaceTestHistoryResponse$virtualInterfaceTestHistory' => '

The ID of the tested virtual interface.

', ], ], 'VirtualInterfaceType' => [ 'base' => NULL, 'refs' => [ 'VirtualInterface$virtualInterfaceType' => '

The type of virtual interface. The possible values are private, public and transit.

', ], ], 'VirtualInterfaces' => [ 'base' => NULL, 'refs' => [], ], 'XsltTemplateName' => [ 'base' => NULL, 'refs' => [ 'RouterType$xsltTemplateName' => '

The template for the virtual interface\'s router.

', ], ], 'XsltTemplateNameForMacSec' => [ 'base' => NULL, 'refs' => [ 'RouterType$xsltTemplateNameForMacSec' => '

The MAC Security (MACsec) template for the virtual interface\'s router.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => '

Direct Connect links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router. With this connection in place, you can create virtual interfaces directly to the Amazon Web Services Cloud (for example, to Amazon EC2 and Amazon S3) and to Amazon VPC, bypassing Internet service providers in your network path. A connection provides access to all Amazon Web Services Regions except the China (Beijing) and (China) Ningxia Regions. Amazon Web Services resources in the China Regions can only be accessed through locations associated with those Regions.

', 'operations' => [ 'AcceptDirectConnectGatewayAssociationProposal' => '

Accepts a proposal request to attach a virtual private gateway or transit gateway to a Direct Connect gateway.

', 'AllocateConnectionOnInterconnect' => '

Deprecated. Use AllocateHostedConnection instead.

Creates a hosted connection on an interconnect.

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.

Intended for use by Direct Connect Partners only.

', 'AllocateHostedConnection' => '

Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.

Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.

Intended for use by Direct Connect Partners only.

', 'AllocatePrivateVirtualInterface' => '

Provisions a private virtual interface to be owned by the specified Amazon Web Services account.

Virtual interfaces created using this action must be confirmed by the owner using ConfirmPrivateVirtualInterface. Until then, the virtual interface is in the Confirming state and is not available to handle traffic.

', 'AllocatePublicVirtualInterface' => '

Provisions a public virtual interface to be owned by the specified Amazon Web Services account.

The owner of a connection calls this function to provision a public virtual interface to be owned by the specified Amazon Web Services account.

Virtual interfaces created using this function must be confirmed by the owner using ConfirmPublicVirtualInterface. Until this step has been completed, the virtual interface is in the confirming state and is not available to handle traffic.

When creating an IPv6 public virtual interface, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

', 'AllocateTransitVirtualInterface' => '

Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.

The owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account.

After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.

', 'AssociateConnectionWithLag' => '

Associates an existing connection with a link aggregation group (LAG). The connection is interrupted and re-established as a member of the LAG (connectivity to Amazon Web Services is interrupted). The connection must be hosted on the same Direct Connect endpoint as the LAG, and its bandwidth must match the bandwidth for the LAG. You can re-associate a connection that\'s currently associated with a different LAG; however, if removing the connection would cause the original LAG to fall below its setting for minimum number of operational connections, the request fails.

Any virtual interfaces that are directly associated with the connection are automatically re-associated with the LAG. If the connection was originally associated with a different LAG, the virtual interfaces remain associated with the original LAG.

For interconnects, any hosted connections are automatically re-associated with the LAG. If the interconnect was originally associated with a different LAG, the hosted connections remain associated with the original LAG.

', 'AssociateHostedConnection' => '

Associates a hosted connection and its virtual interfaces with a link aggregation group (LAG) or interconnect. If the target interconnect or LAG has an existing hosted connection with a conflicting VLAN number or IP address, the operation fails. This action temporarily interrupts the hosted connection\'s connectivity to Amazon Web Services as it is being migrated.

Intended for use by Direct Connect Partners only.

', 'AssociateMacSecKey' => '

Associates a MAC Security (MACsec) Connection Key Name (CKN)/ Connectivity Association Key (CAK) pair with an Direct Connect dedicated connection.

You must supply either the secretARN, or the CKN/CAK (ckn and cak) pair in the request.

For information about MAC Security (MACsec) key considerations, see MACsec pre-shared CKN/CAK key considerations in the Direct Connect User Guide.

', 'AssociateVirtualInterface' => '

Associates a virtual interface with a specified link aggregation group (LAG) or connection. Connectivity to Amazon Web Services is temporarily interrupted as the virtual interface is being migrated. If the target connection or LAG has an associated virtual interface with a conflicting VLAN number or a conflicting IP address, the operation fails.

Virtual interfaces associated with a hosted connection cannot be associated with a LAG; hosted connections must be migrated along with their virtual interfaces using AssociateHostedConnection.

To reassociate a virtual interface to a new connection or LAG, the requester must own either the virtual interface itself or the connection to which the virtual interface is currently associated. Additionally, the requester must own the connection or LAG for the association.

', 'ConfirmConnection' => '

Confirms the creation of the specified hosted connection on an interconnect.

Upon creation, the hosted connection is initially in the Ordering state, and remains in this state until the owner confirms creation of the hosted connection.

', 'ConfirmCustomerAgreement' => '

The confirmation of the terms of agreement when creating the connection/link aggregation group (LAG).

', 'ConfirmPrivateVirtualInterface' => '

Accepts ownership of a private virtual interface created by another Amazon Web Services account.

After the virtual interface owner makes this call, the virtual interface is created and attached to the specified virtual private gateway or Direct Connect gateway, and is made available to handle traffic.

', 'ConfirmPublicVirtualInterface' => '

Accepts ownership of a public virtual interface created by another Amazon Web Services account.

After the virtual interface owner makes this call, the specified virtual interface is created and made available to handle traffic.

', 'ConfirmTransitVirtualInterface' => '

Accepts ownership of a transit virtual interface created by another Amazon Web Services account.

After the owner of the transit virtual interface makes this call, the specified transit virtual interface is created and made available to handle traffic.

', 'CreateBGPPeer' => '

Creates a BGP peer on the specified virtual interface.

You must create a BGP peer for the corresponding address family (IPv4/IPv6) in order to access Amazon Web Services resources that also use that address family.

If logical redundancy is not supported by the connection, interconnect, or LAG, the BGP peer cannot be in the same address family as an existing BGP peer on the virtual interface.

When creating a IPv6 BGP peer, omit the Amazon address and customer address. IPv6 addresses are automatically assigned from the Amazon pool of IPv6 addresses; you cannot specify custom IPv6 addresses.

If you let Amazon Web Services auto-assign IPv4 addresses, a /30 CIDR will be allocated from 169.254.0.0/16. Amazon Web Services does not recommend this option if you intend to use the customer router peer IP address as the source and destination for traffic. Instead you should use RFC 1918 or other addressing, and specify the address yourself. For more information about RFC 1918 see Address Allocation for Private Internets.

For a public virtual interface, the Autonomous System Number (ASN) must be private or already on the allow list for the virtual interface.

', 'CreateConnection' => '

Creates a connection between a customer network and a specific Direct Connect location.

A connection links your internal network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Direct Connect router.

To find the locations for your Region, use DescribeLocations.

You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.

', 'CreateDirectConnectGateway' => '

Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any Amazon Web Services Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different Amazon Web Services Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.

', 'CreateDirectConnectGatewayAssociation' => '

Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway must be attached to a VPC and must not be associated with another Direct Connect gateway.

', 'CreateDirectConnectGatewayAssociationProposal' => '

Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.

You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any Amazon Web Services account.

', 'CreateInterconnect' => '

Creates an interconnect between an Direct Connect Partner\'s network and a specific Direct Connect location.

An interconnect is a connection that is capable of hosting other connections. The Direct Connect Partner can use an interconnect to provide Direct Connect hosted connections to customers through their own network services. Like a standard connection, an interconnect links the partner\'s network to an Direct Connect location over a standard Ethernet fiber-optic cable. One end is connected to the partner\'s router, the other to an Direct Connect router.

You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect is created.

For each end customer, the Direct Connect Partner provisions a connection on their interconnect by calling AllocateHostedConnection. The end customer can then connect to Amazon Web Services resources by creating a virtual interface on their connection, using the VLAN assigned to them by the Direct Connect Partner.

Intended for use by Direct Connect Partners only.

', 'CreateLag' => '

Creates a link aggregation group (LAG) with the specified number of bundled physical dedicated connections between the customer network and a specific Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple interfaces, enabling you to treat them as a single interface.

All connections in a LAG must use the same bandwidth (either 1Gbps, 10Gbps, 100Gbps, or 400Gbps) and must terminate at the same Direct Connect endpoint.

You can have up to 10 dedicated connections per location. Regardless of this limit, if you request more connections for the LAG than Direct Connect can allocate on a single endpoint, no LAG is created..

You can specify an existing physical dedicated connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical dedicated connection, and re-establishes them as a member of the LAG. The LAG will be created on the same Direct Connect endpoint to which the dedicated connection terminates. Any virtual interfaces associated with the dedicated connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.

If the Amazon Web Services account used to create a LAG is a registered Direct Connect Partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.

', 'CreatePrivateVirtualInterface' => '

Creates a private virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A private virtual interface can be connected to either a Direct Connect gateway or a Virtual Private Gateway (VGW). Connecting the private virtual interface to a Direct Connect gateway enables the possibility for connecting to multiple VPCs, including VPCs in different Amazon Web Services Regions. Connecting the private virtual interface to a VGW only provides access to a single VPC within the same Region.

Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn\'t updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

', 'CreatePublicVirtualInterface' => '

Creates a public virtual interface. A virtual interface is the VLAN that transports Direct Connect traffic. A public virtual interface supports sending traffic to public services of Amazon Web Services such as Amazon S3.

When creating an IPv6 public virtual interface (addressFamily is ipv6), leave the customer and amazon address fields blank to use auto-assigned IPv6 space. Custom IPv6 addresses are not supported.

', 'CreateTransitVirtualInterface' => '

Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.

If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails.

A jumbo MTU value must be either 1500 or 8500. No other values will be accepted. Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn\'t updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

', 'DeleteBGPPeer' => '

Deletes the specified BGP peer on the specified virtual interface with the specified customer address and ASN.

You cannot delete the last BGP peer from a virtual interface.

', 'DeleteConnection' => '

Deletes the specified connection.

Deleting a connection only stops the Direct Connect port hour and data transfer charges. If you are partnering with any third parties to connect with the Direct Connect location, you must cancel your service with them separately.

', 'DeleteDirectConnectGateway' => '

Deletes the specified Direct Connect gateway. You must first delete all virtual interfaces that are attached to the Direct Connect gateway and disassociate all virtual private gateways associated with the Direct Connect gateway.

', 'DeleteDirectConnectGatewayAssociation' => '

Deletes the association between the specified Direct Connect gateway and virtual private gateway.

We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.

', 'DeleteDirectConnectGatewayAssociationProposal' => '

Deletes the association proposal request between the specified Direct Connect gateway and virtual private gateway or transit gateway.

', 'DeleteInterconnect' => '

Deletes the specified interconnect.

Intended for use by Direct Connect Partners only.

', 'DeleteLag' => '

Deletes the specified link aggregation group (LAG). You cannot delete a LAG if it has active virtual interfaces or hosted connections.

', 'DeleteVirtualInterface' => '

Deletes a virtual interface.

', 'DescribeConnectionLoa' => '

Deprecated. Use DescribeLoa instead.

Gets the LOA-CFA for a connection.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that your APN partner or service provider uses when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.

', 'DescribeConnections' => '

Displays the specified connection or all connections in this Region.

', 'DescribeConnectionsOnInterconnect' => '

Deprecated. Use DescribeHostedConnections instead.

Lists the connections that have been provisioned on the specified interconnect.

Intended for use by Direct Connect Partners only.

', 'DescribeCustomerMetadata' => '

Get and view a list of customer agreements, along with their signed status and whether the customer is an NNIPartner, NNIPartnerV2, or a nonPartner.

', 'DescribeDirectConnectGatewayAssociationProposals' => '

Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

', 'DescribeDirectConnectGatewayAssociations' => '

Lists the associations between your Direct Connect gateways and virtual private gateways and transit gateways. You must specify one of the following:

', 'DescribeDirectConnectGatewayAttachments' => '

Lists the attachments between your Direct Connect gateways and virtual interfaces. You must specify a Direct Connect gateway, a virtual interface, or both. If you specify a Direct Connect gateway, the response contains all virtual interfaces attached to the Direct Connect gateway. If you specify a virtual interface, the response contains all Direct Connect gateways attached to the virtual interface. If you specify both, the response contains the attachment between the Direct Connect gateway and the virtual interface.

', 'DescribeDirectConnectGateways' => '

Lists all your Direct Connect gateways or only the specified Direct Connect gateway. Deleted Direct Connect gateways are not returned.

', 'DescribeHostedConnections' => '

Lists the hosted connections that have been provisioned on the specified interconnect or link aggregation group (LAG).

Intended for use by Direct Connect Partners only.

', 'DescribeInterconnectLoa' => '

Deprecated. Use DescribeLoa instead.

Gets the LOA-CFA for the specified interconnect.

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.

', 'DescribeInterconnects' => '

Lists the interconnects owned by the Amazon Web Services account or only the specified interconnect.

', 'DescribeLags' => '

Describes all your link aggregation groups (LAG) or the specified LAG.

', 'DescribeLoa' => '

Gets the LOA-CFA for a connection, interconnect, or link aggregation group (LAG).

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA) is a document that is used when establishing your cross connect to Amazon Web Services at the colocation facility. For more information, see Requesting Cross Connects at Direct Connect Locations in the Direct Connect User Guide.

', 'DescribeLocations' => '

Lists the Direct Connect locations in the current Amazon Web Services Region. These are the locations that can be selected when calling CreateConnection or CreateInterconnect.

', 'DescribeRouterConfiguration' => '

Details about the router.

', 'DescribeTags' => '

Describes the tags associated with the specified Direct Connect resources.

', 'DescribeVirtualGateways' => '

Deprecated. Use DescribeVpnGateways instead. See DescribeVPNGateways in the Amazon Elastic Compute Cloud API Reference.

Lists the virtual private gateways owned by the Amazon Web Services account.

You can create one or more Direct Connect private virtual interfaces linked to a virtual private gateway.

', 'DescribeVirtualInterfaces' => '

Displays all virtual interfaces for an Amazon Web Services account. Virtual interfaces deleted fewer than 15 minutes before you make the request are also returned. If you specify a connection ID, only the virtual interfaces associated with the connection are returned. If you specify a virtual interface ID, then only a single virtual interface is returned.

A virtual interface (VLAN) transmits the traffic between the Direct Connect location and the customer network.

', 'DisassociateConnectionFromLag' => '

Disassociates a connection from a link aggregation group (LAG). The connection is interrupted and re-established as a standalone connection (the connection is not deleted; to delete the connection, use the DeleteConnection request). If the LAG has associated virtual interfaces or hosted connections, they remain associated with the LAG. A disassociated connection owned by an Direct Connect Partner is automatically converted to an interconnect.

If disassociating the connection would cause the LAG to fall below its setting for minimum number of operational connections, the request fails, except when it\'s the last member of the LAG. If all connections are disassociated, the LAG continues to exist as an empty LAG with no physical connections.

', 'DisassociateMacSecKey' => '

Removes the association between a MAC Security (MACsec) security key and an Direct Connect dedicated connection.

', 'ListVirtualInterfaceTestHistory' => '

Lists the virtual interface failover test history.

', 'StartBgpFailoverTest' => '

Starts the virtual interface failover test that verifies your configuration meets your resiliency requirements by placing the BGP peering session in the DOWN state. You can then send traffic to verify that there are no outages.

You can run the test on public, private, transit, and hosted virtual interfaces.

You can use ListVirtualInterfaceTestHistory to view the virtual interface test history.

If you need to stop the test before the test interval completes, use StopBgpFailoverTest.

', 'StopBgpFailoverTest' => '

Stops the virtual interface failover test.

', 'TagResource' => '

Adds the specified tags to the specified Direct Connect resource. Each resource can have a maximum of 50 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the resource, this action updates its value.

', 'UntagResource' => '

Removes one or more tags from the specified Direct Connect resource.

', 'UpdateConnection' => '

Updates the Direct Connect dedicated connection configuration.

You can update the following parameters for a connection:

', 'UpdateDirectConnectGateway' => '

Updates the name of a current Direct Connect gateway.

', 'UpdateDirectConnectGatewayAssociation' => '

Updates the specified attributes of the Direct Connect gateway association.

Add or remove prefixes from the association.

', 'UpdateLag' => '

Updates the attributes of the specified link aggregation group (LAG).

You can update the following LAG attributes:

If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational.

', 'UpdateVirtualInterfaceAttributes' => '

Updates the specified attributes of the specified virtual private interface.

Setting the MTU of a virtual interface to 8500 (jumbo frames) can cause an update to the underlying physical connection if it wasn\'t updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

', ], 'shapes' => [ 'ASN' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

', 'DeleteBGPPeerRequest$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

', 'NewBGPPeer$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

', 'NewPrivateVirtualInterface$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', 'NewPrivateVirtualInterfaceAllocation$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', 'NewPublicVirtualInterface$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', 'NewPublicVirtualInterfaceAllocation$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', 'NewTransitVirtualInterface$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', 'NewTransitVirtualInterfaceAllocation$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', 'VirtualInterface$asn' => '

The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.

The valid values are 1-2147483647.

', ], ], 'AcceptDirectConnectGatewayAssociationProposalRequest' => [ 'base' => NULL, 'refs' => [], ], 'AcceptDirectConnectGatewayAssociationProposalResult' => [ 'base' => NULL, 'refs' => [], ], 'AddressFamily' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$addressFamily' => '

The address family for the BGP peer.

', 'NewBGPPeer$addressFamily' => '

The address family for the BGP peer.

', 'NewPrivateVirtualInterface$addressFamily' => '

The address family for the BGP peer.

', 'NewPrivateVirtualInterfaceAllocation$addressFamily' => '

The address family for the BGP peer.

', 'NewPublicVirtualInterface$addressFamily' => '

The address family for the BGP peer.

', 'NewPublicVirtualInterfaceAllocation$addressFamily' => '

The address family for the BGP peer.

', 'NewTransitVirtualInterface$addressFamily' => '

The address family for the BGP peer.

', 'NewTransitVirtualInterfaceAllocation$addressFamily' => '

The address family for the BGP peer.

', 'VirtualInterface$addressFamily' => '

The address family for the BGP peer.

', ], ], 'AgreementList' => [ 'base' => NULL, 'refs' => [ 'DescribeCustomerMetadataResponse$agreements' => '

The list of customer agreements.

', ], ], 'AgreementName' => [ 'base' => NULL, 'refs' => [ 'ConfirmCustomerAgreementRequest$agreementName' => '

The name of the customer agreement.

', 'CustomerAgreement$agreementName' => '

The name of the agreement.

', ], ], 'AllocateConnectionOnInterconnectRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocateHostedConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocatePrivateVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocatePublicVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocateTransitVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'AllocateTransitVirtualInterfaceResult' => [ 'base' => NULL, 'refs' => [], ], 'AmazonAddress' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewBGPPeer$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewPrivateVirtualInterface$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewPrivateVirtualInterfaceAllocation$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewPublicVirtualInterface$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewPublicVirtualInterfaceAllocation$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewTransitVirtualInterface$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'NewTransitVirtualInterfaceAllocation$amazonAddress' => '

The IP address assigned to the Amazon interface.

', 'VirtualInterface$amazonAddress' => '

The IP address assigned to the Amazon interface.

', ], ], 'AssociateConnectionWithLagRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateHostedConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateMacSecKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateMacSecKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociatedCoreNetwork' => [ 'base' => '

The Amazon Web Services Cloud WAN core network that the Direct Connect attachment is associated with.

', 'refs' => [ 'DirectConnectGatewayAssociation$associatedCoreNetwork' => '

The ID of the Cloud WAN core network associated with the Direct Connect attachment.

', ], ], 'AssociatedGateway' => [ 'base' => '

Information about the associated gateway.

', 'refs' => [ 'DirectConnectGatewayAssociation$associatedGateway' => '

Information about the associated gateway.

', 'DirectConnectGatewayAssociationProposal$associatedGateway' => '

Information about the associated gateway.

', ], ], 'AssociatedGatewayId' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewayAssociationProposalsRequest$associatedGatewayId' => '

The ID of the associated gateway.

', 'DescribeDirectConnectGatewayAssociationsRequest$associatedGatewayId' => '

The ID of the associated gateway.

', ], ], 'AvailableMacSecPortSpeeds' => [ 'base' => NULL, 'refs' => [ 'Location$availableMacSecPortSpeeds' => '

The available MAC Security (MACsec) port speeds for the location.

', ], ], 'AvailablePortSpeeds' => [ 'base' => NULL, 'refs' => [ 'Location$availablePortSpeeds' => '

The available port speeds for the location.

', ], ], 'AwsDevice' => [ 'base' => NULL, 'refs' => [ 'Connection$awsDevice' => '

The Direct Connect endpoint on which the physical connection terminates.

', 'Interconnect$awsDevice' => '

The Direct Connect endpoint on which the physical connection terminates.

', 'Lag$awsDevice' => '

The Direct Connect endpoint that hosts the LAG.

', ], ], 'AwsDeviceV2' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$awsDeviceV2' => '

The Direct Connect endpoint that terminates the BGP peer.

', 'Connection$awsDeviceV2' => '

The Direct Connect endpoint that terminates the physical connection.

', 'Interconnect$awsDeviceV2' => '

The Direct Connect endpoint that terminates the physical connection.

', 'Lag$awsDeviceV2' => '

The Direct Connect endpoint that hosts the LAG.

', 'VirtualInterface$awsDeviceV2' => '

The Direct Connect endpoint that terminates the physical connection.

', ], ], 'AwsLogicalDeviceId' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$awsLogicalDeviceId' => '

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

', 'Connection$awsLogicalDeviceId' => '

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

', 'Interconnect$awsLogicalDeviceId' => '

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

', 'Lag$awsLogicalDeviceId' => '

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

', 'VirtualInterface$awsLogicalDeviceId' => '

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

', ], ], 'BGPAuthKey' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewBGPPeer$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewPrivateVirtualInterface$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewPrivateVirtualInterfaceAllocation$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewPublicVirtualInterface$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewPublicVirtualInterfaceAllocation$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewTransitVirtualInterface$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'NewTransitVirtualInterfaceAllocation$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', 'VirtualInterface$authKey' => '

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

', ], ], 'BGPPeer' => [ 'base' => '

Information about a BGP peer.

', 'refs' => [ 'BGPPeerList$member' => NULL, ], ], 'BGPPeerId' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$bgpPeerId' => '

The ID of the BGP peer.

', 'BGPPeerIdList$member' => NULL, 'DeleteBGPPeerRequest$bgpPeerId' => '

The ID of the BGP peer.

', ], ], 'BGPPeerIdList' => [ 'base' => NULL, 'refs' => [ 'ListVirtualInterfaceTestHistoryRequest$bgpPeers' => '

The BGP peers that were placed in the DOWN state during the virtual interface failover test.

', 'StartBgpFailoverTestRequest$bgpPeers' => '

The BGP peers to place in the DOWN state.

', 'VirtualInterfaceTestHistory$bgpPeers' => '

The BGP peers that were put in the DOWN state as part of the virtual interface failover test.

', ], ], 'BGPPeerList' => [ 'base' => NULL, 'refs' => [ 'VirtualInterface$bgpPeers' => '

The BGP peers configured on this virtual interface.

', ], ], 'BGPPeerState' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$bgpPeerState' => '

The state of the BGP peer. The following are the possible values:

', ], ], 'BGPStatus' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$bgpStatus' => '

The status of the BGP peer. The following are the possible values:

', ], ], 'Bandwidth' => [ 'base' => NULL, 'refs' => [ 'AllocateConnectionOnInterconnectRequest$bandwidth' => '

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

', 'AllocateHostedConnectionRequest$bandwidth' => '

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, 10Gbps, and 25Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps, 10Gbps, or 25Gbps hosted connection.

', 'Connection$bandwidth' => '

The bandwidth of the connection.

', 'CreateConnectionRequest$bandwidth' => '

The bandwidth of the connection.

', 'CreateInterconnectRequest$bandwidth' => '

The port bandwidth, in Gbps. The possible values are 1, 10, and 100.

', 'CreateLagRequest$connectionsBandwidth' => '

The bandwidth of the individual physical dedicated connections bundled by the LAG. The possible values are 1Gbps,10Gbps, 100Gbps, and 400Gbps.

', 'Interconnect$bandwidth' => '

The bandwidth of the connection.

', 'Lag$connectionsBandwidth' => '

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..

', ], ], 'BooleanFlag' => [ 'base' => NULL, 'refs' => [ 'Lag$allowsHostedConnections' => '

Indicates whether the LAG can host other connections.

', ], ], 'CIDR' => [ 'base' => NULL, 'refs' => [ 'RouteFilterPrefix$cidr' => '

The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

', ], ], 'Cak' => [ 'base' => NULL, 'refs' => [ 'AssociateMacSecKeyRequest$cak' => '

The MAC Security (MACsec) CAK to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the ckn request parameter and not use the secretARN request parameter.

', ], ], 'Ckn' => [ 'base' => NULL, 'refs' => [ 'AssociateMacSecKeyRequest$ckn' => '

The MAC Security (MACsec) CKN to associate with the dedicated connection.

You can create the CKN/CAK pair using an industry standard tool.

The valid values are 64 hexadecimal characters (0-9, A-E).

If you use this request parameter, you must use the cak request parameter and not use the secretARN request parameter.

', 'MacSecKey$ckn' => '

The Connection Key Name (CKN) for the MAC Security secret key.

', ], ], 'ConfirmConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmCustomerAgreementRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmCustomerAgreementResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmPrivateVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmPrivateVirtualInterfaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmPublicVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmPublicVirtualInterfaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmTransitVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ConfirmTransitVirtualInterfaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Connection' => [ 'base' => '

Information about an Direct Connect connection.

', 'refs' => [ 'ConnectionList$member' => NULL, ], ], 'ConnectionId' => [ 'base' => NULL, 'refs' => [ 'AllocateHostedConnectionRequest$connectionId' => '

The ID of the interconnect or LAG.

', 'AllocatePrivateVirtualInterfaceRequest$connectionId' => '

The ID of the connection on which the private virtual interface is provisioned.

', 'AllocatePublicVirtualInterfaceRequest$connectionId' => '

The ID of the connection on which the public virtual interface is provisioned.

', 'AllocateTransitVirtualInterfaceRequest$connectionId' => '

The ID of the connection on which the transit virtual interface is provisioned.

', 'AssociateConnectionWithLagRequest$connectionId' => '

The ID of the connection.

', 'AssociateHostedConnectionRequest$connectionId' => '

The ID of the hosted connection.

', 'AssociateHostedConnectionRequest$parentConnectionId' => '

The ID of the interconnect or the LAG.

', 'AssociateMacSecKeyRequest$connectionId' => '

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

', 'AssociateMacSecKeyResponse$connectionId' => '

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

', 'AssociateVirtualInterfaceRequest$connectionId' => '

The ID of the LAG or connection.

', 'ConfirmConnectionRequest$connectionId' => '

The ID of the hosted connection.

', 'Connection$connectionId' => '

The ID of the connection.

', 'CreateLagRequest$connectionId' => '

The ID of an existing dedicated connection to migrate to the LAG.

', 'CreatePrivateVirtualInterfaceRequest$connectionId' => '

The ID of the connection.

', 'CreatePublicVirtualInterfaceRequest$connectionId' => '

The ID of the connection.

', 'CreateTransitVirtualInterfaceRequest$connectionId' => '

The ID of the connection.

', 'DeleteConnectionRequest$connectionId' => '

The ID of the connection.

', 'DescribeConnectionLoaRequest$connectionId' => '

The ID of the connection.

', 'DescribeConnectionsRequest$connectionId' => '

The ID of the connection.

', 'DescribeHostedConnectionsRequest$connectionId' => '

The ID of the interconnect or LAG.

', 'DescribeLoaRequest$connectionId' => '

The ID of a connection, LAG, or interconnect.

', 'DescribeVirtualInterfacesRequest$connectionId' => '

The ID of the connection.

', 'DisassociateConnectionFromLagRequest$connectionId' => '

The ID of the connection.

', 'DisassociateMacSecKeyRequest$connectionId' => '

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

You can use DescribeConnections or DescribeLags to retrieve connection ID.

', 'DisassociateMacSecKeyResponse$connectionId' => '

The ID of the dedicated connection (dxcon-xxxx), or the ID of the LAG (dxlag-xxxx).

', 'UpdateConnectionRequest$connectionId' => '

The ID of the dedicated connection.

You can use DescribeConnections to retrieve the connection ID.

', 'VirtualInterface$connectionId' => '

The ID of the connection.

', ], ], 'ConnectionList' => [ 'base' => NULL, 'refs' => [ 'Connections$connections' => '

The connections.

', 'Lag$connections' => '

The connections bundled by the LAG.

', ], ], 'ConnectionName' => [ 'base' => NULL, 'refs' => [ 'AllocateConnectionOnInterconnectRequest$connectionName' => '

The name of the provisioned connection.

', 'AllocateHostedConnectionRequest$connectionName' => '

The name of the hosted connection.

', 'Connection$connectionName' => '

The name of the connection.

', 'CreateConnectionRequest$connectionName' => '

The name of the connection.

', 'UpdateConnectionRequest$connectionName' => '

The name of the connection.

', ], ], 'ConnectionState' => [ 'base' => NULL, 'refs' => [ 'ConfirmConnectionResponse$connectionState' => '

The state of the connection. The following are the possible values:

', 'Connection$connectionState' => '

The state of the connection. The following are the possible values:

', ], ], 'Connections' => [ 'base' => NULL, 'refs' => [], ], 'CoreNetworkAttachmentId' => [ 'base' => NULL, 'refs' => [ 'AssociatedCoreNetwork$attachmentId' => '

the ID of the Direct Connect attachment

', ], ], 'CoreNetworkIdentifier' => [ 'base' => NULL, 'refs' => [ 'AssociatedCoreNetwork$id' => '

The ID of the Cloud WAN core network.

', ], ], 'Count' => [ 'base' => NULL, 'refs' => [ 'CreateLagRequest$numberOfConnections' => '

The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1Gbps or 10Gbps, or two when the port speed is 100Gbps or 400Gbps.

', 'Lag$numberOfConnections' => '

The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.

', 'Lag$minimumLinks' => '

The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

', 'UpdateLagRequest$minimumLinks' => '

The minimum number of physical connections that must be operational for the LAG itself to be operational.

', ], ], 'CreateBGPPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateBGPPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayAssociationProposalRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayAssociationProposalResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayAssociationResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayResult' => [ 'base' => NULL, 'refs' => [], ], 'CreateInterconnectRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLagRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePrivateVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePublicVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransitVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransitVirtualInterfaceResult' => [ 'base' => NULL, 'refs' => [], ], 'CustomerAddress' => [ 'base' => NULL, 'refs' => [ 'BGPPeer$customerAddress' => '

The IP address assigned to the customer interface.

', 'DeleteBGPPeerRequest$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewBGPPeer$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewPrivateVirtualInterface$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewPrivateVirtualInterfaceAllocation$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewPublicVirtualInterface$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewPublicVirtualInterfaceAllocation$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewTransitVirtualInterface$customerAddress' => '

The IP address assigned to the customer interface.

', 'NewTransitVirtualInterfaceAllocation$customerAddress' => '

The IP address assigned to the customer interface.

', 'VirtualInterface$customerAddress' => '

The IP address assigned to the customer interface.

', ], ], 'CustomerAgreement' => [ 'base' => '

The name and status of a customer agreement.

', 'refs' => [ 'AgreementList$member' => NULL, ], ], 'DeleteBGPPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBGPPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDirectConnectGatewayAssociationProposalRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDirectConnectGatewayAssociationProposalResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDirectConnectGatewayAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDirectConnectGatewayAssociationResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDirectConnectGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDirectConnectGatewayResult' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInterconnectRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteInterconnectResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLagRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVirtualInterfaceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteVirtualInterfaceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectionLoaRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectionLoaResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectionsOnInterconnectRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeConnectionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeCustomerMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewayAssociationProposalsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewayAssociationProposalsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewayAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewayAssociationsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewayAttachmentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewayAttachmentsResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewaysRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDirectConnectGatewaysResult' => [ 'base' => NULL, 'refs' => [], ], 'DescribeHostedConnectionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInterconnectLoaRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInterconnectLoaResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeInterconnectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeLoaRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeRouterConfigurationRequest' => [ 'base' => '

Provides the details about a virtual interface\'s router.

', 'refs' => [], ], 'DescribeRouterConfigurationResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTagsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeTagsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeVirtualInterfacesRequest' => [ 'base' => NULL, 'refs' => [], ], 'DirectConnectClientException' => [ 'base' => '

One or more parameters are not valid.

', 'refs' => [], ], 'DirectConnectGateway' => [ 'base' => '

Information about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateway or transit gateways.

', 'refs' => [ 'CreateDirectConnectGatewayResult$directConnectGateway' => '

The Direct Connect gateway.

', 'DeleteDirectConnectGatewayResult$directConnectGateway' => '

The Direct Connect gateway.

', 'DirectConnectGatewayList$member' => NULL, 'UpdateDirectConnectGatewayResponse$directConnectGateway' => '

Informaiton about a Direct Connect gateway, which enables you to connect virtual interfaces and virtual private gateways or transit gateways.

', ], ], 'DirectConnectGatewayAssociation' => [ 'base' => '

Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.

', 'refs' => [ 'AcceptDirectConnectGatewayAssociationProposalResult$directConnectGatewayAssociation' => '

Information about an association between a Direct Connect gateway and a virtual gateway or transit gateway.

', 'CreateDirectConnectGatewayAssociationResult$directConnectGatewayAssociation' => '

The association to be created.

', 'DeleteDirectConnectGatewayAssociationResult$directConnectGatewayAssociation' => '

Information about the deleted association.

', 'DirectConnectGatewayAssociationList$member' => NULL, 'UpdateDirectConnectGatewayAssociationResult$directConnectGatewayAssociation' => '

Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.

', ], ], 'DirectConnectGatewayAssociationId' => [ 'base' => NULL, 'refs' => [ 'DeleteDirectConnectGatewayAssociationRequest$associationId' => '

The ID of the Direct Connect gateway association.

', 'DescribeDirectConnectGatewayAssociationsRequest$associationId' => '

The ID of the Direct Connect gateway association.

', 'DirectConnectGatewayAssociation$associationId' => '

The ID of the Direct Connect gateway association.

', 'UpdateDirectConnectGatewayAssociationRequest$associationId' => '

The ID of the Direct Connect gateway association.

', ], ], 'DirectConnectGatewayAssociationList' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewayAssociationsResult$directConnectGatewayAssociations' => '

Information about the associations.

', ], ], 'DirectConnectGatewayAssociationProposal' => [ 'base' => '

Information about the proposal request to attach a virtual private gateway to a Direct Connect gateway.

', 'refs' => [ 'CreateDirectConnectGatewayAssociationProposalResult$directConnectGatewayAssociationProposal' => '

Information about the Direct Connect gateway proposal.

', 'DeleteDirectConnectGatewayAssociationProposalResult$directConnectGatewayAssociationProposal' => '

The ID of the associated gateway.

', 'DirectConnectGatewayAssociationProposalList$member' => NULL, ], ], 'DirectConnectGatewayAssociationProposalId' => [ 'base' => NULL, 'refs' => [ 'AcceptDirectConnectGatewayAssociationProposalRequest$proposalId' => '

The ID of the request proposal.

', 'DeleteDirectConnectGatewayAssociationProposalRequest$proposalId' => '

The ID of the proposal.

', 'DescribeDirectConnectGatewayAssociationProposalsRequest$proposalId' => '

The ID of the proposal.

', 'DirectConnectGatewayAssociationProposal$proposalId' => '

The ID of the association proposal.

', ], ], 'DirectConnectGatewayAssociationProposalList' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewayAssociationProposalsResult$directConnectGatewayAssociationProposals' => '

Describes the Direct Connect gateway association proposals.

', ], ], 'DirectConnectGatewayAssociationProposalState' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGatewayAssociationProposal$proposalState' => '

The state of the proposal. The following are possible values:

', ], ], 'DirectConnectGatewayAssociationState' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGatewayAssociation$associationState' => '

The state of the association. The following are the possible values:

', ], ], 'DirectConnectGatewayAttachment' => [ 'base' => '

Information about an attachment between a Direct Connect gateway and a virtual interface.

', 'refs' => [ 'DirectConnectGatewayAttachmentList$member' => NULL, ], ], 'DirectConnectGatewayAttachmentList' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewayAttachmentsResult$directConnectGatewayAttachments' => '

The attachments.

', ], ], 'DirectConnectGatewayAttachmentState' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGatewayAttachment$attachmentState' => '

The state of the attachment. The following are the possible values:

', ], ], 'DirectConnectGatewayAttachmentType' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGatewayAttachment$attachmentType' => '

The type of attachment.

', ], ], 'DirectConnectGatewayId' => [ 'base' => NULL, 'refs' => [ 'AcceptDirectConnectGatewayAssociationProposalRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'ConfirmPrivateVirtualInterfaceRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'ConfirmTransitVirtualInterfaceRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'CreateDirectConnectGatewayAssociationProposalRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'CreateDirectConnectGatewayAssociationRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DeleteDirectConnectGatewayAssociationRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DeleteDirectConnectGatewayRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DescribeDirectConnectGatewayAssociationProposalsRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DescribeDirectConnectGatewayAssociationsRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DescribeDirectConnectGatewayAttachmentsRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DescribeDirectConnectGatewaysRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DirectConnectGateway$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DirectConnectGatewayAssociation$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DirectConnectGatewayAssociationProposal$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'DirectConnectGatewayAttachment$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'NewPrivateVirtualInterface$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'NewTransitVirtualInterface$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', 'UpdateDirectConnectGatewayRequest$directConnectGatewayId' => '

The ID of the Direct Connect gateway to update.

', 'VirtualInterface$directConnectGatewayId' => '

The ID of the Direct Connect gateway.

', ], ], 'DirectConnectGatewayList' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewaysResult$directConnectGateways' => '

The Direct Connect gateways.

', ], ], 'DirectConnectGatewayName' => [ 'base' => NULL, 'refs' => [ 'CreateDirectConnectGatewayRequest$directConnectGatewayName' => '

The name of the Direct Connect gateway.

', 'DirectConnectGateway$directConnectGatewayName' => '

The name of the Direct Connect gateway.

', 'UpdateDirectConnectGatewayRequest$newDirectConnectGatewayName' => '

The new name for the Direct Connect gateway.

', ], ], 'DirectConnectGatewayState' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGateway$directConnectGatewayState' => '

The state of the Direct Connect gateway. The following are the possible values:

', ], ], 'DirectConnectServerException' => [ 'base' => '

A server-side error occurred.

', 'refs' => [], ], 'DisassociateConnectionFromLagRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateMacSecKeyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateMacSecKeyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DuplicateTagKeysException' => [ 'base' => '

A tag key was specified more than once.

', 'refs' => [], ], 'EnableSiteLink' => [ 'base' => NULL, 'refs' => [ 'NewPrivateVirtualInterface$enableSiteLink' => '

Indicates whether to enable or disable SiteLink.

', 'NewTransitVirtualInterface$enableSiteLink' => '

Indicates whether to enable or disable SiteLink.

', 'UpdateVirtualInterfaceAttributesRequest$enableSiteLink' => '

Indicates whether to enable or disable SiteLink.

', ], ], 'EncryptionMode' => [ 'base' => NULL, 'refs' => [ 'Connection$encryptionMode' => '

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

', 'Lag$encryptionMode' => '

The LAG MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

', 'UpdateConnectionRequest$encryptionMode' => '

The connection MAC Security (MACsec) encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

', 'UpdateLagRequest$encryptionMode' => '

The LAG MAC Security (MACsec) encryption mode.

Amazon Web Services applies the value to all connections which are part of the LAG.

', ], ], 'EndTime' => [ 'base' => NULL, 'refs' => [ 'VirtualInterfaceTestHistory$endTime' => '

The time that the virtual interface moves out of the DOWN state.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'DirectConnectClientException$message' => NULL, 'DirectConnectServerException$message' => NULL, ], ], 'FailureTestHistoryStatus' => [ 'base' => NULL, 'refs' => [ 'ListVirtualInterfaceTestHistoryRequest$status' => '

The status of the virtual interface failover test.

', 'VirtualInterfaceTestHistory$status' => '

The status of the virtual interface failover test.

', ], ], 'GatewayIdToAssociate' => [ 'base' => NULL, 'refs' => [ 'CreateDirectConnectGatewayAssociationProposalRequest$gatewayId' => '

The ID of the virtual private gateway or transit gateway.

', 'CreateDirectConnectGatewayAssociationRequest$gatewayId' => '

The ID of the virtual private gateway or transit gateway.

', ], ], 'GatewayIdentifier' => [ 'base' => NULL, 'refs' => [ 'AssociatedGateway$id' => '

The ID of the associated gateway.

', ], ], 'GatewayType' => [ 'base' => NULL, 'refs' => [ 'AssociatedGateway$type' => '

The type of associated gateway.

', ], ], 'HasLogicalRedundancy' => [ 'base' => NULL, 'refs' => [ 'Connection$hasLogicalRedundancy' => '

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

', 'Interconnect$hasLogicalRedundancy' => '

Indicates whether the interconnect supports a secondary BGP in the same address family (IPv4/IPv6).

', 'Lag$hasLogicalRedundancy' => '

Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).

', ], ], 'Interconnect' => [ 'base' => '

Information about an interconnect.

', 'refs' => [ 'InterconnectList$member' => NULL, ], ], 'InterconnectId' => [ 'base' => NULL, 'refs' => [ 'AllocateConnectionOnInterconnectRequest$interconnectId' => '

The ID of the interconnect on which the connection will be provisioned.

', 'DeleteInterconnectRequest$interconnectId' => '

The ID of the interconnect.

', 'DescribeConnectionsOnInterconnectRequest$interconnectId' => '

The ID of the interconnect.

', 'DescribeInterconnectLoaRequest$interconnectId' => '

The ID of the interconnect.

', 'DescribeInterconnectsRequest$interconnectId' => '

The ID of the interconnect.

', 'Interconnect$interconnectId' => '

The ID of the interconnect.

', ], ], 'InterconnectList' => [ 'base' => NULL, 'refs' => [ 'Interconnects$interconnects' => '

The interconnects.

', ], ], 'InterconnectName' => [ 'base' => NULL, 'refs' => [ 'CreateInterconnectRequest$interconnectName' => '

The name of the interconnect.

', 'Interconnect$interconnectName' => '

The name of the interconnect.

', ], ], 'InterconnectState' => [ 'base' => NULL, 'refs' => [ 'DeleteInterconnectResponse$interconnectState' => '

The state of the interconnect. The following are the possible values:

', 'Interconnect$interconnectState' => '

The state of the interconnect. The following are the possible values:

', ], ], 'Interconnects' => [ 'base' => NULL, 'refs' => [], ], 'JumboFrameCapable' => [ 'base' => NULL, 'refs' => [ 'Connection$jumboFrameCapable' => '

Indicates whether jumbo frames are supported.

', 'Interconnect$jumboFrameCapable' => '

Indicates whether jumbo frames are supported.

', 'Lag$jumboFrameCapable' => '

Indicates whether jumbo frames are supported.

', 'VirtualInterface$jumboFrameCapable' => '

Indicates whether jumbo frames are supported.

', ], ], 'Lag' => [ 'base' => '

Information about a link aggregation group (LAG).

', 'refs' => [ 'LagList$member' => NULL, ], ], 'LagId' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectionWithLagRequest$lagId' => '

The ID of the LAG with which to associate the connection.

', 'Connection$lagId' => '

The ID of the LAG.

', 'CreateConnectionRequest$lagId' => '

The ID of the LAG.

', 'CreateInterconnectRequest$lagId' => '

The ID of the LAG.

', 'DeleteLagRequest$lagId' => '

The ID of the LAG.

', 'DescribeLagsRequest$lagId' => '

The ID of the LAG.

', 'DisassociateConnectionFromLagRequest$lagId' => '

The ID of the LAG.

', 'Interconnect$lagId' => '

The ID of the LAG.

', 'Lag$lagId' => '

The ID of the LAG.

', 'UpdateLagRequest$lagId' => '

The ID of the LAG.

', ], ], 'LagList' => [ 'base' => NULL, 'refs' => [ 'Lags$lags' => '

The LAGs.

', ], ], 'LagName' => [ 'base' => NULL, 'refs' => [ 'CreateLagRequest$lagName' => '

The name of the LAG.

', 'Lag$lagName' => '

The name of the LAG.

', 'UpdateLagRequest$lagName' => '

The name of the LAG.

', ], ], 'LagState' => [ 'base' => NULL, 'refs' => [ 'Lag$lagState' => '

The state of the LAG. The following are the possible values:

', ], ], 'Lags' => [ 'base' => NULL, 'refs' => [], ], 'ListVirtualInterfaceTestHistoryRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListVirtualInterfaceTestHistoryResponse' => [ 'base' => NULL, 'refs' => [], ], 'Loa' => [ 'base' => '

Information about a Letter of Authorization - Connecting Facility Assignment (LOA-CFA) for a connection.

', 'refs' => [ 'DescribeConnectionLoaResponse$loa' => '

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

', 'DescribeInterconnectLoaResponse$loa' => '

The Letter of Authorization - Connecting Facility Assignment (LOA-CFA).

', ], ], 'LoaContent' => [ 'base' => NULL, 'refs' => [ 'Loa$loaContent' => '

The binary contents of the LOA-CFA document.

', ], ], 'LoaContentType' => [ 'base' => NULL, 'refs' => [ 'DescribeConnectionLoaRequest$loaContentType' => '

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

', 'DescribeInterconnectLoaRequest$loaContentType' => '

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

', 'DescribeLoaRequest$loaContentType' => '

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

', 'Loa$loaContentType' => '

The standard media type for the LOA-CFA document. The only supported value is application/pdf.

', ], ], 'LoaIssueTime' => [ 'base' => NULL, 'refs' => [ 'Connection$loaIssueTime' => '

The time of the most recent call to DescribeLoa for this connection.

', 'Interconnect$loaIssueTime' => '

The time of the most recent call to DescribeLoa for this connection.

', ], ], 'Location' => [ 'base' => '

Information about an Direct Connect location.

', 'refs' => [ 'LocationList$member' => NULL, ], ], 'LocationCode' => [ 'base' => NULL, 'refs' => [ 'Connection$location' => '

The location of the connection.

', 'CreateConnectionRequest$location' => '

The location of the connection.

', 'CreateInterconnectRequest$location' => '

The location of the interconnect.

', 'CreateLagRequest$location' => '

The location for the LAG.

', 'Interconnect$location' => '

The location of the connection.

', 'Lag$location' => '

The location of the LAG.

', 'Location$locationCode' => '

The code for the location.

', 'VirtualInterface$location' => '

The location of the connection.

', ], ], 'LocationList' => [ 'base' => NULL, 'refs' => [ 'Locations$locations' => '

The locations.

', ], ], 'LocationName' => [ 'base' => NULL, 'refs' => [ 'Location$locationName' => '

The name of the location. This includes the name of the colocation partner and the physical site of the building.

', ], ], 'Locations' => [ 'base' => NULL, 'refs' => [], ], 'LongAsn' => [ 'base' => NULL, 'refs' => [ 'CreateDirectConnectGatewayRequest$amazonSideAsn' => '

The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.

', 'DirectConnectGateway$amazonSideAsn' => '

The autonomous system number (ASN) for the Amazon side of the connection.

', 'VirtualInterface$amazonSideAsn' => '

The autonomous system number (ASN) for the Amazon side of the connection.

', ], ], 'MTU' => [ 'base' => NULL, 'refs' => [ 'NewPrivateVirtualInterface$mtu' => '

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

', 'NewPrivateVirtualInterfaceAllocation$mtu' => '

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

', 'NewTransitVirtualInterface$mtu' => '

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

', 'NewTransitVirtualInterfaceAllocation$mtu' => '

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

', 'UpdateVirtualInterfaceAttributesRequest$mtu' => '

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500.

', 'VirtualInterface$mtu' => '

The maximum transmission unit (MTU), in bytes. The supported values are 1500 and 8500. The default value is 1500

', ], ], 'MacSecCapable' => [ 'base' => NULL, 'refs' => [ 'Connection$macSecCapable' => '

Indicates whether the connection supports MAC Security (MACsec).

', 'Lag$macSecCapable' => '

Indicates whether the LAG supports MAC Security (MACsec).

', ], ], 'MacSecKey' => [ 'base' => '

Information about the MAC Security (MACsec) secret key.

', 'refs' => [ 'MacSecKeyList$member' => NULL, ], ], 'MacSecKeyList' => [ 'base' => NULL, 'refs' => [ 'AssociateMacSecKeyResponse$macSecKeys' => '

The MAC Security (MACsec) security keys associated with the dedicated connection.

', 'Connection$macSecKeys' => '

The MAC Security (MACsec) security keys associated with the connection.

', 'DisassociateMacSecKeyResponse$macSecKeys' => '

The MAC Security (MACsec) security keys no longer associated with the dedicated connection.

', 'Lag$macSecKeys' => '

The MAC Security (MACsec) security keys associated with the LAG.

', ], ], 'MaxResultSetSize' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewayAssociationProposalsRequest$maxResults' => '

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

', 'DescribeDirectConnectGatewayAssociationsRequest$maxResults' => '

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

', 'DescribeDirectConnectGatewayAttachmentsRequest$maxResults' => '

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

', 'DescribeDirectConnectGatewaysRequest$maxResults' => '

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

', 'ListVirtualInterfaceTestHistoryRequest$maxResults' => '

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

', ], ], 'NewBGPPeer' => [ 'base' => '

Information about a new BGP peer.

', 'refs' => [ 'CreateBGPPeerRequest$newBGPPeer' => '

Information about the BGP peer.

', ], ], 'NewPrivateVirtualInterface' => [ 'base' => '

Information about a private virtual interface.

', 'refs' => [ 'CreatePrivateVirtualInterfaceRequest$newPrivateVirtualInterface' => '

Information about the private virtual interface.

', ], ], 'NewPrivateVirtualInterfaceAllocation' => [ 'base' => '

Information about a private virtual interface to be provisioned on a connection.

', 'refs' => [ 'AllocatePrivateVirtualInterfaceRequest$newPrivateVirtualInterfaceAllocation' => '

Information about the private virtual interface.

', ], ], 'NewPublicVirtualInterface' => [ 'base' => '

Information about a public virtual interface.

', 'refs' => [ 'CreatePublicVirtualInterfaceRequest$newPublicVirtualInterface' => '

Information about the public virtual interface.

', ], ], 'NewPublicVirtualInterfaceAllocation' => [ 'base' => '

Information about a public virtual interface to be provisioned on a connection.

', 'refs' => [ 'AllocatePublicVirtualInterfaceRequest$newPublicVirtualInterfaceAllocation' => '

Information about the public virtual interface.

', ], ], 'NewTransitVirtualInterface' => [ 'base' => '

Information about a transit virtual interface.

', 'refs' => [ 'CreateTransitVirtualInterfaceRequest$newTransitVirtualInterface' => '

Information about the transit virtual interface.

', ], ], 'NewTransitVirtualInterfaceAllocation' => [ 'base' => '

Information about a transit virtual interface to be provisioned on a connection.

', 'refs' => [ 'AllocateTransitVirtualInterfaceRequest$newTransitVirtualInterfaceAllocation' => '

Information about the transit virtual interface.

', ], ], 'NniPartnerType' => [ 'base' => NULL, 'refs' => [ 'DescribeCustomerMetadataResponse$nniPartnerType' => '

The type of network-to-network interface (NNI) partner. The partner type will be one of the following:

', ], ], 'OwnerAccount' => [ 'base' => NULL, 'refs' => [ 'AcceptDirectConnectGatewayAssociationProposalRequest$associatedGatewayOwnerAccount' => '

The ID of the Amazon Web Services account that owns the virtual private gateway or transit gateway.

', 'AllocateConnectionOnInterconnectRequest$ownerAccount' => '

The ID of the Amazon Web Services account of the customer for whom the connection will be provisioned.

', 'AllocateHostedConnectionRequest$ownerAccount' => '

The ID of the Amazon Web Services account ID of the customer for the connection.

', 'AllocatePrivateVirtualInterfaceRequest$ownerAccount' => '

The ID of the Amazon Web Services account that owns the virtual private interface.

', 'AllocatePublicVirtualInterfaceRequest$ownerAccount' => '

The ID of the Amazon Web Services account that owns the public virtual interface.

', 'AllocateTransitVirtualInterfaceRequest$ownerAccount' => '

The ID of the Amazon Web Services account that owns the transit virtual interface.

', 'AssociatedCoreNetwork$ownerAccount' => '

The account owner of the Cloud WAN core network.

', 'AssociatedGateway$ownerAccount' => '

The ID of the Amazon Web Services account that owns the associated virtual private gateway or transit gateway.

', 'Connection$ownerAccount' => '

The ID of the Amazon Web Services account that owns the connection.

', 'CreateDirectConnectGatewayAssociationProposalRequest$directConnectGatewayOwnerAccount' => '

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

', 'DirectConnectGateway$ownerAccount' => '

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

', 'DirectConnectGatewayAssociation$directConnectGatewayOwnerAccount' => '

The ID of the Amazon Web Services account that owns the associated gateway.

', 'DirectConnectGatewayAssociation$virtualGatewayOwnerAccount' => '

The ID of the Amazon Web Services account that owns the virtual private gateway.

', 'DirectConnectGatewayAssociationProposal$directConnectGatewayOwnerAccount' => '

The ID of the Amazon Web Services account that owns the Direct Connect gateway.

', 'DirectConnectGatewayAttachment$virtualInterfaceOwnerAccount' => '

The ID of the Amazon Web Services account that owns the virtual interface.

', 'Lag$ownerAccount' => '

The ID of the Amazon Web Services account that owns the LAG.

', 'VirtualInterface$ownerAccount' => '

The ID of the Amazon Web Services account that owns the virtual interface.

', 'VirtualInterfaceTestHistory$ownerAccount' => '

The owner ID of the tested virtual interface.

', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'DescribeDirectConnectGatewayAssociationProposalsRequest$nextToken' => '

The token for the next page of results.

', 'DescribeDirectConnectGatewayAssociationProposalsResult$nextToken' => '

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

', 'DescribeDirectConnectGatewayAssociationsRequest$nextToken' => '

The token provided in the previous call to retrieve the next page.

', 'DescribeDirectConnectGatewayAssociationsResult$nextToken' => '

The token to retrieve the next page.

', 'DescribeDirectConnectGatewayAttachmentsRequest$nextToken' => '

The token provided in the previous call to retrieve the next page.

', 'DescribeDirectConnectGatewayAttachmentsResult$nextToken' => '

The token to retrieve the next page.

', 'DescribeDirectConnectGatewaysRequest$nextToken' => '

The token provided in the previous call to retrieve the next page.

', 'DescribeDirectConnectGatewaysResult$nextToken' => '

The token to retrieve the next page.

', 'ListVirtualInterfaceTestHistoryRequest$nextToken' => '

The token for the next page of results.

', 'ListVirtualInterfaceTestHistoryResponse$nextToken' => '

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

', ], ], 'PartnerName' => [ 'base' => NULL, 'refs' => [ 'Connection$partnerName' => '

The name of the Direct Connect service provider associated with the connection.

', ], ], 'Platform' => [ 'base' => NULL, 'refs' => [ 'RouterType$platform' => '

The virtual interface router platform.

', ], ], 'PortEncryptionStatus' => [ 'base' => NULL, 'refs' => [ 'Connection$portEncryptionStatus' => '

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

', ], ], 'PortSpeed' => [ 'base' => NULL, 'refs' => [ 'AvailableMacSecPortSpeeds$member' => NULL, 'AvailablePortSpeeds$member' => NULL, ], ], 'ProviderList' => [ 'base' => NULL, 'refs' => [ 'Location$availableProviders' => '

The name of the service provider for the location.

', ], ], 'ProviderName' => [ 'base' => NULL, 'refs' => [ 'Connection$providerName' => '

The name of the service provider associated with the connection.

', 'CreateConnectionRequest$providerName' => '

The name of the service provider associated with the requested connection.

', 'CreateInterconnectRequest$providerName' => '

The name of the service provider associated with the interconnect.

', 'CreateLagRequest$providerName' => '

The name of the service provider associated with the LAG.

', 'DescribeConnectionLoaRequest$providerName' => '

The name of the APN partner or service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

', 'DescribeInterconnectLoaRequest$providerName' => '

The name of the service provider who establishes connectivity on your behalf. If you supply this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

', 'DescribeLoaRequest$providerName' => '

The name of the service provider who establishes connectivity on your behalf. If you specify this parameter, the LOA-CFA lists the provider name alongside your company name as the requester of the cross connect.

', 'Interconnect$providerName' => '

The name of the service provider associated with the interconnect.

', 'Lag$providerName' => '

The name of the service provider associated with the LAG.

', 'ProviderList$member' => NULL, ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'AssociatedGateway$region' => '

The Region where the associated gateway is located.

', 'Connection$region' => '

The Amazon Web Services Region where the connection is located.

', 'Interconnect$region' => '

The Amazon Web Services Region where the connection is located.

', 'Lag$region' => '

The Amazon Web Services Region where the connection is located.

', 'Location$region' => '

The Amazon Web Services Region for the location.

', 'VirtualInterface$region' => '

The Amazon Web Services Region where the virtual interface is located.

', ], ], 'RequestMACSec' => [ 'base' => NULL, 'refs' => [ 'CreateConnectionRequest$requestMACSec' => '

Indicates whether you want the connection to support MAC Security (MACsec).

MAC Security (MACsec) is only available on dedicated connections. For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

', 'CreateLagRequest$requestMACSec' => '

Indicates whether the connection will support MAC Security (MACsec).

All connections in the LAG must be capable of supporting MAC Security (MACsec). For information about MAC Security (MACsec) prerequisties, see MACsec prerequisties in the Direct Connect User Guide.

', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'ResourceArnList$member' => NULL, 'ResourceTag$resourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'TagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'UntagResourceRequest$resourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', ], ], 'ResourceArnList' => [ 'base' => NULL, 'refs' => [ 'DescribeTagsRequest$resourceArns' => '

The Amazon Resource Names (ARNs) of the resources.

', ], ], 'ResourceTag' => [ 'base' => '

Information about a tag associated with an Direct Connect resource.

', 'refs' => [ 'ResourceTagList$member' => NULL, ], ], 'ResourceTagList' => [ 'base' => NULL, 'refs' => [ 'DescribeTagsResponse$resourceTags' => '

Information about the tags.

', ], ], 'RouteFilterPrefix' => [ 'base' => '

Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

', 'refs' => [ 'RouteFilterPrefixList$member' => NULL, ], ], 'RouteFilterPrefixList' => [ 'base' => NULL, 'refs' => [ 'AcceptDirectConnectGatewayAssociationProposalRequest$overrideAllowedPrefixesToDirectConnectGateway' => '

Overrides the Amazon VPC prefixes advertised to the Direct Connect gateway.

For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.

', 'CreateDirectConnectGatewayAssociationProposalRequest$addAllowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

', 'CreateDirectConnectGatewayAssociationProposalRequest$removeAllowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

', 'CreateDirectConnectGatewayAssociationRequest$addAllowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to advertise to the Direct Connect gateway

This parameter is required when you create an association to a transit gateway.

For information about how to set the prefixes, see Allowed Prefixes in the Direct Connect User Guide.

', 'DirectConnectGatewayAssociation$allowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

', 'DirectConnectGatewayAssociationProposal$existingAllowedPrefixesToDirectConnectGateway' => '

The existing Amazon VPC prefixes advertised to the Direct Connect gateway.

', 'DirectConnectGatewayAssociationProposal$requestedAllowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

', 'NewPublicVirtualInterface$routeFilterPrefixes' => '

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

', 'NewPublicVirtualInterfaceAllocation$routeFilterPrefixes' => '

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

', 'UpdateDirectConnectGatewayAssociationRequest$addAllowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

', 'UpdateDirectConnectGatewayAssociationRequest$removeAllowedPrefixesToDirectConnectGateway' => '

The Amazon VPC prefixes to no longer advertise to the Direct Connect gateway.

', 'VirtualInterface$routeFilterPrefixes' => '

The routes to be advertised to the Amazon Web Services network in this Region. Applies to public virtual interfaces.

', ], ], 'RouterConfig' => [ 'base' => NULL, 'refs' => [ 'DescribeRouterConfigurationResponse$customerRouterConfig' => '

The customer router configuration.

', 'VirtualInterface$customerRouterConfig' => '

The customer router configuration.

', ], ], 'RouterType' => [ 'base' => '

Information about the virtual router.

', 'refs' => [ 'DescribeRouterConfigurationResponse$router' => '

The details about the router.

', ], ], 'RouterTypeIdentifier' => [ 'base' => NULL, 'refs' => [ 'DescribeRouterConfigurationRequest$routerTypeIdentifier' => '

Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

', 'RouterType$routerTypeIdentifier' => '

Identifies the router by a combination of vendor, platform, and software version. For example, CiscoSystemsInc-2900SeriesRouters-IOS124.

', ], ], 'SecretARN' => [ 'base' => NULL, 'refs' => [ 'AssociateMacSecKeyRequest$secretARN' => '

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key to associate with the dedicated connection.

You can use DescribeConnections or DescribeLags to retrieve the MAC Security (MACsec) secret key.

If you use this request parameter, you do not use the ckn and cak request parameters.

', 'DisassociateMacSecKeyRequest$secretARN' => '

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

You can use DescribeConnections to retrieve the ARN of the MAC Security (MACsec) secret key.

', 'MacSecKey$secretARN' => '

The Amazon Resource Name (ARN) of the MAC Security (MACsec) secret key.

', ], ], 'SiteLinkEnabled' => [ 'base' => NULL, 'refs' => [ 'VirtualInterface$siteLinkEnabled' => '

Indicates whether SiteLink is enabled.

', ], ], 'Software' => [ 'base' => NULL, 'refs' => [ 'RouterType$software' => '

The router software.

', ], ], 'StartBgpFailoverTestRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartBgpFailoverTestResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartOnDate' => [ 'base' => NULL, 'refs' => [ 'MacSecKey$startOn' => '

The date that the MAC Security (MACsec) secret key takes effect. The value is displayed in UTC format.

', ], ], 'StartTime' => [ 'base' => NULL, 'refs' => [ 'VirtualInterfaceTestHistory$startTime' => '

The time that the virtual interface moves to the DOWN state.

', ], ], 'State' => [ 'base' => NULL, 'refs' => [ 'MacSecKey$state' => '

The state of the MAC Security (MACsec) secret key.

The possible values are:

', ], ], 'StateChangeError' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGateway$stateChangeError' => '

The error message if the state of an object failed to advance.

', 'DirectConnectGatewayAssociation$stateChangeError' => '

The error message if the state of an object failed to advance.

', 'DirectConnectGatewayAttachment$stateChangeError' => '

The error message if the state of an object failed to advance.

', ], ], 'Status' => [ 'base' => NULL, 'refs' => [ 'ConfirmCustomerAgreementResponse$status' => '

The status of the customer agreement when the connection was created. This will be either signed or unsigned.

', 'CustomerAgreement$status' => '

The status of the customer agreement. This will be either signed or unsigned

', ], ], 'StopBgpFailoverTestRequest' => [ 'base' => NULL, 'refs' => [], ], 'StopBgpFailoverTestResponse' => [ 'base' => NULL, 'refs' => [], ], 'Tag' => [ 'base' => '

Information about a tag.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$key' => '

The key.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$tagKeys' => '

The tag keys of the tags to remove.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'AllocateHostedConnectionRequest$tags' => '

The tags associated with the connection.

', 'Connection$tags' => '

The tags associated with the connection.

', 'CreateConnectionRequest$tags' => '

The tags to associate with the lag.

', 'CreateInterconnectRequest$tags' => '

The tags to associate with the interconnect.

', 'CreateLagRequest$tags' => '

The tags to associate with the LAG.

', 'CreateLagRequest$childConnectionTags' => '

The tags to associate with the automtically created LAGs.

', 'Interconnect$tags' => '

The tags associated with the interconnect.

', 'Lag$tags' => '

The tags associated with the LAG.

', 'NewPrivateVirtualInterface$tags' => '

The tags associated with the private virtual interface.

', 'NewPrivateVirtualInterfaceAllocation$tags' => '

The tags associated with the private virtual interface.

', 'NewPublicVirtualInterface$tags' => '

The tags associated with the public virtual interface.

', 'NewPublicVirtualInterfaceAllocation$tags' => '

The tags associated with the public virtual interface.

', 'NewTransitVirtualInterface$tags' => '

The tags associated with the transitive virtual interface.

', 'NewTransitVirtualInterfaceAllocation$tags' => '

The tags associated with the transitive virtual interface.

', 'ResourceTag$tags' => '

The tags.

', 'TagResourceRequest$tags' => '

The tags to add.

', 'VirtualInterface$tags' => '

The tags associated with the virtual interface.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$value' => '

The value.

', ], ], 'TestDuration' => [ 'base' => NULL, 'refs' => [ 'StartBgpFailoverTestRequest$testDurationInMinutes' => '

The time in minutes that the virtual interface failover test will last.

Maximum value: 4,320 minutes (72 hours).

Default: 180 minutes (3 hours).

', 'VirtualInterfaceTestHistory$testDurationInMinutes' => '

The time that the virtual interface failover test ran in minutes.

', ], ], 'TestId' => [ 'base' => NULL, 'refs' => [ 'ListVirtualInterfaceTestHistoryRequest$testId' => '

The ID of the virtual interface failover test.

', 'VirtualInterfaceTestHistory$testId' => '

The ID of the virtual interface failover test.

', ], ], 'TooManyTagsException' => [ 'base' => '

You have reached the limit on the number of tags that can be assigned.

', 'refs' => [], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDirectConnectGatewayAssociationRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDirectConnectGatewayAssociationResult' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDirectConnectGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDirectConnectGatewayResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLagRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVirtualInterfaceAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'VLAN' => [ 'base' => NULL, 'refs' => [ 'AllocateConnectionOnInterconnectRequest$vlan' => '

The dedicated VLAN provisioned to the connection.

', 'AllocateHostedConnectionRequest$vlan' => '

The dedicated VLAN provisioned to the hosted connection.

', 'Connection$vlan' => '

The ID of the VLAN.

', 'NewPrivateVirtualInterface$vlan' => '

The ID of the VLAN.

', 'NewPrivateVirtualInterfaceAllocation$vlan' => '

The ID of the VLAN.

', 'NewPublicVirtualInterface$vlan' => '

The ID of the VLAN.

', 'NewPublicVirtualInterfaceAllocation$vlan' => '

The ID of the VLAN.

', 'NewTransitVirtualInterface$vlan' => '

The ID of the VLAN.

', 'NewTransitVirtualInterfaceAllocation$vlan' => '

The ID of the VLAN.

', 'VirtualInterface$vlan' => '

The ID of the VLAN.

', ], ], 'Vendor' => [ 'base' => NULL, 'refs' => [ 'RouterType$vendor' => '

The vendor for the virtual interface\'s router.

', ], ], 'VirtualGateway' => [ 'base' => '

Information about a virtual private gateway for a private virtual interface.

', 'refs' => [ 'VirtualGatewayList$member' => NULL, ], ], 'VirtualGatewayId' => [ 'base' => NULL, 'refs' => [ 'ConfirmPrivateVirtualInterfaceRequest$virtualGatewayId' => '

The ID of the virtual private gateway.

', 'CreateDirectConnectGatewayAssociationRequest$virtualGatewayId' => '

The ID of the virtual private gateway.

', 'DeleteDirectConnectGatewayAssociationRequest$virtualGatewayId' => '

The ID of the virtual private gateway.

', 'DescribeDirectConnectGatewayAssociationsRequest$virtualGatewayId' => '

The ID of the virtual private gateway or transit gateway.

', 'DirectConnectGatewayAssociation$virtualGatewayId' => '

The ID of the virtual private gateway. Applies only to private virtual interfaces.

', 'NewPrivateVirtualInterface$virtualGatewayId' => '

The ID of the virtual private gateway.

', 'VirtualGateway$virtualGatewayId' => '

The ID of the virtual private gateway.

', 'VirtualInterface$virtualGatewayId' => '

The ID of the virtual private gateway. Applies only to private virtual interfaces.

', ], ], 'VirtualGatewayList' => [ 'base' => NULL, 'refs' => [ 'VirtualGateways$virtualGateways' => '

The virtual private gateways.

', ], ], 'VirtualGatewayRegion' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGatewayAssociation$virtualGatewayRegion' => '

The Amazon Web Services Region where the virtual private gateway is located.

', ], ], 'VirtualGatewayState' => [ 'base' => NULL, 'refs' => [ 'VirtualGateway$virtualGatewayState' => '

The state of the virtual private gateway. The following are the possible values:

', ], ], 'VirtualGateways' => [ 'base' => NULL, 'refs' => [], ], 'VirtualInterface' => [ 'base' => '

Information about a virtual interface.

', 'refs' => [ 'AllocateTransitVirtualInterfaceResult$virtualInterface' => '

Information about the transit virtual interface.

', 'CreateBGPPeerResponse$virtualInterface' => '

The virtual interface.

', 'CreateTransitVirtualInterfaceResult$virtualInterface' => '

Information about a virtual interface.

', 'DeleteBGPPeerResponse$virtualInterface' => '

The virtual interface.

', 'VirtualInterfaceList$member' => NULL, ], ], 'VirtualInterfaceId' => [ 'base' => NULL, 'refs' => [ 'AssociateVirtualInterfaceRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'ConfirmPrivateVirtualInterfaceRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'ConfirmPublicVirtualInterfaceRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'ConfirmTransitVirtualInterfaceRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'CreateBGPPeerRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'DeleteBGPPeerRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'DeleteVirtualInterfaceRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'DescribeDirectConnectGatewayAttachmentsRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'DescribeRouterConfigurationRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'DescribeRouterConfigurationResponse$virtualInterfaceId' => '

The ID assigned to the virtual interface.

', 'DescribeVirtualInterfacesRequest$virtualInterfaceId' => '

The ID of the virtual interface.

', 'DirectConnectGatewayAttachment$virtualInterfaceId' => '

The ID of the virtual interface.

', 'ListVirtualInterfaceTestHistoryRequest$virtualInterfaceId' => '

The ID of the virtual interface that was tested.

', 'StartBgpFailoverTestRequest$virtualInterfaceId' => '

The ID of the virtual interface you want to test.

', 'StopBgpFailoverTestRequest$virtualInterfaceId' => '

The ID of the virtual interface you no longer want to test.

', 'UpdateVirtualInterfaceAttributesRequest$virtualInterfaceId' => '

The ID of the virtual private interface.

', 'VirtualInterface$virtualInterfaceId' => '

The ID of the virtual interface.

', 'VirtualInterfaceTestHistory$virtualInterfaceId' => '

The ID of the tested virtual interface.

', ], ], 'VirtualInterfaceList' => [ 'base' => NULL, 'refs' => [ 'VirtualInterfaces$virtualInterfaces' => '

The virtual interfaces

', ], ], 'VirtualInterfaceName' => [ 'base' => NULL, 'refs' => [ 'DescribeRouterConfigurationResponse$virtualInterfaceName' => '

Provides the details about a virtual interface\'s router.

', 'NewPrivateVirtualInterface$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', 'NewPrivateVirtualInterfaceAllocation$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', 'NewPublicVirtualInterface$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', 'NewPublicVirtualInterfaceAllocation$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', 'NewTransitVirtualInterface$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', 'NewTransitVirtualInterfaceAllocation$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', 'UpdateVirtualInterfaceAttributesRequest$virtualInterfaceName' => '

The name of the virtual private interface.

', 'VirtualInterface$virtualInterfaceName' => '

The name of the virtual interface assigned by the customer network. The name has a maximum of 100 characters. The following are valid characters: a-z, 0-9 and a hyphen (-).

', ], ], 'VirtualInterfaceRegion' => [ 'base' => NULL, 'refs' => [ 'DirectConnectGatewayAttachment$virtualInterfaceRegion' => '

The Amazon Web Services Region where the virtual interface is located.

', ], ], 'VirtualInterfaceState' => [ 'base' => NULL, 'refs' => [ 'ConfirmPrivateVirtualInterfaceResponse$virtualInterfaceState' => '

The state of the virtual interface. The following are the possible values:

', 'ConfirmPublicVirtualInterfaceResponse$virtualInterfaceState' => '

The state of the virtual interface. The following are the possible values:

', 'ConfirmTransitVirtualInterfaceResponse$virtualInterfaceState' => '

The state of the virtual interface. The following are the possible values:

', 'DeleteVirtualInterfaceResponse$virtualInterfaceState' => '

The state of the virtual interface. The following are the possible values:

', 'VirtualInterface$virtualInterfaceState' => '

The state of the virtual interface. The following are the possible values:

', ], ], 'VirtualInterfaceTestHistory' => [ 'base' => '

Information about the virtual interface failover test.

', 'refs' => [ 'StartBgpFailoverTestResponse$virtualInterfaceTest' => '

Information about the virtual interface failover test.

', 'StopBgpFailoverTestResponse$virtualInterfaceTest' => '

Information about the virtual interface failover test.

', 'VirtualInterfaceTestHistoryList$member' => NULL, ], ], 'VirtualInterfaceTestHistoryList' => [ 'base' => NULL, 'refs' => [ 'ListVirtualInterfaceTestHistoryResponse$virtualInterfaceTestHistory' => '

The ID of the tested virtual interface.

', ], ], 'VirtualInterfaceType' => [ 'base' => NULL, 'refs' => [ 'VirtualInterface$virtualInterfaceType' => '

The type of virtual interface. The possible values are private, public and transit.

', ], ], 'VirtualInterfaces' => [ 'base' => NULL, 'refs' => [], ], 'XsltTemplateName' => [ 'base' => NULL, 'refs' => [ 'RouterType$xsltTemplateName' => '

The template for the virtual interface\'s router.

', ], ], 'XsltTemplateNameForMacSec' => [ 'base' => NULL, 'refs' => [ 'RouterType$xsltTemplateNameForMacSec' => '

The MAC Security (MACsec) template for the virtual interface\'s router.

', ], ], ],]; diff --git a/src/data/networkmanager/2019-07-05/api-2.json b/src/data/networkmanager/2019-07-05/api-2.json index 1f87c11f49..474f67318f 100644 --- a/src/data/networkmanager/2019-07-05/api-2.json +++ b/src/data/networkmanager/2019-07-05/api-2.json @@ -191,6 +191,23 @@ {"shape":"InternalServerException"} ] }, + "CreateDirectConnectGatewayAttachment":{ + "name":"CreateDirectConnectGatewayAttachment", + "http":{ + "method":"POST", + "requestUri":"/direct-connect-gateway-attachments" + }, + "input":{"shape":"CreateDirectConnectGatewayAttachmentRequest"}, + "output":{"shape":"CreateDirectConnectGatewayAttachmentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "CreateGlobalNetwork":{ "name":"CreateGlobalNetwork", "http":{ @@ -778,6 +795,22 @@ {"shape":"InternalServerException"} ] }, + "GetDirectConnectGatewayAttachment":{ + "name":"GetDirectConnectGatewayAttachment", + "http":{ + "method":"GET", + "requestUri":"/direct-connect-gateway-attachments/{attachmentId}" + }, + "input":{"shape":"GetDirectConnectGatewayAttachmentRequest"}, + "output":{"shape":"GetDirectConnectGatewayAttachmentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "GetLinkAssociations":{ "name":"GetLinkAssociations", "http":{ @@ -1340,6 +1373,23 @@ {"shape":"InternalServerException"} ] }, + "UpdateDirectConnectGatewayAttachment":{ + "name":"UpdateDirectConnectGatewayAttachment", + "http":{ + "method":"PATCH", + "requestUri":"/direct-connect-gateway-attachments/{attachmentId}" + }, + "input":{"shape":"UpdateDirectConnectGatewayAttachmentRequest"}, + "output":{"shape":"UpdateDirectConnectGatewayAttachmentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ConflictException"}, + {"shape":"ThrottlingException"}, + {"shape":"InternalServerException"} + ] + }, "UpdateGlobalNetwork":{ "name":"UpdateGlobalNetwork", "http":{ @@ -1593,6 +1643,7 @@ "AttachmentType":{"shape":"AttachmentType"}, "State":{"shape":"AttachmentState"}, "EdgeLocation":{"shape":"ExternalRegionCode"}, + "EdgeLocations":{"shape":"ExternalRegionCodeList"}, "ResourceArn":{"shape":"ResourceArn"}, "AttachmentPolicyRuleNumber":{"shape":"Integer"}, "SegmentName":{"shape":"ConstrainedString"}, @@ -1624,7 +1675,10 @@ "SUBNET_UNSUPPORTED_AVAILABILITY_ZONE", "SUBNET_NO_IPV6_CIDRS", "VPN_CONNECTION_NOT_FOUND", - "MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED" + "MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED", + "DIRECT_CONNECT_GATEWAY_NOT_FOUND", + "DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS", + "DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF" ] }, "AttachmentErrorList":{ @@ -1663,6 +1717,7 @@ "CONNECT", "SITE_TO_SITE_VPN", "VPC", + "DIRECT_CONNECT_GATEWAY", "TRANSIT_GATEWAY_ROUTE_TABLE" ] }, @@ -2311,6 +2366,30 @@ "Device":{"shape":"Device"} } }, + "CreateDirectConnectGatewayAttachmentRequest":{ + "type":"structure", + "required":[ + "CoreNetworkId", + "DirectConnectGatewayArn", + "EdgeLocations" + ], + "members":{ + "CoreNetworkId":{"shape":"CoreNetworkId"}, + "DirectConnectGatewayArn":{"shape":"DirectConnectGatewayArn"}, + "EdgeLocations":{"shape":"ExternalRegionCodeList"}, + "Tags":{"shape":"TagList"}, + "ClientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + } + } + }, + "CreateDirectConnectGatewayAttachmentResponse":{ + "type":"structure", + "members":{ + "DirectConnectGatewayAttachment":{"shape":"DirectConnectGatewayAttachment"} + } + }, "CreateGlobalNetworkRequest":{ "type":"structure", "members":{ @@ -2822,6 +2901,19 @@ "UPDATING" ] }, + "DirectConnectGatewayArn":{ + "type":"string", + "max":500, + "min":0, + "pattern":"^arn:[^:]{1,63}:directconnect::[^:]{0,63}:dx-gateway\\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$" + }, + "DirectConnectGatewayAttachment":{ + "type":"structure", + "members":{ + "Attachment":{"shape":"Attachment"}, + "DirectConnectGatewayArn":{"shape":"DirectConnectGatewayArn"} + } + }, "DisassociateConnectPeerRequest":{ "type":"structure", "required":[ @@ -3295,6 +3387,23 @@ "NextToken":{"shape":"NextToken"} } }, + "GetDirectConnectGatewayAttachmentRequest":{ + "type":"structure", + "required":["AttachmentId"], + "members":{ + "AttachmentId":{ + "shape":"AttachmentId", + "location":"uri", + "locationName":"attachmentId" + } + } + }, + "GetDirectConnectGatewayAttachmentResponse":{ + "type":"structure", + "members":{ + "DirectConnectGatewayAttachment":{"shape":"DirectConnectGatewayAttachment"} + } + }, "GetLinkAssociationsRequest":{ "type":"structure", "required":["GlobalNetworkId"], @@ -5147,6 +5256,24 @@ "Device":{"shape":"Device"} } }, + "UpdateDirectConnectGatewayAttachmentRequest":{ + "type":"structure", + "required":["AttachmentId"], + "members":{ + "AttachmentId":{ + "shape":"AttachmentId", + "location":"uri", + "locationName":"attachmentId" + }, + "EdgeLocations":{"shape":"ExternalRegionCodeList"} + } + }, + "UpdateDirectConnectGatewayAttachmentResponse":{ + "type":"structure", + "members":{ + "DirectConnectGatewayAttachment":{"shape":"DirectConnectGatewayAttachment"} + } + }, "UpdateGlobalNetworkRequest":{ "type":"structure", "required":["GlobalNetworkId"], diff --git a/src/data/networkmanager/2019-07-05/api-2.json.php b/src/data/networkmanager/2019-07-05/api-2.json.php index bca580afe1..055ed60462 100644 --- a/src/data/networkmanager/2019-07-05/api-2.json.php +++ b/src/data/networkmanager/2019-07-05/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2019-07-05', 'endpointPrefix' => 'networkmanager', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceAbbreviation' => 'NetworkManager', 'serviceFullName' => 'AWS Network Manager', 'serviceId' => 'NetworkManager', 'signatureVersion' => 'v4', 'signingName' => 'networkmanager', 'uid' => 'networkmanager-2019-07-05', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'AcceptAttachment' => [ 'name' => 'AcceptAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/attachments/{attachmentId}/accept', ], 'input' => [ 'shape' => 'AcceptAttachmentRequest', ], 'output' => [ 'shape' => 'AcceptAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'AssociateConnectPeer' => [ 'name' => 'AssociateConnectPeer', 'http' => [ 'method' => 'POST', 'requestUri' => '/global-networks/{globalNetworkId}/connect-peer-associations', ], 'input' => [ 'shape' => 'AssociateConnectPeerRequest', ], 'output' => [ 'shape' => 'AssociateConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], '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', ], ], ], 'AssociateTransitGatewayConnectPeer' => [ 'name' => 'AssociateTransitGatewayConnectPeer', 'http' => [ 'method' => 'POST', 'requestUri' => '/global-networks/{globalNetworkId}/transit-gateway-connect-peer-associations', ], 'input' => [ 'shape' => 'AssociateTransitGatewayConnectPeerRequest', ], 'output' => [ 'shape' => 'AssociateTransitGatewayConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateConnectAttachment' => [ 'name' => 'CreateConnectAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/connect-attachments', ], 'input' => [ 'shape' => 'CreateConnectAttachmentRequest', ], 'output' => [ 'shape' => 'CreateConnectAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateConnectPeer' => [ 'name' => 'CreateConnectPeer', 'http' => [ 'method' => 'POST', 'requestUri' => '/connect-peers', ], 'input' => [ 'shape' => 'CreateConnectPeerRequest', ], 'output' => [ 'shape' => 'CreateConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateConnection' => [ 'name' => 'CreateConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/global-networks/{globalNetworkId}/connections', ], 'input' => [ 'shape' => 'CreateConnectionRequest', ], 'output' => [ 'shape' => 'CreateConnectionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateCoreNetwork' => [ 'name' => 'CreateCoreNetwork', 'http' => [ 'method' => 'POST', 'requestUri' => '/core-networks', ], 'input' => [ 'shape' => 'CreateCoreNetworkRequest', ], 'output' => [ 'shape' => 'CreateCoreNetworkResponse', ], 'errors' => [ [ 'shape' => 'CoreNetworkPolicyException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], 'CreateSiteToSiteVpnAttachment' => [ 'name' => 'CreateSiteToSiteVpnAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/site-to-site-vpn-attachments', ], 'input' => [ 'shape' => 'CreateSiteToSiteVpnAttachmentRequest', ], 'output' => [ 'shape' => 'CreateSiteToSiteVpnAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateTransitGatewayPeering' => [ 'name' => 'CreateTransitGatewayPeering', 'http' => [ 'method' => 'POST', 'requestUri' => '/transit-gateway-peerings', ], 'input' => [ 'shape' => 'CreateTransitGatewayPeeringRequest', ], 'output' => [ 'shape' => 'CreateTransitGatewayPeeringResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateTransitGatewayRouteTableAttachment' => [ 'name' => 'CreateTransitGatewayRouteTableAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/transit-gateway-route-table-attachments', ], 'input' => [ 'shape' => 'CreateTransitGatewayRouteTableAttachmentRequest', ], 'output' => [ 'shape' => 'CreateTransitGatewayRouteTableAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateVpcAttachment' => [ 'name' => 'CreateVpcAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/vpc-attachments', ], 'input' => [ 'shape' => 'CreateVpcAttachmentRequest', ], 'output' => [ 'shape' => 'CreateVpcAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteAttachment' => [ 'name' => 'DeleteAttachment', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/attachments/{attachmentId}', ], 'input' => [ 'shape' => 'DeleteAttachmentRequest', ], 'output' => [ 'shape' => 'DeleteAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteConnectPeer' => [ 'name' => 'DeleteConnectPeer', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/connect-peers/{connectPeerId}', ], 'input' => [ 'shape' => 'DeleteConnectPeerRequest', ], 'output' => [ 'shape' => 'DeleteConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteConnection' => [ 'name' => 'DeleteConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/global-networks/{globalNetworkId}/connections/{connectionId}', ], 'input' => [ 'shape' => 'DeleteConnectionRequest', ], 'output' => [ 'shape' => 'DeleteConnectionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteCoreNetwork' => [ 'name' => 'DeleteCoreNetwork', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/core-networks/{coreNetworkId}', ], 'input' => [ 'shape' => 'DeleteCoreNetworkRequest', ], 'output' => [ 'shape' => 'DeleteCoreNetworkResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteCoreNetworkPolicyVersion' => [ 'name' => 'DeleteCoreNetworkPolicyVersion', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-policy-versions/{policyVersionId}', ], 'input' => [ 'shape' => 'DeleteCoreNetworkPolicyVersionRequest', ], 'output' => [ 'shape' => 'DeleteCoreNetworkPolicyVersionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], 'DeletePeering' => [ 'name' => 'DeletePeering', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/peerings/{peeringId}', ], 'input' => [ 'shape' => 'DeletePeeringRequest', ], 'output' => [ 'shape' => 'DeletePeeringResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteResourcePolicy' => [ 'name' => 'DeleteResourcePolicy', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/resource-policy/{resourceArn}', ], 'input' => [ 'shape' => 'DeleteResourcePolicyRequest', ], 'output' => [ 'shape' => 'DeleteResourcePolicyResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], 'DisassociateConnectPeer' => [ 'name' => 'DisassociateConnectPeer', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/global-networks/{globalNetworkId}/connect-peer-associations/{connectPeerId}', ], 'input' => [ 'shape' => 'DisassociateConnectPeerRequest', ], 'output' => [ 'shape' => 'DisassociateConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DisassociateCustomerGateway' => [ 'name' => 'DisassociateCustomerGateway', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/global-networks/{globalNetworkId}/customer-gateway-associations/{customerGatewayArn}', ], 'input' => [ 'shape' => 'DisassociateCustomerGatewayRequest', ], 'output' => [ 'shape' => 'DisassociateCustomerGatewayResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'DisassociateTransitGatewayConnectPeer' => [ 'name' => 'DisassociateTransitGatewayConnectPeer', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/global-networks/{globalNetworkId}/transit-gateway-connect-peer-associations/{transitGatewayConnectPeerArn}', ], 'input' => [ 'shape' => 'DisassociateTransitGatewayConnectPeerRequest', ], 'output' => [ 'shape' => 'DisassociateTransitGatewayConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ExecuteCoreNetworkChangeSet' => [ 'name' => 'ExecuteCoreNetworkChangeSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-change-sets/{policyVersionId}/execute', ], 'input' => [ 'shape' => 'ExecuteCoreNetworkChangeSetRequest', ], 'output' => [ 'shape' => 'ExecuteCoreNetworkChangeSetResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], ], ], 'GetConnectAttachment' => [ 'name' => 'GetConnectAttachment', 'http' => [ 'method' => 'GET', 'requestUri' => '/connect-attachments/{attachmentId}', ], 'input' => [ 'shape' => 'GetConnectAttachmentRequest', ], 'output' => [ 'shape' => 'GetConnectAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetConnectPeer' => [ 'name' => 'GetConnectPeer', 'http' => [ 'method' => 'GET', 'requestUri' => '/connect-peers/{connectPeerId}', ], 'input' => [ 'shape' => 'GetConnectPeerRequest', ], 'output' => [ 'shape' => 'GetConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetConnectPeerAssociations' => [ 'name' => 'GetConnectPeerAssociations', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/connect-peer-associations', ], 'input' => [ 'shape' => 'GetConnectPeerAssociationsRequest', ], 'output' => [ 'shape' => 'GetConnectPeerAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetConnections' => [ 'name' => 'GetConnections', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/connections', ], 'input' => [ 'shape' => 'GetConnectionsRequest', ], 'output' => [ 'shape' => 'GetConnectionsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetCoreNetwork' => [ 'name' => 'GetCoreNetwork', 'http' => [ 'method' => 'GET', 'requestUri' => '/core-networks/{coreNetworkId}', ], 'input' => [ 'shape' => 'GetCoreNetworkRequest', ], 'output' => [ 'shape' => 'GetCoreNetworkResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetCoreNetworkChangeEvents' => [ 'name' => 'GetCoreNetworkChangeEvents', 'http' => [ 'method' => 'GET', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-change-events/{policyVersionId}', ], 'input' => [ 'shape' => 'GetCoreNetworkChangeEventsRequest', ], 'output' => [ 'shape' => 'GetCoreNetworkChangeEventsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetCoreNetworkChangeSet' => [ 'name' => 'GetCoreNetworkChangeSet', 'http' => [ 'method' => 'GET', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-change-sets/{policyVersionId}', ], 'input' => [ 'shape' => 'GetCoreNetworkChangeSetRequest', ], 'output' => [ 'shape' => 'GetCoreNetworkChangeSetResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetCoreNetworkPolicy' => [ 'name' => 'GetCoreNetworkPolicy', 'http' => [ 'method' => 'GET', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-policy', ], 'input' => [ 'shape' => 'GetCoreNetworkPolicyRequest', ], 'output' => [ 'shape' => 'GetCoreNetworkPolicyResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], 'GetNetworkResourceCounts' => [ 'name' => 'GetNetworkResourceCounts', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/network-resource-count', ], 'input' => [ 'shape' => 'GetNetworkResourceCountsRequest', ], 'output' => [ 'shape' => 'GetNetworkResourceCountsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetNetworkResourceRelationships' => [ 'name' => 'GetNetworkResourceRelationships', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/network-resource-relationships', ], 'input' => [ 'shape' => 'GetNetworkResourceRelationshipsRequest', ], 'output' => [ 'shape' => 'GetNetworkResourceRelationshipsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetNetworkResources' => [ 'name' => 'GetNetworkResources', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/network-resources', ], 'input' => [ 'shape' => 'GetNetworkResourcesRequest', ], 'output' => [ 'shape' => 'GetNetworkResourcesResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetNetworkRoutes' => [ 'name' => 'GetNetworkRoutes', 'http' => [ 'method' => 'POST', 'requestUri' => '/global-networks/{globalNetworkId}/network-routes', ], 'input' => [ 'shape' => 'GetNetworkRoutesRequest', ], 'output' => [ 'shape' => 'GetNetworkRoutesResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetNetworkTelemetry' => [ 'name' => 'GetNetworkTelemetry', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/network-telemetry', ], 'input' => [ 'shape' => 'GetNetworkTelemetryRequest', ], 'output' => [ 'shape' => 'GetNetworkTelemetryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetResourcePolicy' => [ 'name' => 'GetResourcePolicy', 'http' => [ 'method' => 'GET', 'requestUri' => '/resource-policy/{resourceArn}', ], 'input' => [ 'shape' => 'GetResourcePolicyRequest', ], 'output' => [ 'shape' => 'GetResourcePolicyResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetRouteAnalysis' => [ 'name' => 'GetRouteAnalysis', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/route-analyses/{routeAnalysisId}', ], 'input' => [ 'shape' => 'GetRouteAnalysisRequest', ], 'output' => [ 'shape' => 'GetRouteAnalysisResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetSiteToSiteVpnAttachment' => [ 'name' => 'GetSiteToSiteVpnAttachment', 'http' => [ 'method' => 'GET', 'requestUri' => '/site-to-site-vpn-attachments/{attachmentId}', ], 'input' => [ 'shape' => 'GetSiteToSiteVpnAttachmentRequest', ], 'output' => [ 'shape' => 'GetSiteToSiteVpnAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'GetTransitGatewayConnectPeerAssociations' => [ 'name' => 'GetTransitGatewayConnectPeerAssociations', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/transit-gateway-connect-peer-associations', ], 'input' => [ 'shape' => 'GetTransitGatewayConnectPeerAssociationsRequest', ], 'output' => [ 'shape' => 'GetTransitGatewayConnectPeerAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetTransitGatewayPeering' => [ 'name' => 'GetTransitGatewayPeering', 'http' => [ 'method' => 'GET', 'requestUri' => '/transit-gateway-peerings/{peeringId}', ], 'input' => [ 'shape' => 'GetTransitGatewayPeeringRequest', ], 'output' => [ 'shape' => 'GetTransitGatewayPeeringResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'GetTransitGatewayRouteTableAttachment' => [ 'name' => 'GetTransitGatewayRouteTableAttachment', 'http' => [ 'method' => 'GET', 'requestUri' => '/transit-gateway-route-table-attachments/{attachmentId}', ], 'input' => [ 'shape' => 'GetTransitGatewayRouteTableAttachmentRequest', ], 'output' => [ 'shape' => 'GetTransitGatewayRouteTableAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetVpcAttachment' => [ 'name' => 'GetVpcAttachment', 'http' => [ 'method' => 'GET', 'requestUri' => '/vpc-attachments/{attachmentId}', ], 'input' => [ 'shape' => 'GetVpcAttachmentRequest', ], 'output' => [ 'shape' => 'GetVpcAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListAttachments' => [ 'name' => 'ListAttachments', 'http' => [ 'method' => 'GET', 'requestUri' => '/attachments', ], 'input' => [ 'shape' => 'ListAttachmentsRequest', ], 'output' => [ 'shape' => 'ListAttachmentsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListConnectPeers' => [ 'name' => 'ListConnectPeers', 'http' => [ 'method' => 'GET', 'requestUri' => '/connect-peers', ], 'input' => [ 'shape' => 'ListConnectPeersRequest', ], 'output' => [ 'shape' => 'ListConnectPeersResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListCoreNetworkPolicyVersions' => [ 'name' => 'ListCoreNetworkPolicyVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-policy-versions', ], 'input' => [ 'shape' => 'ListCoreNetworkPolicyVersionsRequest', ], 'output' => [ 'shape' => 'ListCoreNetworkPolicyVersionsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListCoreNetworks' => [ 'name' => 'ListCoreNetworks', 'http' => [ 'method' => 'GET', 'requestUri' => '/core-networks', ], 'input' => [ 'shape' => 'ListCoreNetworksRequest', ], 'output' => [ 'shape' => 'ListCoreNetworksResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListOrganizationServiceAccessStatus' => [ 'name' => 'ListOrganizationServiceAccessStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/organizations/service-access', ], 'input' => [ 'shape' => 'ListOrganizationServiceAccessStatusRequest', ], 'output' => [ 'shape' => 'ListOrganizationServiceAccessStatusResponse', ], ], 'ListPeerings' => [ 'name' => 'ListPeerings', 'http' => [ 'method' => 'GET', 'requestUri' => '/peerings', ], 'input' => [ 'shape' => 'ListPeeringsRequest', ], 'output' => [ 'shape' => 'ListPeeringsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'PutCoreNetworkPolicy' => [ 'name' => 'PutCoreNetworkPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-policy', ], 'input' => [ 'shape' => 'PutCoreNetworkPolicyRequest', ], 'output' => [ 'shape' => 'PutCoreNetworkPolicyResponse', ], 'errors' => [ [ 'shape' => 'CoreNetworkPolicyException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], ], ], 'PutResourcePolicy' => [ 'name' => 'PutResourcePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/resource-policy/{resourceArn}', ], 'input' => [ 'shape' => 'PutResourcePolicyRequest', ], 'output' => [ 'shape' => 'PutResourcePolicyResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'RejectAttachment' => [ 'name' => 'RejectAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/attachments/{attachmentId}/reject', ], 'input' => [ 'shape' => 'RejectAttachmentRequest', ], 'output' => [ 'shape' => 'RejectAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'RestoreCoreNetworkPolicyVersion' => [ 'name' => 'RestoreCoreNetworkPolicyVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-policy-versions/{policyVersionId}/restore', ], 'input' => [ 'shape' => 'RestoreCoreNetworkPolicyVersionRequest', ], 'output' => [ 'shape' => 'RestoreCoreNetworkPolicyVersionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], ], ], 'StartOrganizationServiceAccessUpdate' => [ 'name' => 'StartOrganizationServiceAccessUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/organizations/service-access', ], 'input' => [ 'shape' => 'StartOrganizationServiceAccessUpdateRequest', ], 'output' => [ 'shape' => 'StartOrganizationServiceAccessUpdateResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'StartRouteAnalysis' => [ 'name' => 'StartRouteAnalysis', 'http' => [ 'method' => 'POST', 'requestUri' => '/global-networks/{globalNetworkId}/route-analyses', ], 'input' => [ 'shape' => 'StartRouteAnalysisRequest', ], 'output' => [ 'shape' => 'StartRouteAnalysisResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], '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', ], ], ], 'UpdateConnection' => [ 'name' => 'UpdateConnection', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/global-networks/{globalNetworkId}/connections/{connectionId}', ], 'input' => [ 'shape' => 'UpdateConnectionRequest', ], 'output' => [ 'shape' => 'UpdateConnectionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UpdateCoreNetwork' => [ 'name' => 'UpdateCoreNetwork', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/core-networks/{coreNetworkId}', ], 'input' => [ 'shape' => 'UpdateCoreNetworkRequest', ], 'output' => [ 'shape' => 'UpdateCoreNetworkResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], 'UpdateNetworkResourceMetadata' => [ 'name' => 'UpdateNetworkResourceMetadata', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/global-networks/{globalNetworkId}/network-resources/{resourceArn}/metadata', ], 'input' => [ 'shape' => 'UpdateNetworkResourceMetadataRequest', ], 'output' => [ 'shape' => 'UpdateNetworkResourceMetadataResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'UpdateVpcAttachment' => [ 'name' => 'UpdateVpcAttachment', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/vpc-attachments/{attachmentId}', ], 'input' => [ 'shape' => 'UpdateVpcAttachmentRequest', ], 'output' => [ 'shape' => 'UpdateVpcAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], ], 'shapes' => [ 'AWSAccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '[\\s\\S]*', ], 'AWSLocation' => [ 'type' => 'structure', 'members' => [ 'Zone' => [ 'shape' => 'ConstrainedString', ], 'SubnetArn' => [ 'shape' => 'SubnetArn', ], ], ], 'AcceptAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'AcceptAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], ], ], 'AccessDeniedException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'AccountId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, ], 'AccountStatus' => [ 'type' => 'structure', 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'SLRDeploymentStatus' => [ 'shape' => 'SLRDeploymentStatus', ], ], ], 'AccountStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountStatus', ], ], 'Action' => [ 'type' => 'string', 'max' => 50, 'min' => 0, ], 'AssociateConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'ConnectPeerId', 'DeviceId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], ], ], 'AssociateConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeerAssociation' => [ 'shape' => 'ConnectPeerAssociation', ], ], ], 'AssociateCustomerGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'CustomerGatewayArn', 'GlobalNetworkId', 'DeviceId', ], 'members' => [ 'CustomerGatewayArn' => [ 'shape' => 'CustomerGatewayArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], ], ], 'AssociateCustomerGatewayResponse' => [ 'type' => 'structure', 'members' => [ 'CustomerGatewayAssociation' => [ 'shape' => 'CustomerGatewayAssociation', ], ], ], 'AssociateLinkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'DeviceId', 'LinkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], ], ], 'AssociateLinkResponse' => [ 'type' => 'structure', 'members' => [ 'LinkAssociation' => [ 'shape' => 'LinkAssociation', ], ], ], 'AssociateTransitGatewayConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'TransitGatewayConnectPeerArn', 'DeviceId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'TransitGatewayConnectPeerArn' => [ 'shape' => 'TransitGatewayConnectPeerArn', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], ], ], 'AssociateTransitGatewayConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayConnectPeerAssociation' => [ 'shape' => 'TransitGatewayConnectPeerAssociation', ], ], ], 'Attachment' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'CoreNetworkArn' => [ 'shape' => 'CoreNetworkArn', ], 'AttachmentId' => [ 'shape' => 'AttachmentId', ], 'OwnerAccountId' => [ 'shape' => 'AWSAccountId', ], 'AttachmentType' => [ 'shape' => 'AttachmentType', ], 'State' => [ 'shape' => 'AttachmentState', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'AttachmentPolicyRuleNumber' => [ 'shape' => 'Integer', ], 'SegmentName' => [ 'shape' => 'ConstrainedString', ], 'NetworkFunctionGroupName' => [ 'shape' => 'NetworkFunctionGroupName', ], 'Tags' => [ 'shape' => 'TagList', ], 'ProposedSegmentChange' => [ 'shape' => 'ProposedSegmentChange', ], 'ProposedNetworkFunctionGroupChange' => [ 'shape' => 'ProposedNetworkFunctionGroupChange', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'UpdatedAt' => [ 'shape' => 'DateTime', ], 'LastModificationErrors' => [ 'shape' => 'AttachmentErrorList', ], ], ], 'AttachmentError' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'AttachmentErrorCode', ], 'Message' => [ 'shape' => 'ServerSideString', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'RequestId' => [ 'shape' => 'ServerSideString', ], ], ], 'AttachmentErrorCode' => [ 'type' => 'string', 'enum' => [ 'VPC_NOT_FOUND', 'SUBNET_NOT_FOUND', 'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE', 'SUBNET_NO_FREE_ADDRESSES', 'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE', 'SUBNET_NO_IPV6_CIDRS', 'VPN_CONNECTION_NOT_FOUND', 'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED', ], ], 'AttachmentErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachmentError', ], 'max' => 20, 'min' => 0, ], 'AttachmentId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '^attachment-([0-9a-f]{8,17})$', ], 'AttachmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attachment', ], ], 'AttachmentState' => [ 'type' => 'string', 'enum' => [ 'REJECTED', 'PENDING_ATTACHMENT_ACCEPTANCE', 'CREATING', 'FAILED', 'AVAILABLE', 'UPDATING', 'PENDING_NETWORK_UPDATE', 'PENDING_TAG_ACCEPTANCE', 'DELETING', ], ], 'AttachmentType' => [ 'type' => 'string', 'enum' => [ 'CONNECT', 'SITE_TO_SITE_VPN', 'VPC', 'TRANSIT_GATEWAY_ROUTE_TABLE', ], ], 'Bandwidth' => [ 'type' => 'structure', 'members' => [ 'UploadSpeed' => [ 'shape' => 'Integer', ], 'DownloadSpeed' => [ 'shape' => 'Integer', ], ], ], 'BgpOptions' => [ 'type' => 'structure', 'members' => [ 'PeerAsn' => [ 'shape' => 'Long', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'ChangeAction' => [ 'type' => 'string', 'enum' => [ 'ADD', 'MODIFY', 'REMOVE', ], ], 'ChangeSetState' => [ 'type' => 'string', 'enum' => [ 'PENDING_GENERATION', 'FAILED_GENERATION', 'READY_TO_EXECUTE', 'EXECUTING', 'EXECUTION_SUCCEEDED', 'OUT_OF_DATE', ], ], 'ChangeStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'FAILED', ], ], 'ChangeType' => [ 'type' => 'string', 'enum' => [ 'CORE_NETWORK_SEGMENT', 'NETWORK_FUNCTION_GROUP', 'CORE_NETWORK_EDGE', 'ATTACHMENT_MAPPING', 'ATTACHMENT_ROUTE_PROPAGATION', 'ATTACHMENT_ROUTE_STATIC', 'CORE_NETWORK_CONFIGURATION', 'SEGMENTS_CONFIGURATION', 'SEGMENT_ACTIONS_CONFIGURATION', 'ATTACHMENT_POLICIES_CONFIGURATION', ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ConflictException' => [ 'type' => 'structure', 'required' => [ 'Message', 'ResourceId', 'ResourceType', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'ResourceId' => [ 'shape' => 'ServerSideString', ], 'ResourceType' => [ 'shape' => 'ServerSideString', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ConnectAttachment' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], 'TransportAttachmentId' => [ 'shape' => 'AttachmentId', ], 'Options' => [ 'shape' => 'ConnectAttachmentOptions', ], ], ], 'ConnectAttachmentOptions' => [ 'type' => 'structure', 'members' => [ 'Protocol' => [ 'shape' => 'TunnelProtocol', ], ], ], 'ConnectPeer' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'ConnectAttachmentId' => [ 'shape' => 'AttachmentId', ], 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'State' => [ 'shape' => 'ConnectPeerState', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'Configuration' => [ 'shape' => 'ConnectPeerConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], 'SubnetArn' => [ 'shape' => 'SubnetArn', ], 'LastModificationErrors' => [ 'shape' => 'ConnectPeerErrorList', ], ], ], 'ConnectPeerAssociation' => [ 'type' => 'structure', 'members' => [ 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'State' => [ 'shape' => 'ConnectPeerAssociationState', ], ], ], 'ConnectPeerAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectPeerAssociation', ], ], 'ConnectPeerAssociationState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'DELETED', ], ], 'ConnectPeerBgpConfiguration' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkAsn' => [ 'shape' => 'Long', ], 'PeerAsn' => [ 'shape' => 'Long', ], 'CoreNetworkAddress' => [ 'shape' => 'IPAddress', ], 'PeerAddress' => [ 'shape' => 'IPAddress', ], ], ], 'ConnectPeerBgpConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectPeerBgpConfiguration', ], ], 'ConnectPeerConfiguration' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkAddress' => [ 'shape' => 'IPAddress', ], 'PeerAddress' => [ 'shape' => 'IPAddress', ], 'InsideCidrBlocks' => [ 'shape' => 'ConstrainedStringList', ], 'Protocol' => [ 'shape' => 'TunnelProtocol', ], 'BgpConfigurations' => [ 'shape' => 'ConnectPeerBgpConfigurationList', ], ], ], 'ConnectPeerError' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'ConnectPeerErrorCode', ], 'Message' => [ 'shape' => 'ServerSideString', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'RequestId' => [ 'shape' => 'ServerSideString', ], ], ], 'ConnectPeerErrorCode' => [ 'type' => 'string', 'enum' => [ 'EDGE_LOCATION_NO_FREE_IPS', 'EDGE_LOCATION_PEER_DUPLICATE', 'SUBNET_NOT_FOUND', 'IP_OUTSIDE_SUBNET_CIDR_RANGE', 'INVALID_INSIDE_CIDR_BLOCK', 'NO_ASSOCIATED_CIDR_BLOCK', ], ], 'ConnectPeerErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectPeerError', ], 'max' => 20, 'min' => 0, ], 'ConnectPeerId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '^connect-peer-([0-9a-f]{8,17})$', ], 'ConnectPeerIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectPeerId', ], ], 'ConnectPeerState' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'FAILED', 'AVAILABLE', 'DELETING', ], ], 'ConnectPeerSummary' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'ConnectAttachmentId' => [ 'shape' => 'AttachmentId', ], 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'ConnectPeerState' => [ 'shape' => 'ConnectPeerState', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'Tags' => [ 'shape' => 'TagList', ], 'SubnetArn' => [ 'shape' => 'SubnetArn', ], ], ], 'ConnectPeerSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectPeerSummary', ], ], 'Connection' => [ 'type' => 'structure', 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', ], 'ConnectionArn' => [ 'shape' => 'ConnectionArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'ConnectedDeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'ConnectedLinkId' => [ 'shape' => 'LinkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'State' => [ 'shape' => 'ConnectionState', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ConnectionArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ConnectionHealth' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ConnectionType', ], 'Status' => [ 'shape' => 'ConnectionStatus', ], 'Timestamp' => [ 'shape' => 'DateTime', ], ], ], 'ConnectionId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ConnectionIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectionId', ], ], 'ConnectionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Connection', ], ], 'ConnectionState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'UPDATING', ], ], 'ConnectionStatus' => [ 'type' => 'string', 'enum' => [ 'UP', 'DOWN', ], ], 'ConnectionType' => [ 'type' => 'string', 'enum' => [ 'BGP', 'IPSEC', ], ], 'ConstrainedString' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ConstrainedStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConstrainedString', ], ], 'CoreNetwork' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'CoreNetworkArn' => [ 'shape' => 'CoreNetworkArn', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'State' => [ 'shape' => 'CoreNetworkState', ], 'Segments' => [ 'shape' => 'CoreNetworkSegmentList', ], 'NetworkFunctionGroups' => [ 'shape' => 'CoreNetworkNetworkFunctionGroupList', ], 'Edges' => [ 'shape' => 'CoreNetworkEdgeList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CoreNetworkArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'CoreNetworkChange' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ChangeType', ], 'Action' => [ 'shape' => 'ChangeAction', ], 'Identifier' => [ 'shape' => 'ConstrainedString', ], 'PreviousValues' => [ 'shape' => 'CoreNetworkChangeValues', ], 'NewValues' => [ 'shape' => 'CoreNetworkChangeValues', ], 'IdentifierPath' => [ 'shape' => 'ConstrainedString', ], ], ], 'CoreNetworkChangeEvent' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ChangeType', ], 'Action' => [ 'shape' => 'ChangeAction', ], 'IdentifierPath' => [ 'shape' => 'ConstrainedString', ], 'EventTime' => [ 'shape' => 'DateTime', ], 'Status' => [ 'shape' => 'ChangeStatus', ], 'Values' => [ 'shape' => 'CoreNetworkChangeEventValues', ], ], ], 'CoreNetworkChangeEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkChangeEvent', ], ], 'CoreNetworkChangeEventValues' => [ 'type' => 'structure', 'members' => [ 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'SegmentName' => [ 'shape' => 'ConstrainedString', ], 'NetworkFunctionGroupName' => [ 'shape' => 'ConstrainedString', ], 'AttachmentId' => [ 'shape' => 'AttachmentId', ], 'Cidr' => [ 'shape' => 'ConstrainedString', ], ], ], 'CoreNetworkChangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkChange', ], ], 'CoreNetworkChangeValues' => [ 'type' => 'structure', 'members' => [ 'SegmentName' => [ 'shape' => 'ConstrainedString', ], 'NetworkFunctionGroupName' => [ 'shape' => 'ConstrainedString', ], 'EdgeLocations' => [ 'shape' => 'ExternalRegionCodeList', ], 'Asn' => [ 'shape' => 'Long', ], 'Cidr' => [ 'shape' => 'ConstrainedString', ], 'DestinationIdentifier' => [ 'shape' => 'ConstrainedString', ], 'InsideCidrBlocks' => [ 'shape' => 'ConstrainedStringList', ], 'SharedSegments' => [ 'shape' => 'ConstrainedStringList', ], 'ServiceInsertionActions' => [ 'shape' => 'ServiceInsertionActionList', ], ], ], 'CoreNetworkEdge' => [ 'type' => 'structure', 'members' => [ 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'Asn' => [ 'shape' => 'Long', ], 'InsideCidrBlocks' => [ 'shape' => 'ConstrainedStringList', ], ], ], 'CoreNetworkEdgeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkEdge', ], ], 'CoreNetworkId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '^core-network-([0-9a-f]{8,17})$', ], 'CoreNetworkNetworkFunctionGroup' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ConstrainedString', ], 'EdgeLocations' => [ 'shape' => 'ExternalRegionCodeList', ], 'Segments' => [ 'shape' => 'ServiceInsertionSegments', ], ], ], 'CoreNetworkNetworkFunctionGroupIdentifier' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'NetworkFunctionGroupName' => [ 'shape' => 'ConstrainedString', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], ], ], 'CoreNetworkNetworkFunctionGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkNetworkFunctionGroup', ], ], 'CoreNetworkPolicy' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', ], 'Alias' => [ 'shape' => 'CoreNetworkPolicyAlias', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'ChangeSetState' => [ 'shape' => 'ChangeSetState', ], 'PolicyErrors' => [ 'shape' => 'CoreNetworkPolicyErrorList', ], 'PolicyDocument' => [ 'shape' => 'CoreNetworkPolicyDocument', 'jsonvalue' => true, ], ], ], 'CoreNetworkPolicyAlias' => [ 'type' => 'string', 'enum' => [ 'LIVE', 'LATEST', ], ], 'CoreNetworkPolicyDocument' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'CoreNetworkPolicyError' => [ 'type' => 'structure', 'required' => [ 'ErrorCode', 'Message', ], 'members' => [ 'ErrorCode' => [ 'shape' => 'ServerSideString', ], 'Message' => [ 'shape' => 'ServerSideString', ], 'Path' => [ 'shape' => 'ServerSideString', ], ], ], 'CoreNetworkPolicyErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkPolicyError', ], ], 'CoreNetworkPolicyException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'Errors' => [ 'shape' => 'CoreNetworkPolicyErrorList', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'CoreNetworkPolicyVersion' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', ], 'Alias' => [ 'shape' => 'CoreNetworkPolicyAlias', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'ChangeSetState' => [ 'shape' => 'ChangeSetState', ], ], ], 'CoreNetworkPolicyVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkPolicyVersion', ], ], 'CoreNetworkSegment' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ConstrainedString', ], 'EdgeLocations' => [ 'shape' => 'ExternalRegionCodeList', ], 'SharedSegments' => [ 'shape' => 'ConstrainedStringList', ], ], ], 'CoreNetworkSegmentEdgeIdentifier' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'SegmentName' => [ 'shape' => 'ConstrainedString', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], ], ], 'CoreNetworkSegmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkSegment', ], ], 'CoreNetworkState' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'UPDATING', 'AVAILABLE', 'DELETING', ], ], 'CoreNetworkSummary' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'CoreNetworkArn' => [ 'shape' => 'CoreNetworkArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'OwnerAccountId' => [ 'shape' => 'AWSAccountId', ], 'State' => [ 'shape' => 'CoreNetworkState', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CoreNetworkSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkSummary', ], ], 'CreateConnectAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'EdgeLocation', 'TransportAttachmentId', 'Options', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'TransportAttachmentId' => [ 'shape' => 'AttachmentId', ], 'Options' => [ 'shape' => 'ConnectAttachmentOptions', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateConnectAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectAttachment' => [ 'shape' => 'ConnectAttachment', ], ], ], 'CreateConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectAttachmentId', 'PeerAddress', ], 'members' => [ 'ConnectAttachmentId' => [ 'shape' => 'AttachmentId', ], 'CoreNetworkAddress' => [ 'shape' => 'IPAddress', ], 'PeerAddress' => [ 'shape' => 'IPAddress', ], 'BgpOptions' => [ 'shape' => 'BgpOptions', ], 'InsideCidrBlocks' => [ 'shape' => 'ConstrainedStringList', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'SubnetArn' => [ 'shape' => 'SubnetArn', ], ], ], 'CreateConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeer' => [ 'shape' => 'ConnectPeer', ], ], ], 'CreateConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'DeviceId', 'ConnectedDeviceId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'ConnectedDeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'ConnectedLinkId' => [ 'shape' => 'LinkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'Connection', ], ], ], 'CreateCoreNetworkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Tags' => [ 'shape' => 'TagList', ], 'PolicyDocument' => [ 'shape' => 'CoreNetworkPolicyDocument', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateCoreNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetwork' => [ 'shape' => 'CoreNetwork', ], ], ], 'CreateDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'AWSLocation' => [ 'shape' => 'AWSLocation', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Type' => [ 'shape' => 'ConstrainedString', ], 'Vendor' => [ 'shape' => 'ConstrainedString', ], 'Model' => [ 'shape' => 'ConstrainedString', ], 'SerialNumber' => [ 'shape' => 'ConstrainedString', ], 'Location' => [ 'shape' => 'Location', ], 'SiteId' => [ 'shape' => 'SiteId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDeviceResponse' => [ 'type' => 'structure', 'members' => [ 'Device' => [ 'shape' => 'Device', ], ], ], 'CreateGlobalNetworkRequest' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'ConstrainedString', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateGlobalNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'GlobalNetwork' => [ 'shape' => 'GlobalNetwork', ], ], ], 'CreateLinkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'Bandwidth', 'SiteId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Type' => [ 'shape' => 'ConstrainedString', ], 'Bandwidth' => [ 'shape' => 'Bandwidth', ], 'Provider' => [ 'shape' => 'ConstrainedString', ], 'SiteId' => [ 'shape' => 'SiteId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLinkResponse' => [ 'type' => 'structure', 'members' => [ 'Link' => [ 'shape' => 'Link', ], ], ], 'CreateSiteRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Location' => [ 'shape' => 'Location', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateSiteResponse' => [ 'type' => 'structure', 'members' => [ 'Site' => [ 'shape' => 'Site', ], ], ], 'CreateSiteToSiteVpnAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'VpnConnectionArn', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'VpnConnectionArn' => [ 'shape' => 'VpnConnectionArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateSiteToSiteVpnAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'SiteToSiteVpnAttachment' => [ 'shape' => 'SiteToSiteVpnAttachment', ], ], ], 'CreateTransitGatewayPeeringRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'TransitGatewayArn', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'TransitGatewayArn' => [ 'shape' => 'TransitGatewayArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateTransitGatewayPeeringResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayPeering' => [ 'shape' => 'TransitGatewayPeering', ], ], ], 'CreateTransitGatewayRouteTableAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'PeeringId', 'TransitGatewayRouteTableArn', ], 'members' => [ 'PeeringId' => [ 'shape' => 'PeeringId', ], 'TransitGatewayRouteTableArn' => [ 'shape' => 'TransitGatewayRouteTableArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateTransitGatewayRouteTableAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayRouteTableAttachment' => [ 'shape' => 'TransitGatewayRouteTableAttachment', ], ], ], 'CreateVpcAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'VpcArn', 'SubnetArns', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'VpcArn' => [ 'shape' => 'VpcArn', ], 'SubnetArns' => [ 'shape' => 'SubnetArnList', ], 'Options' => [ 'shape' => 'VpcOptions', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateVpcAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'VpcAttachment' => [ 'shape' => 'VpcAttachment', ], ], ], 'CustomerGatewayArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'CustomerGatewayArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerGatewayArn', ], ], 'CustomerGatewayAssociation' => [ 'type' => 'structure', 'members' => [ 'CustomerGatewayArn' => [ 'shape' => 'CustomerGatewayArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'State' => [ 'shape' => 'CustomerGatewayAssociationState', ], ], ], 'CustomerGatewayAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerGatewayAssociation', ], ], 'CustomerGatewayAssociationState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'DELETED', ], ], 'DateTime' => [ 'type' => 'timestamp', ], 'DeleteAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'DeleteAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], ], ], 'DeleteConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectPeerId', ], 'members' => [ 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', 'location' => 'uri', 'locationName' => 'connectPeerId', ], ], ], 'DeleteConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeer' => [ 'shape' => 'ConnectPeer', ], ], ], 'DeleteConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'ConnectionId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'connectionId', ], ], ], 'DeleteConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'Connection', ], ], ], 'DeleteCoreNetworkPolicyVersionRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'PolicyVersionId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', 'location' => 'uri', 'locationName' => 'policyVersionId', ], ], ], 'DeleteCoreNetworkPolicyVersionResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkPolicy' => [ 'shape' => 'CoreNetworkPolicy', ], ], ], 'DeleteCoreNetworkRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], ], ], 'DeleteCoreNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetwork' => [ 'shape' => 'CoreNetwork', ], ], ], 'DeleteDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'DeviceId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', 'location' => 'uri', 'locationName' => 'deviceId', ], ], ], 'DeleteDeviceResponse' => [ 'type' => 'structure', 'members' => [ 'Device' => [ 'shape' => 'Device', ], ], ], 'DeleteGlobalNetworkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], ], ], 'DeleteGlobalNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'GlobalNetwork' => [ 'shape' => 'GlobalNetwork', ], ], ], 'DeleteLinkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'LinkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'LinkId' => [ 'shape' => 'LinkId', 'location' => 'uri', 'locationName' => 'linkId', ], ], ], 'DeleteLinkResponse' => [ 'type' => 'structure', 'members' => [ 'Link' => [ 'shape' => 'Link', ], ], ], 'DeletePeeringRequest' => [ 'type' => 'structure', 'required' => [ 'PeeringId', ], 'members' => [ 'PeeringId' => [ 'shape' => 'PeeringId', 'location' => 'uri', 'locationName' => 'peeringId', ], ], ], 'DeletePeeringResponse' => [ 'type' => 'structure', 'members' => [ 'Peering' => [ 'shape' => 'Peering', ], ], ], 'DeleteResourcePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'DeleteResourcePolicyResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteSiteRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'SiteId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'SiteId' => [ 'shape' => 'SiteId', 'location' => 'uri', 'locationName' => 'siteId', ], ], ], 'DeleteSiteResponse' => [ 'type' => 'structure', 'members' => [ 'Site' => [ 'shape' => 'Site', ], ], ], 'DeregisterTransitGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'TransitGatewayArn', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'TransitGatewayArn' => [ 'shape' => 'TransitGatewayArn', 'location' => 'uri', 'locationName' => 'transitGatewayArn', ], ], ], 'DeregisterTransitGatewayResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayRegistration' => [ 'shape' => 'TransitGatewayRegistration', ], ], ], 'DescribeGlobalNetworksRequest' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworkIds' => [ 'shape' => 'GlobalNetworkIdList', 'location' => 'querystring', 'locationName' => 'globalNetworkIds', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeGlobalNetworksResponse' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworks' => [ 'shape' => 'GlobalNetworkList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'Device' => [ 'type' => 'structure', 'members' => [ 'DeviceId' => [ 'shape' => 'DeviceId', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'AWSLocation' => [ 'shape' => 'AWSLocation', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Type' => [ 'shape' => 'ConstrainedString', ], 'Vendor' => [ 'shape' => 'ConstrainedString', ], 'Model' => [ 'shape' => 'ConstrainedString', ], 'SerialNumber' => [ 'shape' => 'ConstrainedString', ], 'Location' => [ 'shape' => 'Location', ], 'SiteId' => [ 'shape' => 'SiteId', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'State' => [ 'shape' => 'DeviceState', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'DeviceArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'DeviceId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'DeviceIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceId', ], ], 'DeviceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'DeviceState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'UPDATING', ], ], 'DisassociateConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'ConnectPeerId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', 'location' => 'uri', 'locationName' => 'connectPeerId', ], ], ], 'DisassociateConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeerAssociation' => [ 'shape' => 'ConnectPeerAssociation', ], ], ], 'DisassociateCustomerGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'CustomerGatewayArn', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'CustomerGatewayArn' => [ 'shape' => 'CustomerGatewayArn', 'location' => 'uri', 'locationName' => 'customerGatewayArn', ], ], ], 'DisassociateCustomerGatewayResponse' => [ 'type' => 'structure', 'members' => [ 'CustomerGatewayAssociation' => [ 'shape' => 'CustomerGatewayAssociation', ], ], ], 'DisassociateLinkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'DeviceId', 'LinkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', 'location' => 'querystring', 'locationName' => 'deviceId', ], 'LinkId' => [ 'shape' => 'LinkId', 'location' => 'querystring', 'locationName' => 'linkId', ], ], ], 'DisassociateLinkResponse' => [ 'type' => 'structure', 'members' => [ 'LinkAssociation' => [ 'shape' => 'LinkAssociation', ], ], ], 'DisassociateTransitGatewayConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'TransitGatewayConnectPeerArn', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'TransitGatewayConnectPeerArn' => [ 'shape' => 'TransitGatewayConnectPeerArn', 'location' => 'uri', 'locationName' => 'transitGatewayConnectPeerArn', ], ], ], 'DisassociateTransitGatewayConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayConnectPeerAssociation' => [ 'shape' => 'TransitGatewayConnectPeerAssociation', ], ], ], 'EdgeOverride' => [ 'type' => 'structure', 'members' => [ 'EdgeSets' => [ 'shape' => 'EdgeSetList', ], 'UseEdge' => [ 'shape' => 'ConstrainedString', ], ], ], 'EdgeSet' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConstrainedString', ], ], 'EdgeSetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeSet', ], ], 'ExceptionContextKey' => [ 'type' => 'string', ], 'ExceptionContextMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ExceptionContextKey', ], 'value' => [ 'shape' => 'ExceptionContextValue', ], ], 'ExceptionContextValue' => [ 'type' => 'string', ], 'ExecuteCoreNetworkChangeSetRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'PolicyVersionId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', 'location' => 'uri', 'locationName' => 'policyVersionId', ], ], ], 'ExecuteCoreNetworkChangeSetResponse' => [ 'type' => 'structure', 'members' => [], ], 'ExternalRegionCode' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[\\s\\S]*', ], 'ExternalRegionCodeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExternalRegionCode', ], ], 'FilterMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'FilterName', ], 'value' => [ 'shape' => 'FilterValues', ], ], 'FilterName' => [ 'type' => 'string', 'max' => 128, 'pattern' => '^[0-9a-zA-Z\\.-]*$', ], 'FilterValue' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[0-9a-zA-Z\\*\\.\\\\/\\?-]*$', ], 'FilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterValue', ], ], 'GetConnectAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'GetConnectAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectAttachment' => [ 'shape' => 'ConnectAttachment', ], ], ], 'GetConnectPeerAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ConnectPeerIds' => [ 'shape' => 'ConnectPeerIdList', 'location' => 'querystring', 'locationName' => 'connectPeerIds', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetConnectPeerAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeerAssociations' => [ 'shape' => 'ConnectPeerAssociationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectPeerId', ], 'members' => [ 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', 'location' => 'uri', 'locationName' => 'connectPeerId', ], ], ], 'GetConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeer' => [ 'shape' => 'ConnectPeer', ], ], ], 'GetConnectionsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ConnectionIds' => [ 'shape' => 'ConnectionIdList', 'location' => 'querystring', 'locationName' => 'connectionIds', ], 'DeviceId' => [ 'shape' => 'DeviceId', 'location' => 'querystring', 'locationName' => 'deviceId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'Connections' => [ 'shape' => 'ConnectionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetCoreNetworkChangeEventsRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'PolicyVersionId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', 'location' => 'uri', 'locationName' => 'policyVersionId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetCoreNetworkChangeEventsResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkChangeEvents' => [ 'shape' => 'CoreNetworkChangeEventList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetCoreNetworkChangeSetRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'PolicyVersionId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', 'location' => 'uri', 'locationName' => 'policyVersionId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetCoreNetworkChangeSetResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkChanges' => [ 'shape' => 'CoreNetworkChangeList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetCoreNetworkPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', 'location' => 'querystring', 'locationName' => 'policyVersionId', ], 'Alias' => [ 'shape' => 'CoreNetworkPolicyAlias', 'location' => 'querystring', 'locationName' => 'alias', ], ], ], 'GetCoreNetworkPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkPolicy' => [ 'shape' => 'CoreNetworkPolicy', ], ], ], 'GetCoreNetworkRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], ], ], 'GetCoreNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetwork' => [ 'shape' => 'CoreNetwork', ], ], ], 'GetCustomerGatewayAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'CustomerGatewayArns' => [ 'shape' => 'CustomerGatewayArnList', 'location' => 'querystring', 'locationName' => 'customerGatewayArns', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetCustomerGatewayAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'CustomerGatewayAssociations' => [ 'shape' => 'CustomerGatewayAssociationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceIds' => [ 'shape' => 'DeviceIdList', 'location' => 'querystring', 'locationName' => 'deviceIds', ], 'SiteId' => [ 'shape' => 'SiteId', 'location' => 'querystring', 'locationName' => 'siteId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetDevicesResponse' => [ 'type' => 'structure', 'members' => [ 'Devices' => [ 'shape' => 'DeviceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetLinkAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', 'location' => 'querystring', 'locationName' => 'deviceId', ], 'LinkId' => [ 'shape' => 'LinkId', 'location' => 'querystring', 'locationName' => 'linkId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetLinkAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'LinkAssociations' => [ 'shape' => 'LinkAssociationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetLinksRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'LinkIds' => [ 'shape' => 'LinkIdList', 'location' => 'querystring', 'locationName' => 'linkIds', ], 'SiteId' => [ 'shape' => 'SiteId', 'location' => 'querystring', 'locationName' => 'siteId', ], 'Type' => [ 'shape' => 'ConstrainedString', 'location' => 'querystring', 'locationName' => 'type', ], 'Provider' => [ 'shape' => 'ConstrainedString', 'location' => 'querystring', 'locationName' => 'provider', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetLinksResponse' => [ 'type' => 'structure', 'members' => [ 'Links' => [ 'shape' => 'LinkList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetNetworkResourceCountsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetNetworkResourceCountsResponse' => [ 'type' => 'structure', 'members' => [ 'NetworkResourceCounts' => [ 'shape' => 'NetworkResourceCountList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetNetworkResourceRelationshipsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'querystring', 'locationName' => 'coreNetworkId', ], 'RegisteredGatewayArn' => [ 'shape' => 'ResourceArn', 'location' => 'querystring', 'locationName' => 'registeredGatewayArn', ], 'AwsRegion' => [ 'shape' => 'ExternalRegionCode', 'location' => 'querystring', 'locationName' => 'awsRegion', ], 'AccountId' => [ 'shape' => 'AWSAccountId', 'location' => 'querystring', 'locationName' => 'accountId', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'querystring', 'locationName' => 'resourceArn', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetNetworkResourceRelationshipsResponse' => [ 'type' => 'structure', 'members' => [ 'Relationships' => [ 'shape' => 'RelationshipList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetNetworkResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'querystring', 'locationName' => 'coreNetworkId', ], 'RegisteredGatewayArn' => [ 'shape' => 'ResourceArn', 'location' => 'querystring', 'locationName' => 'registeredGatewayArn', ], 'AwsRegion' => [ 'shape' => 'ExternalRegionCode', 'location' => 'querystring', 'locationName' => 'awsRegion', ], 'AccountId' => [ 'shape' => 'AWSAccountId', 'location' => 'querystring', 'locationName' => 'accountId', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'querystring', 'locationName' => 'resourceArn', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetNetworkResourcesResponse' => [ 'type' => 'structure', 'members' => [ 'NetworkResources' => [ 'shape' => 'NetworkResourceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetNetworkRoutesRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'RouteTableIdentifier', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'RouteTableIdentifier' => [ 'shape' => 'RouteTableIdentifier', ], 'ExactCidrMatches' => [ 'shape' => 'ConstrainedStringList', ], 'LongestPrefixMatches' => [ 'shape' => 'ConstrainedStringList', ], 'SubnetOfMatches' => [ 'shape' => 'ConstrainedStringList', ], 'SupernetOfMatches' => [ 'shape' => 'ConstrainedStringList', ], 'PrefixListIds' => [ 'shape' => 'ConstrainedStringList', ], 'States' => [ 'shape' => 'RouteStateList', ], 'Types' => [ 'shape' => 'RouteTypeList', ], 'DestinationFilters' => [ 'shape' => 'FilterMap', ], ], ], 'GetNetworkRoutesResponse' => [ 'type' => 'structure', 'members' => [ 'RouteTableArn' => [ 'shape' => 'ResourceArn', ], 'CoreNetworkSegmentEdge' => [ 'shape' => 'CoreNetworkSegmentEdgeIdentifier', ], 'RouteTableType' => [ 'shape' => 'RouteTableType', ], 'RouteTableTimestamp' => [ 'shape' => 'DateTime', ], 'NetworkRoutes' => [ 'shape' => 'NetworkRouteList', ], ], ], 'GetNetworkTelemetryRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'querystring', 'locationName' => 'coreNetworkId', ], 'RegisteredGatewayArn' => [ 'shape' => 'ResourceArn', 'location' => 'querystring', 'locationName' => 'registeredGatewayArn', ], 'AwsRegion' => [ 'shape' => 'ExternalRegionCode', 'location' => 'querystring', 'locationName' => 'awsRegion', ], 'AccountId' => [ 'shape' => 'AWSAccountId', 'location' => 'querystring', 'locationName' => 'accountId', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'querystring', 'locationName' => 'resourceArn', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetNetworkTelemetryResponse' => [ 'type' => 'structure', 'members' => [ 'NetworkTelemetry' => [ 'shape' => 'NetworkTelemetryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetResourcePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'GetResourcePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'PolicyDocument' => [ 'shape' => 'ResourcePolicyDocument', 'jsonvalue' => true, ], ], ], 'GetRouteAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'RouteAnalysisId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'RouteAnalysisId' => [ 'shape' => 'ConstrainedString', 'location' => 'uri', 'locationName' => 'routeAnalysisId', ], ], ], 'GetRouteAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'RouteAnalysis' => [ 'shape' => 'RouteAnalysis', ], ], ], 'GetSiteToSiteVpnAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'GetSiteToSiteVpnAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'SiteToSiteVpnAttachment' => [ 'shape' => 'SiteToSiteVpnAttachment', ], ], ], 'GetSitesRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'SiteIds' => [ 'shape' => 'SiteIdList', 'location' => 'querystring', 'locationName' => 'siteIds', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetSitesResponse' => [ 'type' => 'structure', 'members' => [ 'Sites' => [ 'shape' => 'SiteList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetTransitGatewayConnectPeerAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'TransitGatewayConnectPeerArns' => [ 'shape' => 'TransitGatewayConnectPeerArnList', 'location' => 'querystring', 'locationName' => 'transitGatewayConnectPeerArns', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetTransitGatewayConnectPeerAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayConnectPeerAssociations' => [ 'shape' => 'TransitGatewayConnectPeerAssociationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetTransitGatewayPeeringRequest' => [ 'type' => 'structure', 'required' => [ 'PeeringId', ], 'members' => [ 'PeeringId' => [ 'shape' => 'PeeringId', 'location' => 'uri', 'locationName' => 'peeringId', ], ], ], 'GetTransitGatewayPeeringResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayPeering' => [ 'shape' => 'TransitGatewayPeering', ], ], ], 'GetTransitGatewayRegistrationsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'TransitGatewayArns' => [ 'shape' => 'TransitGatewayArnList', 'location' => 'querystring', 'locationName' => 'transitGatewayArns', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetTransitGatewayRegistrationsResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayRegistrations' => [ 'shape' => 'TransitGatewayRegistrationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetTransitGatewayRouteTableAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'GetTransitGatewayRouteTableAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayRouteTableAttachment' => [ 'shape' => 'TransitGatewayRouteTableAttachment', ], ], ], 'GetVpcAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'GetVpcAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'VpcAttachment' => [ 'shape' => 'VpcAttachment', ], ], ], 'GlobalNetwork' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'GlobalNetworkArn' => [ 'shape' => 'GlobalNetworkArn', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'State' => [ 'shape' => 'GlobalNetworkState', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'GlobalNetworkArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'GlobalNetworkId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'GlobalNetworkIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalNetworkId', ], ], 'GlobalNetworkList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalNetwork', ], ], 'GlobalNetworkState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'UPDATING', ], ], 'IPAddress' => [ 'type' => 'string', 'max' => 50, 'min' => 1, 'pattern' => '[\\s\\S]*', ], 'Integer' => [ 'type' => 'integer', ], 'InternalServerException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'RetryAfterSeconds' => [ 'shape' => 'RetryAfterSeconds', 'location' => 'header', 'locationName' => 'Retry-After', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'Link' => [ 'type' => 'structure', 'members' => [ 'LinkId' => [ 'shape' => 'LinkId', ], 'LinkArn' => [ 'shape' => 'LinkArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'SiteId' => [ 'shape' => 'SiteId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Type' => [ 'shape' => 'ConstrainedString', ], 'Bandwidth' => [ 'shape' => 'Bandwidth', ], 'Provider' => [ 'shape' => 'ConstrainedString', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'State' => [ 'shape' => 'LinkState', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'LinkArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'LinkAssociation' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'LinkAssociationState' => [ 'shape' => 'LinkAssociationState', ], ], ], 'LinkAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LinkAssociation', ], ], 'LinkAssociationState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'DELETED', ], ], 'LinkId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'LinkIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LinkId', ], ], 'LinkList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Link', ], ], 'LinkState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'UPDATING', ], ], 'ListAttachmentsRequest' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'querystring', 'locationName' => 'coreNetworkId', ], 'AttachmentType' => [ 'shape' => 'AttachmentType', 'location' => 'querystring', 'locationName' => 'attachmentType', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', 'location' => 'querystring', 'locationName' => 'edgeLocation', ], 'State' => [ 'shape' => 'AttachmentState', 'location' => 'querystring', 'locationName' => 'state', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListAttachmentsResponse' => [ 'type' => 'structure', 'members' => [ 'Attachments' => [ 'shape' => 'AttachmentList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListConnectPeersRequest' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'querystring', 'locationName' => 'coreNetworkId', ], 'ConnectAttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'querystring', 'locationName' => 'connectAttachmentId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListConnectPeersResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeers' => [ 'shape' => 'ConnectPeerSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCoreNetworkPolicyVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListCoreNetworkPolicyVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkPolicyVersions' => [ 'shape' => 'CoreNetworkPolicyVersionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCoreNetworksRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListCoreNetworksResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworks' => [ 'shape' => 'CoreNetworkSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListOrganizationServiceAccessStatusRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListOrganizationServiceAccessStatusResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationStatus' => [ 'shape' => 'OrganizationStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPeeringsRequest' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'querystring', 'locationName' => 'coreNetworkId', ], 'PeeringType' => [ 'shape' => 'PeeringType', 'location' => 'querystring', 'locationName' => 'peeringType', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', 'location' => 'querystring', 'locationName' => 'edgeLocation', ], 'State' => [ 'shape' => 'PeeringState', 'location' => 'querystring', 'locationName' => 'state', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListPeeringsResponse' => [ 'type' => 'structure', 'members' => [ 'Peerings' => [ 'shape' => 'PeeringList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'Location' => [ 'type' => 'structure', 'members' => [ 'Address' => [ 'shape' => 'ConstrainedString', ], 'Latitude' => [ 'shape' => 'ConstrainedString', ], 'Longitude' => [ 'shape' => 'ConstrainedString', ], ], 'sensitive' => true, ], 'Long' => [ 'type' => 'long', ], 'MaxResults' => [ 'type' => 'integer', 'max' => 500, 'min' => 1, ], 'NetworkFunctionGroup' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ConstrainedString', ], ], ], 'NetworkFunctionGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkFunctionGroup', ], ], 'NetworkFunctionGroupName' => [ 'type' => 'string', 'pattern' => '[\\s\\S]*', ], 'NetworkResource' => [ 'type' => 'structure', 'members' => [ 'RegisteredGatewayArn' => [ 'shape' => 'ResourceArn', ], 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'AwsRegion' => [ 'shape' => 'ExternalRegionCode', ], 'AccountId' => [ 'shape' => 'AWSAccountId', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', ], 'ResourceId' => [ 'shape' => 'ConstrainedString', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Definition' => [ 'shape' => 'ConstrainedString', ], 'DefinitionTimestamp' => [ 'shape' => 'DateTime', ], 'Tags' => [ 'shape' => 'TagList', ], 'Metadata' => [ 'shape' => 'NetworkResourceMetadataMap', ], ], ], 'NetworkResourceCount' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'ConstrainedString', ], 'Count' => [ 'shape' => 'Integer', ], ], ], 'NetworkResourceCountList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkResourceCount', ], ], 'NetworkResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkResource', ], ], 'NetworkResourceMetadataMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConstrainedString', ], 'value' => [ 'shape' => 'ConstrainedString', ], ], 'NetworkResourceSummary' => [ 'type' => 'structure', 'members' => [ 'RegisteredGatewayArn' => [ 'shape' => 'ResourceArn', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', ], 'Definition' => [ 'shape' => 'ConstrainedString', ], 'NameTag' => [ 'shape' => 'ConstrainedString', ], 'IsMiddlebox' => [ 'shape' => 'Boolean', ], ], ], 'NetworkRoute' => [ 'type' => 'structure', 'members' => [ 'DestinationCidrBlock' => [ 'shape' => 'ConstrainedString', ], 'Destinations' => [ 'shape' => 'NetworkRouteDestinationList', ], 'PrefixListId' => [ 'shape' => 'ConstrainedString', ], 'State' => [ 'shape' => 'RouteState', ], 'Type' => [ 'shape' => 'RouteType', ], ], ], 'NetworkRouteDestination' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkAttachmentId' => [ 'shape' => 'AttachmentId', ], 'TransitGatewayAttachmentId' => [ 'shape' => 'TransitGatewayAttachmentId', ], 'SegmentName' => [ 'shape' => 'ConstrainedString', ], 'NetworkFunctionGroupName' => [ 'shape' => 'ConstrainedString', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', ], 'ResourceId' => [ 'shape' => 'ConstrainedString', ], ], ], 'NetworkRouteDestinationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkRouteDestination', ], ], 'NetworkRouteList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkRoute', ], ], 'NetworkTelemetry' => [ 'type' => 'structure', 'members' => [ 'RegisteredGatewayArn' => [ 'shape' => 'ResourceArn', ], 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'AwsRegion' => [ 'shape' => 'ExternalRegionCode', ], 'AccountId' => [ 'shape' => 'AWSAccountId', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', ], 'ResourceId' => [ 'shape' => 'ConstrainedString', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Address' => [ 'shape' => 'ConstrainedString', ], 'Health' => [ 'shape' => 'ConnectionHealth', ], ], ], 'NetworkTelemetryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkTelemetry', ], ], 'NextToken' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'OrganizationAwsServiceAccessStatus' => [ 'type' => 'string', 'max' => 50, 'min' => 0, ], 'OrganizationId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '^o-([0-9a-f]{8,17})$', ], 'OrganizationStatus' => [ 'type' => 'structure', 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'OrganizationAwsServiceAccessStatus' => [ 'shape' => 'OrganizationAwsServiceAccessStatus', ], 'SLRDeploymentStatus' => [ 'shape' => 'SLRDeploymentStatus', ], 'AccountStatusList' => [ 'shape' => 'AccountStatusList', ], ], ], 'PathComponent' => [ 'type' => 'structure', 'members' => [ 'Sequence' => [ 'shape' => 'Integer', ], 'Resource' => [ 'shape' => 'NetworkResourceSummary', ], 'DestinationCidrBlock' => [ 'shape' => 'ConstrainedString', ], ], ], 'PathComponentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PathComponent', ], ], 'Peering' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'CoreNetworkArn' => [ 'shape' => 'CoreNetworkArn', ], 'PeeringId' => [ 'shape' => 'PeeringId', ], 'OwnerAccountId' => [ 'shape' => 'AWSAccountId', ], 'PeeringType' => [ 'shape' => 'PeeringType', ], 'State' => [ 'shape' => 'PeeringState', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'LastModificationErrors' => [ 'shape' => 'PeeringErrorList', ], ], ], 'PeeringError' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'PeeringErrorCode', ], 'Message' => [ 'shape' => 'ServerSideString', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'RequestId' => [ 'shape' => 'ServerSideString', ], 'MissingPermissionsContext' => [ 'shape' => 'PermissionsErrorContext', ], ], ], 'PeeringErrorCode' => [ 'type' => 'string', 'enum' => [ 'TRANSIT_GATEWAY_NOT_FOUND', 'TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED', 'MISSING_PERMISSIONS', 'INTERNAL_ERROR', 'EDGE_LOCATION_PEER_DUPLICATE', 'INVALID_TRANSIT_GATEWAY_STATE', ], ], 'PeeringErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PeeringError', ], 'max' => 20, 'min' => 0, ], 'PeeringId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '^peering-([0-9a-f]{8,17})$', ], 'PeeringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Peering', ], ], 'PeeringState' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'FAILED', 'AVAILABLE', 'DELETING', ], ], 'PeeringType' => [ 'type' => 'string', 'enum' => [ 'TRANSIT_GATEWAY', ], ], 'PermissionsErrorContext' => [ 'type' => 'structure', 'members' => [ 'MissingPermission' => [ 'shape' => 'ServerSideString', ], ], ], 'ProposedNetworkFunctionGroupChange' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'AttachmentPolicyRuleNumber' => [ 'shape' => 'Integer', ], 'NetworkFunctionGroupName' => [ 'shape' => 'ConstrainedString', ], ], ], 'ProposedSegmentChange' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'AttachmentPolicyRuleNumber' => [ 'shape' => 'Integer', ], 'SegmentName' => [ 'shape' => 'ConstrainedString', ], ], ], 'PutCoreNetworkPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'PolicyDocument', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyDocument' => [ 'shape' => 'CoreNetworkPolicyDocument', 'jsonvalue' => true, ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'LatestVersionId' => [ 'shape' => 'Integer', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'PutCoreNetworkPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkPolicy' => [ 'shape' => 'CoreNetworkPolicy', ], ], ], 'PutResourcePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyDocument', 'ResourceArn', ], 'members' => [ 'PolicyDocument' => [ 'shape' => 'ResourcePolicyDocument', 'jsonvalue' => true, ], 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'PutResourcePolicyResponse' => [ 'type' => 'structure', 'members' => [], ], 'ReasonContextKey' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ReasonContextMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ReasonContextKey', ], 'value' => [ 'shape' => 'ReasonContextValue', ], ], 'ReasonContextValue' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'RegisterTransitGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'TransitGatewayArn', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'TransitGatewayArn' => [ 'shape' => 'TransitGatewayArn', ], ], ], 'RegisterTransitGatewayResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayRegistration' => [ 'shape' => 'TransitGatewayRegistration', ], ], ], 'RejectAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'RejectAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], ], ], 'Relationship' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'ConstrainedString', ], 'To' => [ 'shape' => 'ConstrainedString', ], ], ], 'RelationshipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Relationship', ], ], 'ResourceArn' => [ 'type' => 'string', 'max' => 1500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'required' => [ 'Message', 'ResourceId', 'ResourceType', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'ResourceId' => [ 'shape' => 'ServerSideString', ], 'ResourceType' => [ 'shape' => 'ServerSideString', ], 'Context' => [ 'shape' => 'ExceptionContextMap', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'ResourcePolicyDocument' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'RestoreCoreNetworkPolicyVersionRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'PolicyVersionId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', 'location' => 'uri', 'locationName' => 'policyVersionId', ], ], ], 'RestoreCoreNetworkPolicyVersionResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkPolicy' => [ 'shape' => 'CoreNetworkPolicy', ], ], ], 'RetryAfterSeconds' => [ 'type' => 'integer', ], 'RouteAnalysis' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'OwnerAccountId' => [ 'shape' => 'AWSAccountId', ], 'RouteAnalysisId' => [ 'shape' => 'ConstrainedString', ], 'StartTimestamp' => [ 'shape' => 'DateTime', ], 'Status' => [ 'shape' => 'RouteAnalysisStatus', ], 'Source' => [ 'shape' => 'RouteAnalysisEndpointOptions', ], 'Destination' => [ 'shape' => 'RouteAnalysisEndpointOptions', ], 'IncludeReturnPath' => [ 'shape' => 'Boolean', ], 'UseMiddleboxes' => [ 'shape' => 'Boolean', ], 'ForwardPath' => [ 'shape' => 'RouteAnalysisPath', ], 'ReturnPath' => [ 'shape' => 'RouteAnalysisPath', ], ], ], 'RouteAnalysisCompletion' => [ 'type' => 'structure', 'members' => [ 'ResultCode' => [ 'shape' => 'RouteAnalysisCompletionResultCode', ], 'ReasonCode' => [ 'shape' => 'RouteAnalysisCompletionReasonCode', ], 'ReasonContext' => [ 'shape' => 'ReasonContextMap', ], ], ], 'RouteAnalysisCompletionReasonCode' => [ 'type' => 'string', 'enum' => [ 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND', 'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY', 'CYCLIC_PATH_DETECTED', 'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND', 'ROUTE_NOT_FOUND', 'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND', 'INACTIVE_ROUTE_FOR_DESTINATION_FOUND', 'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH', 'MAX_HOPS_EXCEEDED', 'POSSIBLE_MIDDLEBOX', 'NO_DESTINATION_ARN_PROVIDED', ], ], 'RouteAnalysisCompletionResultCode' => [ 'type' => 'string', 'enum' => [ 'CONNECTED', 'NOT_CONNECTED', ], ], 'RouteAnalysisEndpointOptions' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayAttachmentArn' => [ 'shape' => 'TransitGatewayAttachmentArn', ], 'TransitGatewayArn' => [ 'shape' => 'TransitGatewayArn', ], 'IpAddress' => [ 'shape' => 'IPAddress', ], ], ], 'RouteAnalysisEndpointOptionsSpecification' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayAttachmentArn' => [ 'shape' => 'TransitGatewayAttachmentArn', ], 'IpAddress' => [ 'shape' => 'IPAddress', ], ], ], 'RouteAnalysisPath' => [ 'type' => 'structure', 'members' => [ 'CompletionStatus' => [ 'shape' => 'RouteAnalysisCompletion', ], 'Path' => [ 'shape' => 'PathComponentList', ], ], ], 'RouteAnalysisStatus' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'COMPLETED', 'FAILED', ], ], 'RouteState' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'BLACKHOLE', ], ], 'RouteStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RouteState', ], ], 'RouteTableIdentifier' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayRouteTableArn' => [ 'shape' => 'TransitGatewayRouteTableArn', ], 'CoreNetworkSegmentEdge' => [ 'shape' => 'CoreNetworkSegmentEdgeIdentifier', ], 'CoreNetworkNetworkFunctionGroup' => [ 'shape' => 'CoreNetworkNetworkFunctionGroupIdentifier', ], ], ], 'RouteTableType' => [ 'type' => 'string', 'enum' => [ 'TRANSIT_GATEWAY_ROUTE_TABLE', 'CORE_NETWORK_SEGMENT', 'NETWORK_FUNCTION_GROUP', ], ], 'RouteType' => [ 'type' => 'string', 'enum' => [ 'PROPAGATED', 'STATIC', ], ], 'RouteTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RouteType', ], ], 'SLRDeploymentStatus' => [ 'type' => 'string', 'max' => 50, 'min' => 0, ], 'SegmentActionServiceInsertion' => [ 'type' => 'string', 'enum' => [ 'send-via', 'send-to', ], ], 'SendViaMode' => [ 'type' => 'string', 'enum' => [ 'dual-hop', 'single-hop', ], ], 'ServerSideString' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ServiceInsertionAction' => [ 'type' => 'structure', 'members' => [ 'Action' => [ 'shape' => 'SegmentActionServiceInsertion', ], 'Mode' => [ 'shape' => 'SendViaMode', ], 'WhenSentTo' => [ 'shape' => 'WhenSentTo', ], 'Via' => [ 'shape' => 'Via', ], ], ], 'ServiceInsertionActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceInsertionAction', ], ], 'ServiceInsertionSegments' => [ 'type' => 'structure', 'members' => [ 'SendVia' => [ 'shape' => 'ConstrainedStringList', ], 'SendTo' => [ 'shape' => 'ConstrainedStringList', ], ], ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'required' => [ 'Message', 'LimitCode', 'ServiceCode', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'ResourceId' => [ 'shape' => 'ServerSideString', ], 'ResourceType' => [ 'shape' => 'ServerSideString', ], 'LimitCode' => [ 'shape' => 'ServerSideString', ], 'ServiceCode' => [ 'shape' => 'ServerSideString', ], ], 'error' => [ 'httpStatusCode' => 402, ], 'exception' => true, ], 'Site' => [ 'type' => 'structure', 'members' => [ 'SiteId' => [ 'shape' => 'SiteId', ], 'SiteArn' => [ 'shape' => 'SiteArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Location' => [ 'shape' => 'Location', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'State' => [ 'shape' => 'SiteState', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'SiteArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'SiteId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'SiteIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SiteId', ], ], 'SiteList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Site', ], ], 'SiteState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'UPDATING', ], ], 'SiteToSiteVpnAttachment' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], 'VpnConnectionArn' => [ 'shape' => 'VpnConnectionArn', ], ], ], 'StartOrganizationServiceAccessUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'Action', ], 'members' => [ 'Action' => [ 'shape' => 'Action', ], ], ], 'StartOrganizationServiceAccessUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationStatus' => [ 'shape' => 'OrganizationStatus', ], ], ], 'StartRouteAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'Source', 'Destination', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'Source' => [ 'shape' => 'RouteAnalysisEndpointOptionsSpecification', ], 'Destination' => [ 'shape' => 'RouteAnalysisEndpointOptionsSpecification', ], 'IncludeReturnPath' => [ 'shape' => 'Boolean', ], 'UseMiddleboxes' => [ 'shape' => 'Boolean', ], ], ], 'StartRouteAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'RouteAnalysis' => [ 'shape' => 'RouteAnalysis', ], ], ], 'SubnetArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:subnet\\/subnet-[0-9a-f]{8,17}$|^$', ], 'SubnetArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetArn', ], ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ThrottlingException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'RetryAfterSeconds' => [ 'shape' => 'RetryAfterSeconds', 'location' => 'header', 'locationName' => 'Retry-After', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'TransitGatewayArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'TransitGatewayArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransitGatewayArn', ], ], 'TransitGatewayAttachmentArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'TransitGatewayAttachmentId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'TransitGatewayConnectPeerArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'TransitGatewayConnectPeerArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransitGatewayConnectPeerArn', ], ], 'TransitGatewayConnectPeerAssociation' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayConnectPeerArn' => [ 'shape' => 'TransitGatewayConnectPeerArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'State' => [ 'shape' => 'TransitGatewayConnectPeerAssociationState', ], ], ], 'TransitGatewayConnectPeerAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransitGatewayConnectPeerAssociation', ], ], 'TransitGatewayConnectPeerAssociationState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'DELETED', ], ], 'TransitGatewayPeering' => [ 'type' => 'structure', 'members' => [ 'Peering' => [ 'shape' => 'Peering', ], 'TransitGatewayArn' => [ 'shape' => 'TransitGatewayArn', ], 'TransitGatewayPeeringAttachmentId' => [ 'shape' => 'TransitGatewayPeeringAttachmentId', ], ], ], 'TransitGatewayPeeringAttachmentId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '^tgw-attach-([0-9a-f]{8,17})$', ], 'TransitGatewayRegistration' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'TransitGatewayArn' => [ 'shape' => 'TransitGatewayArn', ], 'State' => [ 'shape' => 'TransitGatewayRegistrationStateReason', ], ], ], 'TransitGatewayRegistrationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransitGatewayRegistration', ], ], 'TransitGatewayRegistrationState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'DELETED', 'FAILED', ], ], 'TransitGatewayRegistrationStateReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'TransitGatewayRegistrationState', ], 'Message' => [ 'shape' => 'ConstrainedString', ], ], ], 'TransitGatewayRouteTableArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'TransitGatewayRouteTableAttachment' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], 'PeeringId' => [ 'shape' => 'PeeringId', ], 'TransitGatewayRouteTableArn' => [ 'shape' => 'TransitGatewayRouteTableArn', ], ], ], 'TunnelProtocol' => [ 'type' => 'string', 'enum' => [ 'GRE', 'NO_ENCAP', ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'ConnectionId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'connectionId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'ConnectedLinkId' => [ 'shape' => 'LinkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], ], ], 'UpdateConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'Connection', ], ], ], 'UpdateCoreNetworkRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], ], ], 'UpdateCoreNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetwork' => [ 'shape' => 'CoreNetwork', ], ], ], 'UpdateDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'DeviceId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', 'location' => 'uri', 'locationName' => 'deviceId', ], 'AWSLocation' => [ 'shape' => 'AWSLocation', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Type' => [ 'shape' => 'ConstrainedString', ], 'Vendor' => [ 'shape' => 'ConstrainedString', ], 'Model' => [ 'shape' => 'ConstrainedString', ], 'SerialNumber' => [ 'shape' => 'ConstrainedString', ], 'Location' => [ 'shape' => 'Location', ], 'SiteId' => [ 'shape' => 'SiteId', ], ], ], 'UpdateDeviceResponse' => [ 'type' => 'structure', 'members' => [ 'Device' => [ 'shape' => 'Device', ], ], ], 'UpdateGlobalNetworkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], ], ], 'UpdateGlobalNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'GlobalNetwork' => [ 'shape' => 'GlobalNetwork', ], ], ], 'UpdateLinkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'LinkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'LinkId' => [ 'shape' => 'LinkId', 'location' => 'uri', 'locationName' => 'linkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Type' => [ 'shape' => 'ConstrainedString', ], 'Bandwidth' => [ 'shape' => 'Bandwidth', ], 'Provider' => [ 'shape' => 'ConstrainedString', ], ], ], 'UpdateLinkResponse' => [ 'type' => 'structure', 'members' => [ 'Link' => [ 'shape' => 'Link', ], ], ], 'UpdateNetworkResourceMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'ResourceArn', 'Metadata', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'Metadata' => [ 'shape' => 'NetworkResourceMetadataMap', ], ], ], 'UpdateNetworkResourceMetadataResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Metadata' => [ 'shape' => 'NetworkResourceMetadataMap', ], ], ], 'UpdateSiteRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'SiteId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'SiteId' => [ 'shape' => 'SiteId', 'location' => 'uri', 'locationName' => 'siteId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Location' => [ 'shape' => 'Location', ], ], ], 'UpdateSiteResponse' => [ 'type' => 'structure', 'members' => [ 'Site' => [ 'shape' => 'Site', ], ], ], 'UpdateVpcAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], 'AddSubnetArns' => [ 'shape' => 'SubnetArnList', ], 'RemoveSubnetArns' => [ 'shape' => 'SubnetArnList', ], 'Options' => [ 'shape' => 'VpcOptions', ], ], ], 'UpdateVpcAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'VpcAttachment' => [ 'shape' => 'VpcAttachment', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'Reason' => [ 'shape' => 'ValidationExceptionReason', ], 'Fields' => [ 'shape' => 'ValidationExceptionFieldList', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'ValidationExceptionField' => [ 'type' => 'structure', 'required' => [ 'Name', 'Message', ], 'members' => [ 'Name' => [ 'shape' => 'ServerSideString', ], 'Message' => [ 'shape' => 'ServerSideString', ], ], ], 'ValidationExceptionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationExceptionField', ], ], 'ValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'UnknownOperation', 'CannotParse', 'FieldValidationFailed', 'Other', ], ], 'Via' => [ 'type' => 'structure', 'members' => [ 'NetworkFunctionGroups' => [ 'shape' => 'NetworkFunctionGroupList', ], 'WithEdgeOverrides' => [ 'shape' => 'WithEdgeOverridesList', ], ], ], 'VpcArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:vpc\\/vpc-[0-9a-f]{8,17}$', ], 'VpcAttachment' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], 'SubnetArns' => [ 'shape' => 'SubnetArnList', ], 'Options' => [ 'shape' => 'VpcOptions', ], ], ], 'VpcOptions' => [ 'type' => 'structure', 'members' => [ 'Ipv6Support' => [ 'shape' => 'Boolean', ], 'ApplianceModeSupport' => [ 'shape' => 'Boolean', ], ], ], 'VpnConnectionArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:vpn-connection\\/vpn-[0-9a-f]{8,17}$', ], 'WhenSentTo' => [ 'type' => 'structure', 'members' => [ 'WhenSentToSegmentsList' => [ 'shape' => 'WhenSentToSegmentsList', ], ], ], 'WhenSentToSegmentsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConstrainedString', ], ], 'WithEdgeOverridesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeOverride', ], ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2019-07-05', 'endpointPrefix' => 'networkmanager', 'jsonVersion' => '1.1', 'protocol' => 'rest-json', 'protocols' => [ 'rest-json', ], 'serviceAbbreviation' => 'NetworkManager', 'serviceFullName' => 'AWS Network Manager', 'serviceId' => 'NetworkManager', 'signatureVersion' => 'v4', 'signingName' => 'networkmanager', 'uid' => 'networkmanager-2019-07-05', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'AcceptAttachment' => [ 'name' => 'AcceptAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/attachments/{attachmentId}/accept', ], 'input' => [ 'shape' => 'AcceptAttachmentRequest', ], 'output' => [ 'shape' => 'AcceptAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'AssociateConnectPeer' => [ 'name' => 'AssociateConnectPeer', 'http' => [ 'method' => 'POST', 'requestUri' => '/global-networks/{globalNetworkId}/connect-peer-associations', ], 'input' => [ 'shape' => 'AssociateConnectPeerRequest', ], 'output' => [ 'shape' => 'AssociateConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], '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', ], ], ], 'AssociateTransitGatewayConnectPeer' => [ 'name' => 'AssociateTransitGatewayConnectPeer', 'http' => [ 'method' => 'POST', 'requestUri' => '/global-networks/{globalNetworkId}/transit-gateway-connect-peer-associations', ], 'input' => [ 'shape' => 'AssociateTransitGatewayConnectPeerRequest', ], 'output' => [ 'shape' => 'AssociateTransitGatewayConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateConnectAttachment' => [ 'name' => 'CreateConnectAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/connect-attachments', ], 'input' => [ 'shape' => 'CreateConnectAttachmentRequest', ], 'output' => [ 'shape' => 'CreateConnectAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateConnectPeer' => [ 'name' => 'CreateConnectPeer', 'http' => [ 'method' => 'POST', 'requestUri' => '/connect-peers', ], 'input' => [ 'shape' => 'CreateConnectPeerRequest', ], 'output' => [ 'shape' => 'CreateConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateConnection' => [ 'name' => 'CreateConnection', 'http' => [ 'method' => 'POST', 'requestUri' => '/global-networks/{globalNetworkId}/connections', ], 'input' => [ 'shape' => 'CreateConnectionRequest', ], 'output' => [ 'shape' => 'CreateConnectionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateCoreNetwork' => [ 'name' => 'CreateCoreNetwork', 'http' => [ 'method' => 'POST', 'requestUri' => '/core-networks', ], 'input' => [ 'shape' => 'CreateCoreNetworkRequest', ], 'output' => [ 'shape' => 'CreateCoreNetworkResponse', ], 'errors' => [ [ 'shape' => 'CoreNetworkPolicyException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'CreateDirectConnectGatewayAttachment' => [ 'name' => 'CreateDirectConnectGatewayAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/direct-connect-gateway-attachments', ], 'input' => [ 'shape' => 'CreateDirectConnectGatewayAttachmentRequest', ], 'output' => [ 'shape' => 'CreateDirectConnectGatewayAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], 'CreateSiteToSiteVpnAttachment' => [ 'name' => 'CreateSiteToSiteVpnAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/site-to-site-vpn-attachments', ], 'input' => [ 'shape' => 'CreateSiteToSiteVpnAttachmentRequest', ], 'output' => [ 'shape' => 'CreateSiteToSiteVpnAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateTransitGatewayPeering' => [ 'name' => 'CreateTransitGatewayPeering', 'http' => [ 'method' => 'POST', 'requestUri' => '/transit-gateway-peerings', ], 'input' => [ 'shape' => 'CreateTransitGatewayPeeringRequest', ], 'output' => [ 'shape' => 'CreateTransitGatewayPeeringResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateTransitGatewayRouteTableAttachment' => [ 'name' => 'CreateTransitGatewayRouteTableAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/transit-gateway-route-table-attachments', ], 'input' => [ 'shape' => 'CreateTransitGatewayRouteTableAttachmentRequest', ], 'output' => [ 'shape' => 'CreateTransitGatewayRouteTableAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'CreateVpcAttachment' => [ 'name' => 'CreateVpcAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/vpc-attachments', ], 'input' => [ 'shape' => 'CreateVpcAttachmentRequest', ], 'output' => [ 'shape' => 'CreateVpcAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteAttachment' => [ 'name' => 'DeleteAttachment', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/attachments/{attachmentId}', ], 'input' => [ 'shape' => 'DeleteAttachmentRequest', ], 'output' => [ 'shape' => 'DeleteAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteConnectPeer' => [ 'name' => 'DeleteConnectPeer', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/connect-peers/{connectPeerId}', ], 'input' => [ 'shape' => 'DeleteConnectPeerRequest', ], 'output' => [ 'shape' => 'DeleteConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteConnection' => [ 'name' => 'DeleteConnection', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/global-networks/{globalNetworkId}/connections/{connectionId}', ], 'input' => [ 'shape' => 'DeleteConnectionRequest', ], 'output' => [ 'shape' => 'DeleteConnectionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteCoreNetwork' => [ 'name' => 'DeleteCoreNetwork', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/core-networks/{coreNetworkId}', ], 'input' => [ 'shape' => 'DeleteCoreNetworkRequest', ], 'output' => [ 'shape' => 'DeleteCoreNetworkResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteCoreNetworkPolicyVersion' => [ 'name' => 'DeleteCoreNetworkPolicyVersion', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-policy-versions/{policyVersionId}', ], 'input' => [ 'shape' => 'DeleteCoreNetworkPolicyVersionRequest', ], 'output' => [ 'shape' => 'DeleteCoreNetworkPolicyVersionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], 'DeletePeering' => [ 'name' => 'DeletePeering', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/peerings/{peeringId}', ], 'input' => [ 'shape' => 'DeletePeeringRequest', ], 'output' => [ 'shape' => 'DeletePeeringResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DeleteResourcePolicy' => [ 'name' => 'DeleteResourcePolicy', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/resource-policy/{resourceArn}', ], 'input' => [ 'shape' => 'DeleteResourcePolicyRequest', ], 'output' => [ 'shape' => 'DeleteResourcePolicyResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], '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', ], ], ], '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', ], ], ], 'DisassociateConnectPeer' => [ 'name' => 'DisassociateConnectPeer', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/global-networks/{globalNetworkId}/connect-peer-associations/{connectPeerId}', ], 'input' => [ 'shape' => 'DisassociateConnectPeerRequest', ], 'output' => [ 'shape' => 'DisassociateConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'DisassociateCustomerGateway' => [ 'name' => 'DisassociateCustomerGateway', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/global-networks/{globalNetworkId}/customer-gateway-associations/{customerGatewayArn}', ], 'input' => [ 'shape' => 'DisassociateCustomerGatewayRequest', ], 'output' => [ 'shape' => 'DisassociateCustomerGatewayResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'DisassociateTransitGatewayConnectPeer' => [ 'name' => 'DisassociateTransitGatewayConnectPeer', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/global-networks/{globalNetworkId}/transit-gateway-connect-peer-associations/{transitGatewayConnectPeerArn}', ], 'input' => [ 'shape' => 'DisassociateTransitGatewayConnectPeerRequest', ], 'output' => [ 'shape' => 'DisassociateTransitGatewayConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ExecuteCoreNetworkChangeSet' => [ 'name' => 'ExecuteCoreNetworkChangeSet', 'http' => [ 'method' => 'POST', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-change-sets/{policyVersionId}/execute', ], 'input' => [ 'shape' => 'ExecuteCoreNetworkChangeSetRequest', ], 'output' => [ 'shape' => 'ExecuteCoreNetworkChangeSetResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], ], ], 'GetConnectAttachment' => [ 'name' => 'GetConnectAttachment', 'http' => [ 'method' => 'GET', 'requestUri' => '/connect-attachments/{attachmentId}', ], 'input' => [ 'shape' => 'GetConnectAttachmentRequest', ], 'output' => [ 'shape' => 'GetConnectAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetConnectPeer' => [ 'name' => 'GetConnectPeer', 'http' => [ 'method' => 'GET', 'requestUri' => '/connect-peers/{connectPeerId}', ], 'input' => [ 'shape' => 'GetConnectPeerRequest', ], 'output' => [ 'shape' => 'GetConnectPeerResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetConnectPeerAssociations' => [ 'name' => 'GetConnectPeerAssociations', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/connect-peer-associations', ], 'input' => [ 'shape' => 'GetConnectPeerAssociationsRequest', ], 'output' => [ 'shape' => 'GetConnectPeerAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetConnections' => [ 'name' => 'GetConnections', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/connections', ], 'input' => [ 'shape' => 'GetConnectionsRequest', ], 'output' => [ 'shape' => 'GetConnectionsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetCoreNetwork' => [ 'name' => 'GetCoreNetwork', 'http' => [ 'method' => 'GET', 'requestUri' => '/core-networks/{coreNetworkId}', ], 'input' => [ 'shape' => 'GetCoreNetworkRequest', ], 'output' => [ 'shape' => 'GetCoreNetworkResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetCoreNetworkChangeEvents' => [ 'name' => 'GetCoreNetworkChangeEvents', 'http' => [ 'method' => 'GET', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-change-events/{policyVersionId}', ], 'input' => [ 'shape' => 'GetCoreNetworkChangeEventsRequest', ], 'output' => [ 'shape' => 'GetCoreNetworkChangeEventsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetCoreNetworkChangeSet' => [ 'name' => 'GetCoreNetworkChangeSet', 'http' => [ 'method' => 'GET', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-change-sets/{policyVersionId}', ], 'input' => [ 'shape' => 'GetCoreNetworkChangeSetRequest', ], 'output' => [ 'shape' => 'GetCoreNetworkChangeSetResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetCoreNetworkPolicy' => [ 'name' => 'GetCoreNetworkPolicy', 'http' => [ 'method' => 'GET', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-policy', ], 'input' => [ 'shape' => 'GetCoreNetworkPolicyRequest', ], 'output' => [ 'shape' => 'GetCoreNetworkPolicyResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], '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', ], ], ], 'GetDirectConnectGatewayAttachment' => [ 'name' => 'GetDirectConnectGatewayAttachment', 'http' => [ 'method' => 'GET', 'requestUri' => '/direct-connect-gateway-attachments/{attachmentId}', ], 'input' => [ 'shape' => 'GetDirectConnectGatewayAttachmentRequest', ], 'output' => [ 'shape' => 'GetDirectConnectGatewayAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], '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', ], ], ], 'GetNetworkResourceCounts' => [ 'name' => 'GetNetworkResourceCounts', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/network-resource-count', ], 'input' => [ 'shape' => 'GetNetworkResourceCountsRequest', ], 'output' => [ 'shape' => 'GetNetworkResourceCountsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetNetworkResourceRelationships' => [ 'name' => 'GetNetworkResourceRelationships', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/network-resource-relationships', ], 'input' => [ 'shape' => 'GetNetworkResourceRelationshipsRequest', ], 'output' => [ 'shape' => 'GetNetworkResourceRelationshipsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetNetworkResources' => [ 'name' => 'GetNetworkResources', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/network-resources', ], 'input' => [ 'shape' => 'GetNetworkResourcesRequest', ], 'output' => [ 'shape' => 'GetNetworkResourcesResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetNetworkRoutes' => [ 'name' => 'GetNetworkRoutes', 'http' => [ 'method' => 'POST', 'requestUri' => '/global-networks/{globalNetworkId}/network-routes', ], 'input' => [ 'shape' => 'GetNetworkRoutesRequest', ], 'output' => [ 'shape' => 'GetNetworkRoutesResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetNetworkTelemetry' => [ 'name' => 'GetNetworkTelemetry', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/network-telemetry', ], 'input' => [ 'shape' => 'GetNetworkTelemetryRequest', ], 'output' => [ 'shape' => 'GetNetworkTelemetryResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetResourcePolicy' => [ 'name' => 'GetResourcePolicy', 'http' => [ 'method' => 'GET', 'requestUri' => '/resource-policy/{resourceArn}', ], 'input' => [ 'shape' => 'GetResourcePolicyRequest', ], 'output' => [ 'shape' => 'GetResourcePolicyResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetRouteAnalysis' => [ 'name' => 'GetRouteAnalysis', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/route-analyses/{routeAnalysisId}', ], 'input' => [ 'shape' => 'GetRouteAnalysisRequest', ], 'output' => [ 'shape' => 'GetRouteAnalysisResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetSiteToSiteVpnAttachment' => [ 'name' => 'GetSiteToSiteVpnAttachment', 'http' => [ 'method' => 'GET', 'requestUri' => '/site-to-site-vpn-attachments/{attachmentId}', ], 'input' => [ 'shape' => 'GetSiteToSiteVpnAttachmentRequest', ], 'output' => [ 'shape' => 'GetSiteToSiteVpnAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'GetTransitGatewayConnectPeerAssociations' => [ 'name' => 'GetTransitGatewayConnectPeerAssociations', 'http' => [ 'method' => 'GET', 'requestUri' => '/global-networks/{globalNetworkId}/transit-gateway-connect-peer-associations', ], 'input' => [ 'shape' => 'GetTransitGatewayConnectPeerAssociationsRequest', ], 'output' => [ 'shape' => 'GetTransitGatewayConnectPeerAssociationsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetTransitGatewayPeering' => [ 'name' => 'GetTransitGatewayPeering', 'http' => [ 'method' => 'GET', 'requestUri' => '/transit-gateway-peerings/{peeringId}', ], 'input' => [ 'shape' => 'GetTransitGatewayPeeringRequest', ], 'output' => [ 'shape' => 'GetTransitGatewayPeeringResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'GetTransitGatewayRouteTableAttachment' => [ 'name' => 'GetTransitGatewayRouteTableAttachment', 'http' => [ 'method' => 'GET', 'requestUri' => '/transit-gateway-route-table-attachments/{attachmentId}', ], 'input' => [ 'shape' => 'GetTransitGatewayRouteTableAttachmentRequest', ], 'output' => [ 'shape' => 'GetTransitGatewayRouteTableAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'GetVpcAttachment' => [ 'name' => 'GetVpcAttachment', 'http' => [ 'method' => 'GET', 'requestUri' => '/vpc-attachments/{attachmentId}', ], 'input' => [ 'shape' => 'GetVpcAttachmentRequest', ], 'output' => [ 'shape' => 'GetVpcAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListAttachments' => [ 'name' => 'ListAttachments', 'http' => [ 'method' => 'GET', 'requestUri' => '/attachments', ], 'input' => [ 'shape' => 'ListAttachmentsRequest', ], 'output' => [ 'shape' => 'ListAttachmentsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListConnectPeers' => [ 'name' => 'ListConnectPeers', 'http' => [ 'method' => 'GET', 'requestUri' => '/connect-peers', ], 'input' => [ 'shape' => 'ListConnectPeersRequest', ], 'output' => [ 'shape' => 'ListConnectPeersResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListCoreNetworkPolicyVersions' => [ 'name' => 'ListCoreNetworkPolicyVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-policy-versions', ], 'input' => [ 'shape' => 'ListCoreNetworkPolicyVersionsRequest', ], 'output' => [ 'shape' => 'ListCoreNetworkPolicyVersionsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListCoreNetworks' => [ 'name' => 'ListCoreNetworks', 'http' => [ 'method' => 'GET', 'requestUri' => '/core-networks', ], 'input' => [ 'shape' => 'ListCoreNetworksRequest', ], 'output' => [ 'shape' => 'ListCoreNetworksResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'ListOrganizationServiceAccessStatus' => [ 'name' => 'ListOrganizationServiceAccessStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/organizations/service-access', ], 'input' => [ 'shape' => 'ListOrganizationServiceAccessStatusRequest', ], 'output' => [ 'shape' => 'ListOrganizationServiceAccessStatusResponse', ], ], 'ListPeerings' => [ 'name' => 'ListPeerings', 'http' => [ 'method' => 'GET', 'requestUri' => '/peerings', ], 'input' => [ 'shape' => 'ListPeeringsRequest', ], 'output' => [ 'shape' => 'ListPeeringsResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'PutCoreNetworkPolicy' => [ 'name' => 'PutCoreNetworkPolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-policy', ], 'input' => [ 'shape' => 'PutCoreNetworkPolicyRequest', ], 'output' => [ 'shape' => 'PutCoreNetworkPolicyResponse', ], 'errors' => [ [ 'shape' => 'CoreNetworkPolicyException', ], [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], ], ], 'PutResourcePolicy' => [ 'name' => 'PutResourcePolicy', 'http' => [ 'method' => 'POST', 'requestUri' => '/resource-policy/{resourceArn}', ], 'input' => [ 'shape' => 'PutResourcePolicyRequest', ], 'output' => [ 'shape' => 'PutResourcePolicyResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'RejectAttachment' => [ 'name' => 'RejectAttachment', 'http' => [ 'method' => 'POST', 'requestUri' => '/attachments/{attachmentId}/reject', ], 'input' => [ 'shape' => 'RejectAttachmentRequest', ], 'output' => [ 'shape' => 'RejectAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'RestoreCoreNetworkPolicyVersion' => [ 'name' => 'RestoreCoreNetworkPolicyVersion', 'http' => [ 'method' => 'POST', 'requestUri' => '/core-networks/{coreNetworkId}/core-network-policy-versions/{policyVersionId}/restore', ], 'input' => [ 'shape' => 'RestoreCoreNetworkPolicyVersionRequest', ], 'output' => [ 'shape' => 'RestoreCoreNetworkPolicyVersionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], [ 'shape' => 'ConflictException', ], ], ], 'StartOrganizationServiceAccessUpdate' => [ 'name' => 'StartOrganizationServiceAccessUpdate', 'http' => [ 'method' => 'POST', 'requestUri' => '/organizations/service-access', ], 'input' => [ 'shape' => 'StartOrganizationServiceAccessUpdateRequest', ], 'output' => [ 'shape' => 'StartOrganizationServiceAccessUpdateResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'ServiceQuotaExceededException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'StartRouteAnalysis' => [ 'name' => 'StartRouteAnalysis', 'http' => [ 'method' => 'POST', 'requestUri' => '/global-networks/{globalNetworkId}/route-analyses', ], 'input' => [ 'shape' => 'StartRouteAnalysisRequest', ], 'output' => [ 'shape' => 'StartRouteAnalysisResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], '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', ], ], ], 'UpdateConnection' => [ 'name' => 'UpdateConnection', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/global-networks/{globalNetworkId}/connections/{connectionId}', ], 'input' => [ 'shape' => 'UpdateConnectionRequest', ], 'output' => [ 'shape' => 'UpdateConnectionResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], 'UpdateCoreNetwork' => [ 'name' => 'UpdateCoreNetwork', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/core-networks/{coreNetworkId}', ], 'input' => [ 'shape' => 'UpdateCoreNetworkRequest', ], 'output' => [ 'shape' => 'UpdateCoreNetworkResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'UpdateDirectConnectGatewayAttachment' => [ 'name' => 'UpdateDirectConnectGatewayAttachment', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/direct-connect-gateway-attachments/{attachmentId}', ], 'input' => [ 'shape' => 'UpdateDirectConnectGatewayAttachmentRequest', ], 'output' => [ 'shape' => 'UpdateDirectConnectGatewayAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], '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', ], ], ], 'UpdateNetworkResourceMetadata' => [ 'name' => 'UpdateNetworkResourceMetadata', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/global-networks/{globalNetworkId}/network-resources/{resourceArn}/metadata', ], 'input' => [ 'shape' => 'UpdateNetworkResourceMetadataRequest', ], 'output' => [ 'shape' => 'UpdateNetworkResourceMetadataResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], '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', ], ], ], 'UpdateVpcAttachment' => [ 'name' => 'UpdateVpcAttachment', 'http' => [ 'method' => 'PATCH', 'requestUri' => '/vpc-attachments/{attachmentId}', ], 'input' => [ 'shape' => 'UpdateVpcAttachmentRequest', ], 'output' => [ 'shape' => 'UpdateVpcAttachmentResponse', ], 'errors' => [ [ 'shape' => 'ValidationException', ], [ 'shape' => 'AccessDeniedException', ], [ 'shape' => 'ResourceNotFoundException', ], [ 'shape' => 'ConflictException', ], [ 'shape' => 'ThrottlingException', ], [ 'shape' => 'InternalServerException', ], ], ], ], 'shapes' => [ 'AWSAccountId' => [ 'type' => 'string', 'max' => 12, 'min' => 12, 'pattern' => '[\\s\\S]*', ], 'AWSLocation' => [ 'type' => 'structure', 'members' => [ 'Zone' => [ 'shape' => 'ConstrainedString', ], 'SubnetArn' => [ 'shape' => 'SubnetArn', ], ], ], 'AcceptAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'AcceptAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], ], ], 'AccessDeniedException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'AccountId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, ], 'AccountStatus' => [ 'type' => 'structure', 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'SLRDeploymentStatus' => [ 'shape' => 'SLRDeploymentStatus', ], ], ], 'AccountStatusList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AccountStatus', ], ], 'Action' => [ 'type' => 'string', 'max' => 50, 'min' => 0, ], 'AssociateConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'ConnectPeerId', 'DeviceId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], ], ], 'AssociateConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeerAssociation' => [ 'shape' => 'ConnectPeerAssociation', ], ], ], 'AssociateCustomerGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'CustomerGatewayArn', 'GlobalNetworkId', 'DeviceId', ], 'members' => [ 'CustomerGatewayArn' => [ 'shape' => 'CustomerGatewayArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], ], ], 'AssociateCustomerGatewayResponse' => [ 'type' => 'structure', 'members' => [ 'CustomerGatewayAssociation' => [ 'shape' => 'CustomerGatewayAssociation', ], ], ], 'AssociateLinkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'DeviceId', 'LinkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], ], ], 'AssociateLinkResponse' => [ 'type' => 'structure', 'members' => [ 'LinkAssociation' => [ 'shape' => 'LinkAssociation', ], ], ], 'AssociateTransitGatewayConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'TransitGatewayConnectPeerArn', 'DeviceId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'TransitGatewayConnectPeerArn' => [ 'shape' => 'TransitGatewayConnectPeerArn', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], ], ], 'AssociateTransitGatewayConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayConnectPeerAssociation' => [ 'shape' => 'TransitGatewayConnectPeerAssociation', ], ], ], 'Attachment' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'CoreNetworkArn' => [ 'shape' => 'CoreNetworkArn', ], 'AttachmentId' => [ 'shape' => 'AttachmentId', ], 'OwnerAccountId' => [ 'shape' => 'AWSAccountId', ], 'AttachmentType' => [ 'shape' => 'AttachmentType', ], 'State' => [ 'shape' => 'AttachmentState', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'EdgeLocations' => [ 'shape' => 'ExternalRegionCodeList', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'AttachmentPolicyRuleNumber' => [ 'shape' => 'Integer', ], 'SegmentName' => [ 'shape' => 'ConstrainedString', ], 'NetworkFunctionGroupName' => [ 'shape' => 'NetworkFunctionGroupName', ], 'Tags' => [ 'shape' => 'TagList', ], 'ProposedSegmentChange' => [ 'shape' => 'ProposedSegmentChange', ], 'ProposedNetworkFunctionGroupChange' => [ 'shape' => 'ProposedNetworkFunctionGroupChange', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'UpdatedAt' => [ 'shape' => 'DateTime', ], 'LastModificationErrors' => [ 'shape' => 'AttachmentErrorList', ], ], ], 'AttachmentError' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'AttachmentErrorCode', ], 'Message' => [ 'shape' => 'ServerSideString', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'RequestId' => [ 'shape' => 'ServerSideString', ], ], ], 'AttachmentErrorCode' => [ 'type' => 'string', 'enum' => [ 'VPC_NOT_FOUND', 'SUBNET_NOT_FOUND', 'SUBNET_DUPLICATED_IN_AVAILABILITY_ZONE', 'SUBNET_NO_FREE_ADDRESSES', 'SUBNET_UNSUPPORTED_AVAILABILITY_ZONE', 'SUBNET_NO_IPV6_CIDRS', 'VPN_CONNECTION_NOT_FOUND', 'MAXIMUM_NO_ENCAP_LIMIT_EXCEEDED', 'DIRECT_CONNECT_GATEWAY_NOT_FOUND', 'DIRECT_CONNECT_GATEWAY_EXISTING_ATTACHMENTS', 'DIRECT_CONNECT_GATEWAY_NO_PRIVATE_VIF', ], ], 'AttachmentErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AttachmentError', ], 'max' => 20, 'min' => 0, ], 'AttachmentId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '^attachment-([0-9a-f]{8,17})$', ], 'AttachmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Attachment', ], ], 'AttachmentState' => [ 'type' => 'string', 'enum' => [ 'REJECTED', 'PENDING_ATTACHMENT_ACCEPTANCE', 'CREATING', 'FAILED', 'AVAILABLE', 'UPDATING', 'PENDING_NETWORK_UPDATE', 'PENDING_TAG_ACCEPTANCE', 'DELETING', ], ], 'AttachmentType' => [ 'type' => 'string', 'enum' => [ 'CONNECT', 'SITE_TO_SITE_VPN', 'VPC', 'DIRECT_CONNECT_GATEWAY', 'TRANSIT_GATEWAY_ROUTE_TABLE', ], ], 'Bandwidth' => [ 'type' => 'structure', 'members' => [ 'UploadSpeed' => [ 'shape' => 'Integer', ], 'DownloadSpeed' => [ 'shape' => 'Integer', ], ], ], 'BgpOptions' => [ 'type' => 'structure', 'members' => [ 'PeerAsn' => [ 'shape' => 'Long', ], ], ], 'Boolean' => [ 'type' => 'boolean', ], 'ChangeAction' => [ 'type' => 'string', 'enum' => [ 'ADD', 'MODIFY', 'REMOVE', ], ], 'ChangeSetState' => [ 'type' => 'string', 'enum' => [ 'PENDING_GENERATION', 'FAILED_GENERATION', 'READY_TO_EXECUTE', 'EXECUTING', 'EXECUTION_SUCCEEDED', 'OUT_OF_DATE', ], ], 'ChangeStatus' => [ 'type' => 'string', 'enum' => [ 'NOT_STARTED', 'IN_PROGRESS', 'COMPLETE', 'FAILED', ], ], 'ChangeType' => [ 'type' => 'string', 'enum' => [ 'CORE_NETWORK_SEGMENT', 'NETWORK_FUNCTION_GROUP', 'CORE_NETWORK_EDGE', 'ATTACHMENT_MAPPING', 'ATTACHMENT_ROUTE_PROPAGATION', 'ATTACHMENT_ROUTE_STATIC', 'CORE_NETWORK_CONFIGURATION', 'SEGMENTS_CONFIGURATION', 'SEGMENT_ACTIONS_CONFIGURATION', 'ATTACHMENT_POLICIES_CONFIGURATION', ], ], 'ClientToken' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ConflictException' => [ 'type' => 'structure', 'required' => [ 'Message', 'ResourceId', 'ResourceType', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'ResourceId' => [ 'shape' => 'ServerSideString', ], 'ResourceType' => [ 'shape' => 'ServerSideString', ], ], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'ConnectAttachment' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], 'TransportAttachmentId' => [ 'shape' => 'AttachmentId', ], 'Options' => [ 'shape' => 'ConnectAttachmentOptions', ], ], ], 'ConnectAttachmentOptions' => [ 'type' => 'structure', 'members' => [ 'Protocol' => [ 'shape' => 'TunnelProtocol', ], ], ], 'ConnectPeer' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'ConnectAttachmentId' => [ 'shape' => 'AttachmentId', ], 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'State' => [ 'shape' => 'ConnectPeerState', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'Configuration' => [ 'shape' => 'ConnectPeerConfiguration', ], 'Tags' => [ 'shape' => 'TagList', ], 'SubnetArn' => [ 'shape' => 'SubnetArn', ], 'LastModificationErrors' => [ 'shape' => 'ConnectPeerErrorList', ], ], ], 'ConnectPeerAssociation' => [ 'type' => 'structure', 'members' => [ 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'State' => [ 'shape' => 'ConnectPeerAssociationState', ], ], ], 'ConnectPeerAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectPeerAssociation', ], ], 'ConnectPeerAssociationState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'DELETED', ], ], 'ConnectPeerBgpConfiguration' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkAsn' => [ 'shape' => 'Long', ], 'PeerAsn' => [ 'shape' => 'Long', ], 'CoreNetworkAddress' => [ 'shape' => 'IPAddress', ], 'PeerAddress' => [ 'shape' => 'IPAddress', ], ], ], 'ConnectPeerBgpConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectPeerBgpConfiguration', ], ], 'ConnectPeerConfiguration' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkAddress' => [ 'shape' => 'IPAddress', ], 'PeerAddress' => [ 'shape' => 'IPAddress', ], 'InsideCidrBlocks' => [ 'shape' => 'ConstrainedStringList', ], 'Protocol' => [ 'shape' => 'TunnelProtocol', ], 'BgpConfigurations' => [ 'shape' => 'ConnectPeerBgpConfigurationList', ], ], ], 'ConnectPeerError' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'ConnectPeerErrorCode', ], 'Message' => [ 'shape' => 'ServerSideString', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'RequestId' => [ 'shape' => 'ServerSideString', ], ], ], 'ConnectPeerErrorCode' => [ 'type' => 'string', 'enum' => [ 'EDGE_LOCATION_NO_FREE_IPS', 'EDGE_LOCATION_PEER_DUPLICATE', 'SUBNET_NOT_FOUND', 'IP_OUTSIDE_SUBNET_CIDR_RANGE', 'INVALID_INSIDE_CIDR_BLOCK', 'NO_ASSOCIATED_CIDR_BLOCK', ], ], 'ConnectPeerErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectPeerError', ], 'max' => 20, 'min' => 0, ], 'ConnectPeerId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '^connect-peer-([0-9a-f]{8,17})$', ], 'ConnectPeerIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectPeerId', ], ], 'ConnectPeerState' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'FAILED', 'AVAILABLE', 'DELETING', ], ], 'ConnectPeerSummary' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'ConnectAttachmentId' => [ 'shape' => 'AttachmentId', ], 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'ConnectPeerState' => [ 'shape' => 'ConnectPeerState', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'Tags' => [ 'shape' => 'TagList', ], 'SubnetArn' => [ 'shape' => 'SubnetArn', ], ], ], 'ConnectPeerSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectPeerSummary', ], ], 'Connection' => [ 'type' => 'structure', 'members' => [ 'ConnectionId' => [ 'shape' => 'ConnectionId', ], 'ConnectionArn' => [ 'shape' => 'ConnectionArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'ConnectedDeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'ConnectedLinkId' => [ 'shape' => 'LinkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'State' => [ 'shape' => 'ConnectionState', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'ConnectionArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ConnectionHealth' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ConnectionType', ], 'Status' => [ 'shape' => 'ConnectionStatus', ], 'Timestamp' => [ 'shape' => 'DateTime', ], ], ], 'ConnectionId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ConnectionIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConnectionId', ], ], 'ConnectionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Connection', ], ], 'ConnectionState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'UPDATING', ], ], 'ConnectionStatus' => [ 'type' => 'string', 'enum' => [ 'UP', 'DOWN', ], ], 'ConnectionType' => [ 'type' => 'string', 'enum' => [ 'BGP', 'IPSEC', ], ], 'ConstrainedString' => [ 'type' => 'string', 'max' => 256, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ConstrainedStringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConstrainedString', ], ], 'CoreNetwork' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'CoreNetworkArn' => [ 'shape' => 'CoreNetworkArn', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'State' => [ 'shape' => 'CoreNetworkState', ], 'Segments' => [ 'shape' => 'CoreNetworkSegmentList', ], 'NetworkFunctionGroups' => [ 'shape' => 'CoreNetworkNetworkFunctionGroupList', ], 'Edges' => [ 'shape' => 'CoreNetworkEdgeList', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CoreNetworkArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'CoreNetworkChange' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ChangeType', ], 'Action' => [ 'shape' => 'ChangeAction', ], 'Identifier' => [ 'shape' => 'ConstrainedString', ], 'PreviousValues' => [ 'shape' => 'CoreNetworkChangeValues', ], 'NewValues' => [ 'shape' => 'CoreNetworkChangeValues', ], 'IdentifierPath' => [ 'shape' => 'ConstrainedString', ], ], ], 'CoreNetworkChangeEvent' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'ChangeType', ], 'Action' => [ 'shape' => 'ChangeAction', ], 'IdentifierPath' => [ 'shape' => 'ConstrainedString', ], 'EventTime' => [ 'shape' => 'DateTime', ], 'Status' => [ 'shape' => 'ChangeStatus', ], 'Values' => [ 'shape' => 'CoreNetworkChangeEventValues', ], ], ], 'CoreNetworkChangeEventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkChangeEvent', ], ], 'CoreNetworkChangeEventValues' => [ 'type' => 'structure', 'members' => [ 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'SegmentName' => [ 'shape' => 'ConstrainedString', ], 'NetworkFunctionGroupName' => [ 'shape' => 'ConstrainedString', ], 'AttachmentId' => [ 'shape' => 'AttachmentId', ], 'Cidr' => [ 'shape' => 'ConstrainedString', ], ], ], 'CoreNetworkChangeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkChange', ], ], 'CoreNetworkChangeValues' => [ 'type' => 'structure', 'members' => [ 'SegmentName' => [ 'shape' => 'ConstrainedString', ], 'NetworkFunctionGroupName' => [ 'shape' => 'ConstrainedString', ], 'EdgeLocations' => [ 'shape' => 'ExternalRegionCodeList', ], 'Asn' => [ 'shape' => 'Long', ], 'Cidr' => [ 'shape' => 'ConstrainedString', ], 'DestinationIdentifier' => [ 'shape' => 'ConstrainedString', ], 'InsideCidrBlocks' => [ 'shape' => 'ConstrainedStringList', ], 'SharedSegments' => [ 'shape' => 'ConstrainedStringList', ], 'ServiceInsertionActions' => [ 'shape' => 'ServiceInsertionActionList', ], ], ], 'CoreNetworkEdge' => [ 'type' => 'structure', 'members' => [ 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'Asn' => [ 'shape' => 'Long', ], 'InsideCidrBlocks' => [ 'shape' => 'ConstrainedStringList', ], ], ], 'CoreNetworkEdgeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkEdge', ], ], 'CoreNetworkId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '^core-network-([0-9a-f]{8,17})$', ], 'CoreNetworkNetworkFunctionGroup' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ConstrainedString', ], 'EdgeLocations' => [ 'shape' => 'ExternalRegionCodeList', ], 'Segments' => [ 'shape' => 'ServiceInsertionSegments', ], ], ], 'CoreNetworkNetworkFunctionGroupIdentifier' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'NetworkFunctionGroupName' => [ 'shape' => 'ConstrainedString', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], ], ], 'CoreNetworkNetworkFunctionGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkNetworkFunctionGroup', ], ], 'CoreNetworkPolicy' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', ], 'Alias' => [ 'shape' => 'CoreNetworkPolicyAlias', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'ChangeSetState' => [ 'shape' => 'ChangeSetState', ], 'PolicyErrors' => [ 'shape' => 'CoreNetworkPolicyErrorList', ], 'PolicyDocument' => [ 'shape' => 'CoreNetworkPolicyDocument', 'jsonvalue' => true, ], ], ], 'CoreNetworkPolicyAlias' => [ 'type' => 'string', 'enum' => [ 'LIVE', 'LATEST', ], ], 'CoreNetworkPolicyDocument' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'CoreNetworkPolicyError' => [ 'type' => 'structure', 'required' => [ 'ErrorCode', 'Message', ], 'members' => [ 'ErrorCode' => [ 'shape' => 'ServerSideString', ], 'Message' => [ 'shape' => 'ServerSideString', ], 'Path' => [ 'shape' => 'ServerSideString', ], ], ], 'CoreNetworkPolicyErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkPolicyError', ], ], 'CoreNetworkPolicyException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'Errors' => [ 'shape' => 'CoreNetworkPolicyErrorList', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'CoreNetworkPolicyVersion' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', ], 'Alias' => [ 'shape' => 'CoreNetworkPolicyAlias', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'ChangeSetState' => [ 'shape' => 'ChangeSetState', ], ], ], 'CoreNetworkPolicyVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkPolicyVersion', ], ], 'CoreNetworkSegment' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ConstrainedString', ], 'EdgeLocations' => [ 'shape' => 'ExternalRegionCodeList', ], 'SharedSegments' => [ 'shape' => 'ConstrainedStringList', ], ], ], 'CoreNetworkSegmentEdgeIdentifier' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'SegmentName' => [ 'shape' => 'ConstrainedString', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], ], ], 'CoreNetworkSegmentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkSegment', ], ], 'CoreNetworkState' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'UPDATING', 'AVAILABLE', 'DELETING', ], ], 'CoreNetworkSummary' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'CoreNetworkArn' => [ 'shape' => 'CoreNetworkArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'OwnerAccountId' => [ 'shape' => 'AWSAccountId', ], 'State' => [ 'shape' => 'CoreNetworkState', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CoreNetworkSummaryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CoreNetworkSummary', ], ], 'CreateConnectAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'EdgeLocation', 'TransportAttachmentId', 'Options', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'TransportAttachmentId' => [ 'shape' => 'AttachmentId', ], 'Options' => [ 'shape' => 'ConnectAttachmentOptions', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateConnectAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectAttachment' => [ 'shape' => 'ConnectAttachment', ], ], ], 'CreateConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectAttachmentId', 'PeerAddress', ], 'members' => [ 'ConnectAttachmentId' => [ 'shape' => 'AttachmentId', ], 'CoreNetworkAddress' => [ 'shape' => 'IPAddress', ], 'PeerAddress' => [ 'shape' => 'IPAddress', ], 'BgpOptions' => [ 'shape' => 'BgpOptions', ], 'InsideCidrBlocks' => [ 'shape' => 'ConstrainedStringList', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], 'SubnetArn' => [ 'shape' => 'SubnetArn', ], ], ], 'CreateConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeer' => [ 'shape' => 'ConnectPeer', ], ], ], 'CreateConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'DeviceId', 'ConnectedDeviceId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'ConnectedDeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'ConnectedLinkId' => [ 'shape' => 'LinkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'Connection', ], ], ], 'CreateCoreNetworkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Tags' => [ 'shape' => 'TagList', ], 'PolicyDocument' => [ 'shape' => 'CoreNetworkPolicyDocument', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateCoreNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetwork' => [ 'shape' => 'CoreNetwork', ], ], ], 'CreateDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'AWSLocation' => [ 'shape' => 'AWSLocation', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Type' => [ 'shape' => 'ConstrainedString', ], 'Vendor' => [ 'shape' => 'ConstrainedString', ], 'Model' => [ 'shape' => 'ConstrainedString', ], 'SerialNumber' => [ 'shape' => 'ConstrainedString', ], 'Location' => [ 'shape' => 'Location', ], 'SiteId' => [ 'shape' => 'SiteId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateDeviceResponse' => [ 'type' => 'structure', 'members' => [ 'Device' => [ 'shape' => 'Device', ], ], ], 'CreateDirectConnectGatewayAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'DirectConnectGatewayArn', 'EdgeLocations', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'DirectConnectGatewayArn' => [ 'shape' => 'DirectConnectGatewayArn', ], 'EdgeLocations' => [ 'shape' => 'ExternalRegionCodeList', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateDirectConnectGatewayAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'DirectConnectGatewayAttachment' => [ 'shape' => 'DirectConnectGatewayAttachment', ], ], ], 'CreateGlobalNetworkRequest' => [ 'type' => 'structure', 'members' => [ 'Description' => [ 'shape' => 'ConstrainedString', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateGlobalNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'GlobalNetwork' => [ 'shape' => 'GlobalNetwork', ], ], ], 'CreateLinkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'Bandwidth', 'SiteId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Type' => [ 'shape' => 'ConstrainedString', ], 'Bandwidth' => [ 'shape' => 'Bandwidth', ], 'Provider' => [ 'shape' => 'ConstrainedString', ], 'SiteId' => [ 'shape' => 'SiteId', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateLinkResponse' => [ 'type' => 'structure', 'members' => [ 'Link' => [ 'shape' => 'Link', ], ], ], 'CreateSiteRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Location' => [ 'shape' => 'Location', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'CreateSiteResponse' => [ 'type' => 'structure', 'members' => [ 'Site' => [ 'shape' => 'Site', ], ], ], 'CreateSiteToSiteVpnAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'VpnConnectionArn', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'VpnConnectionArn' => [ 'shape' => 'VpnConnectionArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateSiteToSiteVpnAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'SiteToSiteVpnAttachment' => [ 'shape' => 'SiteToSiteVpnAttachment', ], ], ], 'CreateTransitGatewayPeeringRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'TransitGatewayArn', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'TransitGatewayArn' => [ 'shape' => 'TransitGatewayArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateTransitGatewayPeeringResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayPeering' => [ 'shape' => 'TransitGatewayPeering', ], ], ], 'CreateTransitGatewayRouteTableAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'PeeringId', 'TransitGatewayRouteTableArn', ], 'members' => [ 'PeeringId' => [ 'shape' => 'PeeringId', ], 'TransitGatewayRouteTableArn' => [ 'shape' => 'TransitGatewayRouteTableArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateTransitGatewayRouteTableAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayRouteTableAttachment' => [ 'shape' => 'TransitGatewayRouteTableAttachment', ], ], ], 'CreateVpcAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'VpcArn', 'SubnetArns', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'VpcArn' => [ 'shape' => 'VpcArn', ], 'SubnetArns' => [ 'shape' => 'SubnetArnList', ], 'Options' => [ 'shape' => 'VpcOptions', ], 'Tags' => [ 'shape' => 'TagList', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'CreateVpcAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'VpcAttachment' => [ 'shape' => 'VpcAttachment', ], ], ], 'CustomerGatewayArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'CustomerGatewayArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerGatewayArn', ], ], 'CustomerGatewayAssociation' => [ 'type' => 'structure', 'members' => [ 'CustomerGatewayArn' => [ 'shape' => 'CustomerGatewayArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'State' => [ 'shape' => 'CustomerGatewayAssociationState', ], ], ], 'CustomerGatewayAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CustomerGatewayAssociation', ], ], 'CustomerGatewayAssociationState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'DELETED', ], ], 'DateTime' => [ 'type' => 'timestamp', ], 'DeleteAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'DeleteAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], ], ], 'DeleteConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectPeerId', ], 'members' => [ 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', 'location' => 'uri', 'locationName' => 'connectPeerId', ], ], ], 'DeleteConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeer' => [ 'shape' => 'ConnectPeer', ], ], ], 'DeleteConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'ConnectionId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'connectionId', ], ], ], 'DeleteConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'Connection', ], ], ], 'DeleteCoreNetworkPolicyVersionRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'PolicyVersionId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', 'location' => 'uri', 'locationName' => 'policyVersionId', ], ], ], 'DeleteCoreNetworkPolicyVersionResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkPolicy' => [ 'shape' => 'CoreNetworkPolicy', ], ], ], 'DeleteCoreNetworkRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], ], ], 'DeleteCoreNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetwork' => [ 'shape' => 'CoreNetwork', ], ], ], 'DeleteDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'DeviceId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', 'location' => 'uri', 'locationName' => 'deviceId', ], ], ], 'DeleteDeviceResponse' => [ 'type' => 'structure', 'members' => [ 'Device' => [ 'shape' => 'Device', ], ], ], 'DeleteGlobalNetworkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], ], ], 'DeleteGlobalNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'GlobalNetwork' => [ 'shape' => 'GlobalNetwork', ], ], ], 'DeleteLinkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'LinkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'LinkId' => [ 'shape' => 'LinkId', 'location' => 'uri', 'locationName' => 'linkId', ], ], ], 'DeleteLinkResponse' => [ 'type' => 'structure', 'members' => [ 'Link' => [ 'shape' => 'Link', ], ], ], 'DeletePeeringRequest' => [ 'type' => 'structure', 'required' => [ 'PeeringId', ], 'members' => [ 'PeeringId' => [ 'shape' => 'PeeringId', 'location' => 'uri', 'locationName' => 'peeringId', ], ], ], 'DeletePeeringResponse' => [ 'type' => 'structure', 'members' => [ 'Peering' => [ 'shape' => 'Peering', ], ], ], 'DeleteResourcePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'DeleteResourcePolicyResponse' => [ 'type' => 'structure', 'members' => [], ], 'DeleteSiteRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'SiteId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'SiteId' => [ 'shape' => 'SiteId', 'location' => 'uri', 'locationName' => 'siteId', ], ], ], 'DeleteSiteResponse' => [ 'type' => 'structure', 'members' => [ 'Site' => [ 'shape' => 'Site', ], ], ], 'DeregisterTransitGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'TransitGatewayArn', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'TransitGatewayArn' => [ 'shape' => 'TransitGatewayArn', 'location' => 'uri', 'locationName' => 'transitGatewayArn', ], ], ], 'DeregisterTransitGatewayResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayRegistration' => [ 'shape' => 'TransitGatewayRegistration', ], ], ], 'DescribeGlobalNetworksRequest' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworkIds' => [ 'shape' => 'GlobalNetworkIdList', 'location' => 'querystring', 'locationName' => 'globalNetworkIds', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'DescribeGlobalNetworksResponse' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworks' => [ 'shape' => 'GlobalNetworkList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'Device' => [ 'type' => 'structure', 'members' => [ 'DeviceId' => [ 'shape' => 'DeviceId', ], 'DeviceArn' => [ 'shape' => 'DeviceArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'AWSLocation' => [ 'shape' => 'AWSLocation', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Type' => [ 'shape' => 'ConstrainedString', ], 'Vendor' => [ 'shape' => 'ConstrainedString', ], 'Model' => [ 'shape' => 'ConstrainedString', ], 'SerialNumber' => [ 'shape' => 'ConstrainedString', ], 'Location' => [ 'shape' => 'Location', ], 'SiteId' => [ 'shape' => 'SiteId', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'State' => [ 'shape' => 'DeviceState', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'DeviceArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'DeviceId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'DeviceIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeviceId', ], ], 'DeviceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Device', ], ], 'DeviceState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'UPDATING', ], ], 'DirectConnectGatewayArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '^arn:[^:]{1,63}:directconnect::[^:]{0,63}:dx-gateway\\/[0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}$', ], 'DirectConnectGatewayAttachment' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], 'DirectConnectGatewayArn' => [ 'shape' => 'DirectConnectGatewayArn', ], ], ], 'DisassociateConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'ConnectPeerId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', 'location' => 'uri', 'locationName' => 'connectPeerId', ], ], ], 'DisassociateConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeerAssociation' => [ 'shape' => 'ConnectPeerAssociation', ], ], ], 'DisassociateCustomerGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'CustomerGatewayArn', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'CustomerGatewayArn' => [ 'shape' => 'CustomerGatewayArn', 'location' => 'uri', 'locationName' => 'customerGatewayArn', ], ], ], 'DisassociateCustomerGatewayResponse' => [ 'type' => 'structure', 'members' => [ 'CustomerGatewayAssociation' => [ 'shape' => 'CustomerGatewayAssociation', ], ], ], 'DisassociateLinkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'DeviceId', 'LinkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', 'location' => 'querystring', 'locationName' => 'deviceId', ], 'LinkId' => [ 'shape' => 'LinkId', 'location' => 'querystring', 'locationName' => 'linkId', ], ], ], 'DisassociateLinkResponse' => [ 'type' => 'structure', 'members' => [ 'LinkAssociation' => [ 'shape' => 'LinkAssociation', ], ], ], 'DisassociateTransitGatewayConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'TransitGatewayConnectPeerArn', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'TransitGatewayConnectPeerArn' => [ 'shape' => 'TransitGatewayConnectPeerArn', 'location' => 'uri', 'locationName' => 'transitGatewayConnectPeerArn', ], ], ], 'DisassociateTransitGatewayConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayConnectPeerAssociation' => [ 'shape' => 'TransitGatewayConnectPeerAssociation', ], ], ], 'EdgeOverride' => [ 'type' => 'structure', 'members' => [ 'EdgeSets' => [ 'shape' => 'EdgeSetList', ], 'UseEdge' => [ 'shape' => 'ConstrainedString', ], ], ], 'EdgeSet' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConstrainedString', ], ], 'EdgeSetList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeSet', ], ], 'ExceptionContextKey' => [ 'type' => 'string', ], 'ExceptionContextMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ExceptionContextKey', ], 'value' => [ 'shape' => 'ExceptionContextValue', ], ], 'ExceptionContextValue' => [ 'type' => 'string', ], 'ExecuteCoreNetworkChangeSetRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'PolicyVersionId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', 'location' => 'uri', 'locationName' => 'policyVersionId', ], ], ], 'ExecuteCoreNetworkChangeSetResponse' => [ 'type' => 'structure', 'members' => [], ], 'ExternalRegionCode' => [ 'type' => 'string', 'max' => 63, 'min' => 1, 'pattern' => '[\\s\\S]*', ], 'ExternalRegionCodeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExternalRegionCode', ], ], 'FilterMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'FilterName', ], 'value' => [ 'shape' => 'FilterValues', ], ], 'FilterName' => [ 'type' => 'string', 'max' => 128, 'pattern' => '^[0-9a-zA-Z\\.-]*$', ], 'FilterValue' => [ 'type' => 'string', 'max' => 255, 'pattern' => '^[0-9a-zA-Z\\*\\.\\\\/\\?-]*$', ], 'FilterValues' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterValue', ], ], 'GetConnectAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'GetConnectAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectAttachment' => [ 'shape' => 'ConnectAttachment', ], ], ], 'GetConnectPeerAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ConnectPeerIds' => [ 'shape' => 'ConnectPeerIdList', 'location' => 'querystring', 'locationName' => 'connectPeerIds', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetConnectPeerAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeerAssociations' => [ 'shape' => 'ConnectPeerAssociationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetConnectPeerRequest' => [ 'type' => 'structure', 'required' => [ 'ConnectPeerId', ], 'members' => [ 'ConnectPeerId' => [ 'shape' => 'ConnectPeerId', 'location' => 'uri', 'locationName' => 'connectPeerId', ], ], ], 'GetConnectPeerResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeer' => [ 'shape' => 'ConnectPeer', ], ], ], 'GetConnectionsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ConnectionIds' => [ 'shape' => 'ConnectionIdList', 'location' => 'querystring', 'locationName' => 'connectionIds', ], 'DeviceId' => [ 'shape' => 'DeviceId', 'location' => 'querystring', 'locationName' => 'deviceId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetConnectionsResponse' => [ 'type' => 'structure', 'members' => [ 'Connections' => [ 'shape' => 'ConnectionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetCoreNetworkChangeEventsRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'PolicyVersionId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', 'location' => 'uri', 'locationName' => 'policyVersionId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetCoreNetworkChangeEventsResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkChangeEvents' => [ 'shape' => 'CoreNetworkChangeEventList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetCoreNetworkChangeSetRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'PolicyVersionId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', 'location' => 'uri', 'locationName' => 'policyVersionId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetCoreNetworkChangeSetResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkChanges' => [ 'shape' => 'CoreNetworkChangeList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetCoreNetworkPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', 'location' => 'querystring', 'locationName' => 'policyVersionId', ], 'Alias' => [ 'shape' => 'CoreNetworkPolicyAlias', 'location' => 'querystring', 'locationName' => 'alias', ], ], ], 'GetCoreNetworkPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkPolicy' => [ 'shape' => 'CoreNetworkPolicy', ], ], ], 'GetCoreNetworkRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], ], ], 'GetCoreNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetwork' => [ 'shape' => 'CoreNetwork', ], ], ], 'GetCustomerGatewayAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'CustomerGatewayArns' => [ 'shape' => 'CustomerGatewayArnList', 'location' => 'querystring', 'locationName' => 'customerGatewayArns', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetCustomerGatewayAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'CustomerGatewayAssociations' => [ 'shape' => 'CustomerGatewayAssociationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetDevicesRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceIds' => [ 'shape' => 'DeviceIdList', 'location' => 'querystring', 'locationName' => 'deviceIds', ], 'SiteId' => [ 'shape' => 'SiteId', 'location' => 'querystring', 'locationName' => 'siteId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetDevicesResponse' => [ 'type' => 'structure', 'members' => [ 'Devices' => [ 'shape' => 'DeviceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetDirectConnectGatewayAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'GetDirectConnectGatewayAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'DirectConnectGatewayAttachment' => [ 'shape' => 'DirectConnectGatewayAttachment', ], ], ], 'GetLinkAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', 'location' => 'querystring', 'locationName' => 'deviceId', ], 'LinkId' => [ 'shape' => 'LinkId', 'location' => 'querystring', 'locationName' => 'linkId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetLinkAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'LinkAssociations' => [ 'shape' => 'LinkAssociationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetLinksRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'LinkIds' => [ 'shape' => 'LinkIdList', 'location' => 'querystring', 'locationName' => 'linkIds', ], 'SiteId' => [ 'shape' => 'SiteId', 'location' => 'querystring', 'locationName' => 'siteId', ], 'Type' => [ 'shape' => 'ConstrainedString', 'location' => 'querystring', 'locationName' => 'type', ], 'Provider' => [ 'shape' => 'ConstrainedString', 'location' => 'querystring', 'locationName' => 'provider', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetLinksResponse' => [ 'type' => 'structure', 'members' => [ 'Links' => [ 'shape' => 'LinkList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetNetworkResourceCountsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetNetworkResourceCountsResponse' => [ 'type' => 'structure', 'members' => [ 'NetworkResourceCounts' => [ 'shape' => 'NetworkResourceCountList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetNetworkResourceRelationshipsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'querystring', 'locationName' => 'coreNetworkId', ], 'RegisteredGatewayArn' => [ 'shape' => 'ResourceArn', 'location' => 'querystring', 'locationName' => 'registeredGatewayArn', ], 'AwsRegion' => [ 'shape' => 'ExternalRegionCode', 'location' => 'querystring', 'locationName' => 'awsRegion', ], 'AccountId' => [ 'shape' => 'AWSAccountId', 'location' => 'querystring', 'locationName' => 'accountId', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'querystring', 'locationName' => 'resourceArn', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetNetworkResourceRelationshipsResponse' => [ 'type' => 'structure', 'members' => [ 'Relationships' => [ 'shape' => 'RelationshipList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetNetworkResourcesRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'querystring', 'locationName' => 'coreNetworkId', ], 'RegisteredGatewayArn' => [ 'shape' => 'ResourceArn', 'location' => 'querystring', 'locationName' => 'registeredGatewayArn', ], 'AwsRegion' => [ 'shape' => 'ExternalRegionCode', 'location' => 'querystring', 'locationName' => 'awsRegion', ], 'AccountId' => [ 'shape' => 'AWSAccountId', 'location' => 'querystring', 'locationName' => 'accountId', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'querystring', 'locationName' => 'resourceArn', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetNetworkResourcesResponse' => [ 'type' => 'structure', 'members' => [ 'NetworkResources' => [ 'shape' => 'NetworkResourceList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetNetworkRoutesRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'RouteTableIdentifier', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'RouteTableIdentifier' => [ 'shape' => 'RouteTableIdentifier', ], 'ExactCidrMatches' => [ 'shape' => 'ConstrainedStringList', ], 'LongestPrefixMatches' => [ 'shape' => 'ConstrainedStringList', ], 'SubnetOfMatches' => [ 'shape' => 'ConstrainedStringList', ], 'SupernetOfMatches' => [ 'shape' => 'ConstrainedStringList', ], 'PrefixListIds' => [ 'shape' => 'ConstrainedStringList', ], 'States' => [ 'shape' => 'RouteStateList', ], 'Types' => [ 'shape' => 'RouteTypeList', ], 'DestinationFilters' => [ 'shape' => 'FilterMap', ], ], ], 'GetNetworkRoutesResponse' => [ 'type' => 'structure', 'members' => [ 'RouteTableArn' => [ 'shape' => 'ResourceArn', ], 'CoreNetworkSegmentEdge' => [ 'shape' => 'CoreNetworkSegmentEdgeIdentifier', ], 'RouteTableType' => [ 'shape' => 'RouteTableType', ], 'RouteTableTimestamp' => [ 'shape' => 'DateTime', ], 'NetworkRoutes' => [ 'shape' => 'NetworkRouteList', ], ], ], 'GetNetworkTelemetryRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'querystring', 'locationName' => 'coreNetworkId', ], 'RegisteredGatewayArn' => [ 'shape' => 'ResourceArn', 'location' => 'querystring', 'locationName' => 'registeredGatewayArn', ], 'AwsRegion' => [ 'shape' => 'ExternalRegionCode', 'location' => 'querystring', 'locationName' => 'awsRegion', ], 'AccountId' => [ 'shape' => 'AWSAccountId', 'location' => 'querystring', 'locationName' => 'accountId', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', 'location' => 'querystring', 'locationName' => 'resourceType', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'querystring', 'locationName' => 'resourceArn', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetNetworkTelemetryResponse' => [ 'type' => 'structure', 'members' => [ 'NetworkTelemetry' => [ 'shape' => 'NetworkTelemetryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetResourcePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'GetResourcePolicyResponse' => [ 'type' => 'structure', 'members' => [ 'PolicyDocument' => [ 'shape' => 'ResourcePolicyDocument', 'jsonvalue' => true, ], ], ], 'GetRouteAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'RouteAnalysisId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'RouteAnalysisId' => [ 'shape' => 'ConstrainedString', 'location' => 'uri', 'locationName' => 'routeAnalysisId', ], ], ], 'GetRouteAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'RouteAnalysis' => [ 'shape' => 'RouteAnalysis', ], ], ], 'GetSiteToSiteVpnAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'GetSiteToSiteVpnAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'SiteToSiteVpnAttachment' => [ 'shape' => 'SiteToSiteVpnAttachment', ], ], ], 'GetSitesRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'SiteIds' => [ 'shape' => 'SiteIdList', 'location' => 'querystring', 'locationName' => 'siteIds', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetSitesResponse' => [ 'type' => 'structure', 'members' => [ 'Sites' => [ 'shape' => 'SiteList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetTransitGatewayConnectPeerAssociationsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'TransitGatewayConnectPeerArns' => [ 'shape' => 'TransitGatewayConnectPeerArnList', 'location' => 'querystring', 'locationName' => 'transitGatewayConnectPeerArns', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetTransitGatewayConnectPeerAssociationsResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayConnectPeerAssociations' => [ 'shape' => 'TransitGatewayConnectPeerAssociationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetTransitGatewayPeeringRequest' => [ 'type' => 'structure', 'required' => [ 'PeeringId', ], 'members' => [ 'PeeringId' => [ 'shape' => 'PeeringId', 'location' => 'uri', 'locationName' => 'peeringId', ], ], ], 'GetTransitGatewayPeeringResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayPeering' => [ 'shape' => 'TransitGatewayPeering', ], ], ], 'GetTransitGatewayRegistrationsRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'TransitGatewayArns' => [ 'shape' => 'TransitGatewayArnList', 'location' => 'querystring', 'locationName' => 'transitGatewayArns', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'GetTransitGatewayRegistrationsResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayRegistrations' => [ 'shape' => 'TransitGatewayRegistrationList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'GetTransitGatewayRouteTableAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'GetTransitGatewayRouteTableAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayRouteTableAttachment' => [ 'shape' => 'TransitGatewayRouteTableAttachment', ], ], ], 'GetVpcAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'GetVpcAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'VpcAttachment' => [ 'shape' => 'VpcAttachment', ], ], ], 'GlobalNetwork' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'GlobalNetworkArn' => [ 'shape' => 'GlobalNetworkArn', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'State' => [ 'shape' => 'GlobalNetworkState', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'GlobalNetworkArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'GlobalNetworkId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'GlobalNetworkIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalNetworkId', ], ], 'GlobalNetworkList' => [ 'type' => 'list', 'member' => [ 'shape' => 'GlobalNetwork', ], ], 'GlobalNetworkState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'UPDATING', ], ], 'IPAddress' => [ 'type' => 'string', 'max' => 50, 'min' => 1, 'pattern' => '[\\s\\S]*', ], 'Integer' => [ 'type' => 'integer', ], 'InternalServerException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'RetryAfterSeconds' => [ 'shape' => 'RetryAfterSeconds', 'location' => 'header', 'locationName' => 'Retry-After', ], ], 'error' => [ 'httpStatusCode' => 500, ], 'exception' => true, 'fault' => true, ], 'Link' => [ 'type' => 'structure', 'members' => [ 'LinkId' => [ 'shape' => 'LinkId', ], 'LinkArn' => [ 'shape' => 'LinkArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'SiteId' => [ 'shape' => 'SiteId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Type' => [ 'shape' => 'ConstrainedString', ], 'Bandwidth' => [ 'shape' => 'Bandwidth', ], 'Provider' => [ 'shape' => 'ConstrainedString', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'State' => [ 'shape' => 'LinkState', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'LinkArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'LinkAssociation' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'LinkAssociationState' => [ 'shape' => 'LinkAssociationState', ], ], ], 'LinkAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LinkAssociation', ], ], 'LinkAssociationState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'DELETED', ], ], 'LinkId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'LinkIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LinkId', ], ], 'LinkList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Link', ], ], 'LinkState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'UPDATING', ], ], 'ListAttachmentsRequest' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'querystring', 'locationName' => 'coreNetworkId', ], 'AttachmentType' => [ 'shape' => 'AttachmentType', 'location' => 'querystring', 'locationName' => 'attachmentType', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', 'location' => 'querystring', 'locationName' => 'edgeLocation', ], 'State' => [ 'shape' => 'AttachmentState', 'location' => 'querystring', 'locationName' => 'state', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListAttachmentsResponse' => [ 'type' => 'structure', 'members' => [ 'Attachments' => [ 'shape' => 'AttachmentList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListConnectPeersRequest' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'querystring', 'locationName' => 'coreNetworkId', ], 'ConnectAttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'querystring', 'locationName' => 'connectAttachmentId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListConnectPeersResponse' => [ 'type' => 'structure', 'members' => [ 'ConnectPeers' => [ 'shape' => 'ConnectPeerSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCoreNetworkPolicyVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListCoreNetworkPolicyVersionsResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkPolicyVersions' => [ 'shape' => 'CoreNetworkPolicyVersionList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListCoreNetworksRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListCoreNetworksResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworks' => [ 'shape' => 'CoreNetworkSummaryList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListOrganizationServiceAccessStatusRequest' => [ 'type' => 'structure', 'members' => [ 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListOrganizationServiceAccessStatusResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationStatus' => [ 'shape' => 'OrganizationStatus', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListPeeringsRequest' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'querystring', 'locationName' => 'coreNetworkId', ], 'PeeringType' => [ 'shape' => 'PeeringType', 'location' => 'querystring', 'locationName' => 'peeringType', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', 'location' => 'querystring', 'locationName' => 'edgeLocation', ], 'State' => [ 'shape' => 'PeeringState', 'location' => 'querystring', 'locationName' => 'state', ], 'MaxResults' => [ 'shape' => 'MaxResults', 'location' => 'querystring', 'locationName' => 'maxResults', ], 'NextToken' => [ 'shape' => 'NextToken', 'location' => 'querystring', 'locationName' => 'nextToken', ], ], ], 'ListPeeringsResponse' => [ 'type' => 'structure', 'members' => [ 'Peerings' => [ 'shape' => 'PeeringList', ], 'NextToken' => [ 'shape' => 'NextToken', ], ], ], 'ListTagsForResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'ListTagsForResourceResponse' => [ 'type' => 'structure', 'members' => [ 'TagList' => [ 'shape' => 'TagList', ], ], ], 'Location' => [ 'type' => 'structure', 'members' => [ 'Address' => [ 'shape' => 'ConstrainedString', ], 'Latitude' => [ 'shape' => 'ConstrainedString', ], 'Longitude' => [ 'shape' => 'ConstrainedString', ], ], 'sensitive' => true, ], 'Long' => [ 'type' => 'long', ], 'MaxResults' => [ 'type' => 'integer', 'max' => 500, 'min' => 1, ], 'NetworkFunctionGroup' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'ConstrainedString', ], ], ], 'NetworkFunctionGroupList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkFunctionGroup', ], ], 'NetworkFunctionGroupName' => [ 'type' => 'string', 'pattern' => '[\\s\\S]*', ], 'NetworkResource' => [ 'type' => 'structure', 'members' => [ 'RegisteredGatewayArn' => [ 'shape' => 'ResourceArn', ], 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'AwsRegion' => [ 'shape' => 'ExternalRegionCode', ], 'AccountId' => [ 'shape' => 'AWSAccountId', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', ], 'ResourceId' => [ 'shape' => 'ConstrainedString', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Definition' => [ 'shape' => 'ConstrainedString', ], 'DefinitionTimestamp' => [ 'shape' => 'DateTime', ], 'Tags' => [ 'shape' => 'TagList', ], 'Metadata' => [ 'shape' => 'NetworkResourceMetadataMap', ], ], ], 'NetworkResourceCount' => [ 'type' => 'structure', 'members' => [ 'ResourceType' => [ 'shape' => 'ConstrainedString', ], 'Count' => [ 'shape' => 'Integer', ], ], ], 'NetworkResourceCountList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkResourceCount', ], ], 'NetworkResourceList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkResource', ], ], 'NetworkResourceMetadataMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ConstrainedString', ], 'value' => [ 'shape' => 'ConstrainedString', ], ], 'NetworkResourceSummary' => [ 'type' => 'structure', 'members' => [ 'RegisteredGatewayArn' => [ 'shape' => 'ResourceArn', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', ], 'Definition' => [ 'shape' => 'ConstrainedString', ], 'NameTag' => [ 'shape' => 'ConstrainedString', ], 'IsMiddlebox' => [ 'shape' => 'Boolean', ], ], ], 'NetworkRoute' => [ 'type' => 'structure', 'members' => [ 'DestinationCidrBlock' => [ 'shape' => 'ConstrainedString', ], 'Destinations' => [ 'shape' => 'NetworkRouteDestinationList', ], 'PrefixListId' => [ 'shape' => 'ConstrainedString', ], 'State' => [ 'shape' => 'RouteState', ], 'Type' => [ 'shape' => 'RouteType', ], ], ], 'NetworkRouteDestination' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkAttachmentId' => [ 'shape' => 'AttachmentId', ], 'TransitGatewayAttachmentId' => [ 'shape' => 'TransitGatewayAttachmentId', ], 'SegmentName' => [ 'shape' => 'ConstrainedString', ], 'NetworkFunctionGroupName' => [ 'shape' => 'ConstrainedString', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', ], 'ResourceId' => [ 'shape' => 'ConstrainedString', ], ], ], 'NetworkRouteDestinationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkRouteDestination', ], ], 'NetworkRouteList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkRoute', ], ], 'NetworkTelemetry' => [ 'type' => 'structure', 'members' => [ 'RegisteredGatewayArn' => [ 'shape' => 'ResourceArn', ], 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'AwsRegion' => [ 'shape' => 'ExternalRegionCode', ], 'AccountId' => [ 'shape' => 'AWSAccountId', ], 'ResourceType' => [ 'shape' => 'ConstrainedString', ], 'ResourceId' => [ 'shape' => 'ConstrainedString', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Address' => [ 'shape' => 'ConstrainedString', ], 'Health' => [ 'shape' => 'ConnectionHealth', ], ], ], 'NetworkTelemetryList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NetworkTelemetry', ], ], 'NextToken' => [ 'type' => 'string', 'max' => 2048, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'OrganizationAwsServiceAccessStatus' => [ 'type' => 'string', 'max' => 50, 'min' => 0, ], 'OrganizationId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '^o-([0-9a-f]{8,17})$', ], 'OrganizationStatus' => [ 'type' => 'structure', 'members' => [ 'OrganizationId' => [ 'shape' => 'OrganizationId', ], 'OrganizationAwsServiceAccessStatus' => [ 'shape' => 'OrganizationAwsServiceAccessStatus', ], 'SLRDeploymentStatus' => [ 'shape' => 'SLRDeploymentStatus', ], 'AccountStatusList' => [ 'shape' => 'AccountStatusList', ], ], ], 'PathComponent' => [ 'type' => 'structure', 'members' => [ 'Sequence' => [ 'shape' => 'Integer', ], 'Resource' => [ 'shape' => 'NetworkResourceSummary', ], 'DestinationCidrBlock' => [ 'shape' => 'ConstrainedString', ], ], ], 'PathComponentList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PathComponent', ], ], 'Peering' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', ], 'CoreNetworkArn' => [ 'shape' => 'CoreNetworkArn', ], 'PeeringId' => [ 'shape' => 'PeeringId', ], 'OwnerAccountId' => [ 'shape' => 'AWSAccountId', ], 'PeeringType' => [ 'shape' => 'PeeringType', ], 'State' => [ 'shape' => 'PeeringState', ], 'EdgeLocation' => [ 'shape' => 'ExternalRegionCode', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'LastModificationErrors' => [ 'shape' => 'PeeringErrorList', ], ], ], 'PeeringError' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'PeeringErrorCode', ], 'Message' => [ 'shape' => 'ServerSideString', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'RequestId' => [ 'shape' => 'ServerSideString', ], 'MissingPermissionsContext' => [ 'shape' => 'PermissionsErrorContext', ], ], ], 'PeeringErrorCode' => [ 'type' => 'string', 'enum' => [ 'TRANSIT_GATEWAY_NOT_FOUND', 'TRANSIT_GATEWAY_PEERS_LIMIT_EXCEEDED', 'MISSING_PERMISSIONS', 'INTERNAL_ERROR', 'EDGE_LOCATION_PEER_DUPLICATE', 'INVALID_TRANSIT_GATEWAY_STATE', ], ], 'PeeringErrorList' => [ 'type' => 'list', 'member' => [ 'shape' => 'PeeringError', ], 'max' => 20, 'min' => 0, ], 'PeeringId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '^peering-([0-9a-f]{8,17})$', ], 'PeeringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Peering', ], ], 'PeeringState' => [ 'type' => 'string', 'enum' => [ 'CREATING', 'FAILED', 'AVAILABLE', 'DELETING', ], ], 'PeeringType' => [ 'type' => 'string', 'enum' => [ 'TRANSIT_GATEWAY', ], ], 'PermissionsErrorContext' => [ 'type' => 'structure', 'members' => [ 'MissingPermission' => [ 'shape' => 'ServerSideString', ], ], ], 'ProposedNetworkFunctionGroupChange' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'AttachmentPolicyRuleNumber' => [ 'shape' => 'Integer', ], 'NetworkFunctionGroupName' => [ 'shape' => 'ConstrainedString', ], ], ], 'ProposedSegmentChange' => [ 'type' => 'structure', 'members' => [ 'Tags' => [ 'shape' => 'TagList', ], 'AttachmentPolicyRuleNumber' => [ 'shape' => 'Integer', ], 'SegmentName' => [ 'shape' => 'ConstrainedString', ], ], ], 'PutCoreNetworkPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'PolicyDocument', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyDocument' => [ 'shape' => 'CoreNetworkPolicyDocument', 'jsonvalue' => true, ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'LatestVersionId' => [ 'shape' => 'Integer', ], 'ClientToken' => [ 'shape' => 'ClientToken', 'idempotencyToken' => true, ], ], ], 'PutCoreNetworkPolicyResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkPolicy' => [ 'shape' => 'CoreNetworkPolicy', ], ], ], 'PutResourcePolicyRequest' => [ 'type' => 'structure', 'required' => [ 'PolicyDocument', 'ResourceArn', ], 'members' => [ 'PolicyDocument' => [ 'shape' => 'ResourcePolicyDocument', 'jsonvalue' => true, ], 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], ], ], 'PutResourcePolicyResponse' => [ 'type' => 'structure', 'members' => [], ], 'ReasonContextKey' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ReasonContextMap' => [ 'type' => 'map', 'key' => [ 'shape' => 'ReasonContextKey', ], 'value' => [ 'shape' => 'ReasonContextValue', ], ], 'ReasonContextValue' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'RegisterTransitGatewayRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'TransitGatewayArn', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'TransitGatewayArn' => [ 'shape' => 'TransitGatewayArn', ], ], ], 'RegisterTransitGatewayResponse' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayRegistration' => [ 'shape' => 'TransitGatewayRegistration', ], ], ], 'RejectAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], ], ], 'RejectAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], ], ], 'Relationship' => [ 'type' => 'structure', 'members' => [ 'From' => [ 'shape' => 'ConstrainedString', ], 'To' => [ 'shape' => 'ConstrainedString', ], ], ], 'RelationshipList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Relationship', ], ], 'ResourceArn' => [ 'type' => 'string', 'max' => 1500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ResourceNotFoundException' => [ 'type' => 'structure', 'required' => [ 'Message', 'ResourceId', 'ResourceType', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'ResourceId' => [ 'shape' => 'ServerSideString', ], 'ResourceType' => [ 'shape' => 'ServerSideString', ], 'Context' => [ 'shape' => 'ExceptionContextMap', ], ], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'ResourcePolicyDocument' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'RestoreCoreNetworkPolicyVersionRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', 'PolicyVersionId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'PolicyVersionId' => [ 'shape' => 'Integer', 'location' => 'uri', 'locationName' => 'policyVersionId', ], ], ], 'RestoreCoreNetworkPolicyVersionResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetworkPolicy' => [ 'shape' => 'CoreNetworkPolicy', ], ], ], 'RetryAfterSeconds' => [ 'type' => 'integer', ], 'RouteAnalysis' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'OwnerAccountId' => [ 'shape' => 'AWSAccountId', ], 'RouteAnalysisId' => [ 'shape' => 'ConstrainedString', ], 'StartTimestamp' => [ 'shape' => 'DateTime', ], 'Status' => [ 'shape' => 'RouteAnalysisStatus', ], 'Source' => [ 'shape' => 'RouteAnalysisEndpointOptions', ], 'Destination' => [ 'shape' => 'RouteAnalysisEndpointOptions', ], 'IncludeReturnPath' => [ 'shape' => 'Boolean', ], 'UseMiddleboxes' => [ 'shape' => 'Boolean', ], 'ForwardPath' => [ 'shape' => 'RouteAnalysisPath', ], 'ReturnPath' => [ 'shape' => 'RouteAnalysisPath', ], ], ], 'RouteAnalysisCompletion' => [ 'type' => 'structure', 'members' => [ 'ResultCode' => [ 'shape' => 'RouteAnalysisCompletionResultCode', ], 'ReasonCode' => [ 'shape' => 'RouteAnalysisCompletionReasonCode', ], 'ReasonContext' => [ 'shape' => 'ReasonContextMap', ], ], ], 'RouteAnalysisCompletionReasonCode' => [ 'type' => 'string', 'enum' => [ 'TRANSIT_GATEWAY_ATTACHMENT_NOT_FOUND', 'TRANSIT_GATEWAY_ATTACHMENT_NOT_IN_TRANSIT_GATEWAY', 'CYCLIC_PATH_DETECTED', 'TRANSIT_GATEWAY_ATTACHMENT_STABLE_ROUTE_TABLE_NOT_FOUND', 'ROUTE_NOT_FOUND', 'BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND', 'INACTIVE_ROUTE_FOR_DESTINATION_FOUND', 'TRANSIT_GATEWAY_ATTACHMENT_ATTACH_ARN_NO_MATCH', 'MAX_HOPS_EXCEEDED', 'POSSIBLE_MIDDLEBOX', 'NO_DESTINATION_ARN_PROVIDED', ], ], 'RouteAnalysisCompletionResultCode' => [ 'type' => 'string', 'enum' => [ 'CONNECTED', 'NOT_CONNECTED', ], ], 'RouteAnalysisEndpointOptions' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayAttachmentArn' => [ 'shape' => 'TransitGatewayAttachmentArn', ], 'TransitGatewayArn' => [ 'shape' => 'TransitGatewayArn', ], 'IpAddress' => [ 'shape' => 'IPAddress', ], ], ], 'RouteAnalysisEndpointOptionsSpecification' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayAttachmentArn' => [ 'shape' => 'TransitGatewayAttachmentArn', ], 'IpAddress' => [ 'shape' => 'IPAddress', ], ], ], 'RouteAnalysisPath' => [ 'type' => 'structure', 'members' => [ 'CompletionStatus' => [ 'shape' => 'RouteAnalysisCompletion', ], 'Path' => [ 'shape' => 'PathComponentList', ], ], ], 'RouteAnalysisStatus' => [ 'type' => 'string', 'enum' => [ 'RUNNING', 'COMPLETED', 'FAILED', ], ], 'RouteState' => [ 'type' => 'string', 'enum' => [ 'ACTIVE', 'BLACKHOLE', ], ], 'RouteStateList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RouteState', ], ], 'RouteTableIdentifier' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayRouteTableArn' => [ 'shape' => 'TransitGatewayRouteTableArn', ], 'CoreNetworkSegmentEdge' => [ 'shape' => 'CoreNetworkSegmentEdgeIdentifier', ], 'CoreNetworkNetworkFunctionGroup' => [ 'shape' => 'CoreNetworkNetworkFunctionGroupIdentifier', ], ], ], 'RouteTableType' => [ 'type' => 'string', 'enum' => [ 'TRANSIT_GATEWAY_ROUTE_TABLE', 'CORE_NETWORK_SEGMENT', 'NETWORK_FUNCTION_GROUP', ], ], 'RouteType' => [ 'type' => 'string', 'enum' => [ 'PROPAGATED', 'STATIC', ], ], 'RouteTypeList' => [ 'type' => 'list', 'member' => [ 'shape' => 'RouteType', ], ], 'SLRDeploymentStatus' => [ 'type' => 'string', 'max' => 50, 'min' => 0, ], 'SegmentActionServiceInsertion' => [ 'type' => 'string', 'enum' => [ 'send-via', 'send-to', ], ], 'SendViaMode' => [ 'type' => 'string', 'enum' => [ 'dual-hop', 'single-hop', ], ], 'ServerSideString' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ServiceInsertionAction' => [ 'type' => 'structure', 'members' => [ 'Action' => [ 'shape' => 'SegmentActionServiceInsertion', ], 'Mode' => [ 'shape' => 'SendViaMode', ], 'WhenSentTo' => [ 'shape' => 'WhenSentTo', ], 'Via' => [ 'shape' => 'Via', ], ], ], 'ServiceInsertionActionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServiceInsertionAction', ], ], 'ServiceInsertionSegments' => [ 'type' => 'structure', 'members' => [ 'SendVia' => [ 'shape' => 'ConstrainedStringList', ], 'SendTo' => [ 'shape' => 'ConstrainedStringList', ], ], ], 'ServiceQuotaExceededException' => [ 'type' => 'structure', 'required' => [ 'Message', 'LimitCode', 'ServiceCode', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'ResourceId' => [ 'shape' => 'ServerSideString', ], 'ResourceType' => [ 'shape' => 'ServerSideString', ], 'LimitCode' => [ 'shape' => 'ServerSideString', ], 'ServiceCode' => [ 'shape' => 'ServerSideString', ], ], 'error' => [ 'httpStatusCode' => 402, ], 'exception' => true, ], 'Site' => [ 'type' => 'structure', 'members' => [ 'SiteId' => [ 'shape' => 'SiteId', ], 'SiteArn' => [ 'shape' => 'SiteArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Location' => [ 'shape' => 'Location', ], 'CreatedAt' => [ 'shape' => 'DateTime', ], 'State' => [ 'shape' => 'SiteState', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'SiteArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'SiteId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'SiteIdList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SiteId', ], ], 'SiteList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Site', ], ], 'SiteState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'UPDATING', ], ], 'SiteToSiteVpnAttachment' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], 'VpnConnectionArn' => [ 'shape' => 'VpnConnectionArn', ], ], ], 'StartOrganizationServiceAccessUpdateRequest' => [ 'type' => 'structure', 'required' => [ 'Action', ], 'members' => [ 'Action' => [ 'shape' => 'Action', ], ], ], 'StartOrganizationServiceAccessUpdateResponse' => [ 'type' => 'structure', 'members' => [ 'OrganizationStatus' => [ 'shape' => 'OrganizationStatus', ], ], ], 'StartRouteAnalysisRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'Source', 'Destination', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'Source' => [ 'shape' => 'RouteAnalysisEndpointOptionsSpecification', ], 'Destination' => [ 'shape' => 'RouteAnalysisEndpointOptionsSpecification', ], 'IncludeReturnPath' => [ 'shape' => 'Boolean', ], 'UseMiddleboxes' => [ 'shape' => 'Boolean', ], ], ], 'StartRouteAnalysisResponse' => [ 'type' => 'structure', 'members' => [ 'RouteAnalysis' => [ 'shape' => 'RouteAnalysis', ], ], ], 'SubnetArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:subnet\\/subnet-[0-9a-f]{8,17}$|^$', ], 'SubnetArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'SubnetArn', ], ], 'Tag' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'TagKey', ], 'Value' => [ 'shape' => 'TagValue', ], ], ], 'TagKey' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'TagKeyList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TagKey', ], ], 'TagList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', ], ], 'TagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'Tags', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'Tags' => [ 'shape' => 'TagList', ], ], ], 'TagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'TagValue' => [ 'type' => 'string', 'max' => 10000000, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'ThrottlingException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'RetryAfterSeconds' => [ 'shape' => 'RetryAfterSeconds', 'location' => 'header', 'locationName' => 'Retry-After', ], ], 'error' => [ 'httpStatusCode' => 429, ], 'exception' => true, ], 'TransitGatewayArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'TransitGatewayArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransitGatewayArn', ], ], 'TransitGatewayAttachmentArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'TransitGatewayAttachmentId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'TransitGatewayConnectPeerArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'TransitGatewayConnectPeerArnList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransitGatewayConnectPeerArn', ], ], 'TransitGatewayConnectPeerAssociation' => [ 'type' => 'structure', 'members' => [ 'TransitGatewayConnectPeerArn' => [ 'shape' => 'TransitGatewayConnectPeerArn', ], 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'State' => [ 'shape' => 'TransitGatewayConnectPeerAssociationState', ], ], ], 'TransitGatewayConnectPeerAssociationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransitGatewayConnectPeerAssociation', ], ], 'TransitGatewayConnectPeerAssociationState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'DELETED', ], ], 'TransitGatewayPeering' => [ 'type' => 'structure', 'members' => [ 'Peering' => [ 'shape' => 'Peering', ], 'TransitGatewayArn' => [ 'shape' => 'TransitGatewayArn', ], 'TransitGatewayPeeringAttachmentId' => [ 'shape' => 'TransitGatewayPeeringAttachmentId', ], ], ], 'TransitGatewayPeeringAttachmentId' => [ 'type' => 'string', 'max' => 50, 'min' => 0, 'pattern' => '^tgw-attach-([0-9a-f]{8,17})$', ], 'TransitGatewayRegistration' => [ 'type' => 'structure', 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', ], 'TransitGatewayArn' => [ 'shape' => 'TransitGatewayArn', ], 'State' => [ 'shape' => 'TransitGatewayRegistrationStateReason', ], ], ], 'TransitGatewayRegistrationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TransitGatewayRegistration', ], ], 'TransitGatewayRegistrationState' => [ 'type' => 'string', 'enum' => [ 'PENDING', 'AVAILABLE', 'DELETING', 'DELETED', 'FAILED', ], ], 'TransitGatewayRegistrationStateReason' => [ 'type' => 'structure', 'members' => [ 'Code' => [ 'shape' => 'TransitGatewayRegistrationState', ], 'Message' => [ 'shape' => 'ConstrainedString', ], ], ], 'TransitGatewayRouteTableArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '[\\s\\S]*', ], 'TransitGatewayRouteTableAttachment' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], 'PeeringId' => [ 'shape' => 'PeeringId', ], 'TransitGatewayRouteTableArn' => [ 'shape' => 'TransitGatewayRouteTableArn', ], ], ], 'TunnelProtocol' => [ 'type' => 'string', 'enum' => [ 'GRE', 'NO_ENCAP', ], ], 'UntagResourceRequest' => [ 'type' => 'structure', 'required' => [ 'ResourceArn', 'TagKeys', ], 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'TagKeys' => [ 'shape' => 'TagKeyList', 'location' => 'querystring', 'locationName' => 'tagKeys', ], ], ], 'UntagResourceResponse' => [ 'type' => 'structure', 'members' => [], ], 'UpdateConnectionRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'ConnectionId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ConnectionId' => [ 'shape' => 'ConnectionId', 'location' => 'uri', 'locationName' => 'connectionId', ], 'LinkId' => [ 'shape' => 'LinkId', ], 'ConnectedLinkId' => [ 'shape' => 'LinkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], ], ], 'UpdateConnectionResponse' => [ 'type' => 'structure', 'members' => [ 'Connection' => [ 'shape' => 'Connection', ], ], ], 'UpdateCoreNetworkRequest' => [ 'type' => 'structure', 'required' => [ 'CoreNetworkId', ], 'members' => [ 'CoreNetworkId' => [ 'shape' => 'CoreNetworkId', 'location' => 'uri', 'locationName' => 'coreNetworkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], ], ], 'UpdateCoreNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'CoreNetwork' => [ 'shape' => 'CoreNetwork', ], ], ], 'UpdateDeviceRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'DeviceId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'DeviceId' => [ 'shape' => 'DeviceId', 'location' => 'uri', 'locationName' => 'deviceId', ], 'AWSLocation' => [ 'shape' => 'AWSLocation', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Type' => [ 'shape' => 'ConstrainedString', ], 'Vendor' => [ 'shape' => 'ConstrainedString', ], 'Model' => [ 'shape' => 'ConstrainedString', ], 'SerialNumber' => [ 'shape' => 'ConstrainedString', ], 'Location' => [ 'shape' => 'Location', ], 'SiteId' => [ 'shape' => 'SiteId', ], ], ], 'UpdateDeviceResponse' => [ 'type' => 'structure', 'members' => [ 'Device' => [ 'shape' => 'Device', ], ], ], 'UpdateDirectConnectGatewayAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], 'EdgeLocations' => [ 'shape' => 'ExternalRegionCodeList', ], ], ], 'UpdateDirectConnectGatewayAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'DirectConnectGatewayAttachment' => [ 'shape' => 'DirectConnectGatewayAttachment', ], ], ], 'UpdateGlobalNetworkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], ], ], 'UpdateGlobalNetworkResponse' => [ 'type' => 'structure', 'members' => [ 'GlobalNetwork' => [ 'shape' => 'GlobalNetwork', ], ], ], 'UpdateLinkRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'LinkId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'LinkId' => [ 'shape' => 'LinkId', 'location' => 'uri', 'locationName' => 'linkId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Type' => [ 'shape' => 'ConstrainedString', ], 'Bandwidth' => [ 'shape' => 'Bandwidth', ], 'Provider' => [ 'shape' => 'ConstrainedString', ], ], ], 'UpdateLinkResponse' => [ 'type' => 'structure', 'members' => [ 'Link' => [ 'shape' => 'Link', ], ], ], 'UpdateNetworkResourceMetadataRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'ResourceArn', 'Metadata', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'ResourceArn' => [ 'shape' => 'ResourceArn', 'location' => 'uri', 'locationName' => 'resourceArn', ], 'Metadata' => [ 'shape' => 'NetworkResourceMetadataMap', ], ], ], 'UpdateNetworkResourceMetadataResponse' => [ 'type' => 'structure', 'members' => [ 'ResourceArn' => [ 'shape' => 'ResourceArn', ], 'Metadata' => [ 'shape' => 'NetworkResourceMetadataMap', ], ], ], 'UpdateSiteRequest' => [ 'type' => 'structure', 'required' => [ 'GlobalNetworkId', 'SiteId', ], 'members' => [ 'GlobalNetworkId' => [ 'shape' => 'GlobalNetworkId', 'location' => 'uri', 'locationName' => 'globalNetworkId', ], 'SiteId' => [ 'shape' => 'SiteId', 'location' => 'uri', 'locationName' => 'siteId', ], 'Description' => [ 'shape' => 'ConstrainedString', ], 'Location' => [ 'shape' => 'Location', ], ], ], 'UpdateSiteResponse' => [ 'type' => 'structure', 'members' => [ 'Site' => [ 'shape' => 'Site', ], ], ], 'UpdateVpcAttachmentRequest' => [ 'type' => 'structure', 'required' => [ 'AttachmentId', ], 'members' => [ 'AttachmentId' => [ 'shape' => 'AttachmentId', 'location' => 'uri', 'locationName' => 'attachmentId', ], 'AddSubnetArns' => [ 'shape' => 'SubnetArnList', ], 'RemoveSubnetArns' => [ 'shape' => 'SubnetArnList', ], 'Options' => [ 'shape' => 'VpcOptions', ], ], ], 'UpdateVpcAttachmentResponse' => [ 'type' => 'structure', 'members' => [ 'VpcAttachment' => [ 'shape' => 'VpcAttachment', ], ], ], 'ValidationException' => [ 'type' => 'structure', 'required' => [ 'Message', ], 'members' => [ 'Message' => [ 'shape' => 'ServerSideString', ], 'Reason' => [ 'shape' => 'ValidationExceptionReason', ], 'Fields' => [ 'shape' => 'ValidationExceptionFieldList', ], ], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'ValidationExceptionField' => [ 'type' => 'structure', 'required' => [ 'Name', 'Message', ], 'members' => [ 'Name' => [ 'shape' => 'ServerSideString', ], 'Message' => [ 'shape' => 'ServerSideString', ], ], ], 'ValidationExceptionFieldList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ValidationExceptionField', ], ], 'ValidationExceptionReason' => [ 'type' => 'string', 'enum' => [ 'UnknownOperation', 'CannotParse', 'FieldValidationFailed', 'Other', ], ], 'Via' => [ 'type' => 'structure', 'members' => [ 'NetworkFunctionGroups' => [ 'shape' => 'NetworkFunctionGroupList', ], 'WithEdgeOverrides' => [ 'shape' => 'WithEdgeOverridesList', ], ], ], 'VpcArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:vpc\\/vpc-[0-9a-f]{8,17}$', ], 'VpcAttachment' => [ 'type' => 'structure', 'members' => [ 'Attachment' => [ 'shape' => 'Attachment', ], 'SubnetArns' => [ 'shape' => 'SubnetArnList', ], 'Options' => [ 'shape' => 'VpcOptions', ], ], ], 'VpcOptions' => [ 'type' => 'structure', 'members' => [ 'Ipv6Support' => [ 'shape' => 'Boolean', ], 'ApplianceModeSupport' => [ 'shape' => 'Boolean', ], ], ], 'VpnConnectionArn' => [ 'type' => 'string', 'max' => 500, 'min' => 0, 'pattern' => '^arn:[^:]{1,63}:ec2:[^:]{0,63}:[^:]{0,63}:vpn-connection\\/vpn-[0-9a-f]{8,17}$', ], 'WhenSentTo' => [ 'type' => 'structure', 'members' => [ 'WhenSentToSegmentsList' => [ 'shape' => 'WhenSentToSegmentsList', ], ], ], 'WhenSentToSegmentsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ConstrainedString', ], ], 'WithEdgeOverridesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'EdgeOverride', ], ], ],]; diff --git a/src/data/networkmanager/2019-07-05/docs-2.json b/src/data/networkmanager/2019-07-05/docs-2.json index 186415f5fe..5f9c47aab1 100644 --- a/src/data/networkmanager/2019-07-05/docs-2.json +++ b/src/data/networkmanager/2019-07-05/docs-2.json @@ -12,6 +12,7 @@ "CreateConnection": "

Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.

", "CreateCoreNetwork": "

Creates a core network as part of your global network, and optionally, with a core network policy.

", "CreateDevice": "

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.

", + "CreateDirectConnectGatewayAttachment": "

Creates an Amazon Web Services Direct Connect gateway attachment

", "CreateGlobalNetwork": "

Creates a new, empty global network.

", "CreateLink": "

Creates a new link for a specified site.

", "CreateSite": "

Creates a new site in a global network.

", @@ -47,6 +48,7 @@ "GetCoreNetworkPolicy": "

Returns details about a core network policy. You can get details about your current live policy or any previous policy version.

", "GetCustomerGatewayAssociations": "

Gets the association information for customer gateways that are associated with devices and links in your global network.

", "GetDevices": "

Gets information about one or more of your devices in a global network.

", + "GetDirectConnectGatewayAttachment": "

Returns information about a specific Amazon Web Services Direct Connect gateway attachment.

", "GetLinkAssociations": "

Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.

", "GetLinks": "

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.

", "GetNetworkResourceCounts": "

Gets the count of network resources, by resource type, for the specified global network.

", @@ -82,6 +84,7 @@ "UpdateConnection": "

Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.

", "UpdateCoreNetwork": "

Updates the description of a core network.

", "UpdateDevice": "

Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.

", + "UpdateDirectConnectGatewayAttachment": "

Updates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment.

", "UpdateGlobalNetwork": "

Updates an existing global network. To remove information for any of the parameters, specify an empty string.

", "UpdateLink": "

Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.

", "UpdateNetworkResourceMetadata": "

Updates the resource metadata for the specified global network.

", @@ -197,6 +200,7 @@ "AttachmentList$member": null, "ConnectAttachment$Attachment": "

The attachment details.

", "DeleteAttachmentResponse$Attachment": "

Information about the deleted attachment.

", + "DirectConnectGatewayAttachment$Attachment": null, "RejectAttachmentResponse$Attachment": "

Describes the rejected attachment request.

", "SiteToSiteVpnAttachment$Attachment": "

Provides details about a site-to-site VPN attachment.

", "TransitGatewayRouteTableAttachment$Attachment": null, @@ -234,12 +238,14 @@ "CreateConnectPeerRequest$ConnectAttachmentId": "

The ID of the connection attachment.

", "DeleteAttachmentRequest$AttachmentId": "

The ID of the attachment to delete.

", "GetConnectAttachmentRequest$AttachmentId": "

The ID of the attachment.

", + "GetDirectConnectGatewayAttachmentRequest$AttachmentId": "

The ID of the Direct Connect gateway attachment that you want to see details about.

", "GetSiteToSiteVpnAttachmentRequest$AttachmentId": "

The ID of the attachment.

", "GetTransitGatewayRouteTableAttachmentRequest$AttachmentId": "

The ID of the transit gateway route table attachment.

", "GetVpcAttachmentRequest$AttachmentId": "

The ID of the attachment.

", "ListConnectPeersRequest$ConnectAttachmentId": "

The ID of the attachment.

", "NetworkRouteDestination$CoreNetworkAttachmentId": "

The ID of a core network attachment.

", "RejectAttachmentRequest$AttachmentId": "

The ID of the attachment.

", + "UpdateDirectConnectGatewayAttachmentRequest$AttachmentId": "

The ID of the Direct Connect gateway attachment for the updated edge locations.

", "UpdateVpcAttachmentRequest$AttachmentId": "

The ID of the attachment.

" } }, @@ -322,6 +328,7 @@ "CreateConnectAttachmentRequest$ClientToken": "

The client token associated with the request.

", "CreateConnectPeerRequest$ClientToken": "

The client token associated with the request.

", "CreateCoreNetworkRequest$ClientToken": "

The client token associated with a core network request.

", + "CreateDirectConnectGatewayAttachmentRequest$ClientToken": "

client token

", "CreateSiteToSiteVpnAttachmentRequest$ClientToken": "

The client token associated with the request.

", "CreateTransitGatewayPeeringRequest$ClientToken": "

The client token associated with the request.

", "CreateTransitGatewayRouteTableAttachmentRequest$ClientToken": "

The client token associated with the request.

", @@ -709,6 +716,7 @@ "CoreNetworkSegmentEdgeIdentifier$CoreNetworkId": "

The ID of a core network.

", "CoreNetworkSummary$CoreNetworkId": "

The ID of a core network.

", "CreateConnectAttachmentRequest$CoreNetworkId": "

The ID of a core network where you want to create the attachment.

", + "CreateDirectConnectGatewayAttachmentRequest$CoreNetworkId": "

The ID of the Cloud WAN core network that the Direct Connect gateway attachment should be attached to.

", "CreateSiteToSiteVpnAttachmentRequest$CoreNetworkId": "

The ID of a core network where you're creating a site-to-site VPN attachment.

", "CreateTransitGatewayPeeringRequest$CoreNetworkId": "

The ID of a core network.

", "CreateVpcAttachmentRequest$CoreNetworkId": "

The ID of a core network for the VPC attachment.

", @@ -895,6 +903,16 @@ "refs": { } }, + "CreateDirectConnectGatewayAttachmentRequest": { + "base": null, + "refs": { + } + }, + "CreateDirectConnectGatewayAttachmentResponse": { + "base": null, + "refs": { + } + }, "CreateGlobalNetworkRequest": { "base": null, "refs": { @@ -1210,6 +1228,21 @@ "Device$State": "

The device state.

" } }, + "DirectConnectGatewayArn": { + "base": null, + "refs": { + "CreateDirectConnectGatewayAttachmentRequest$DirectConnectGatewayArn": "

The ARN of the Direct Connect gateway attachment.

", + "DirectConnectGatewayAttachment$DirectConnectGatewayArn": "

The Direct Connect gateway attachment ARN.

" + } + }, + "DirectConnectGatewayAttachment": { + "base": "

Describes a Direct Connect gateway attachment.

", + "refs": { + "CreateDirectConnectGatewayAttachmentResponse$DirectConnectGatewayAttachment": "

Describes the details of a CreateDirectConnectGatewayAttachment request.

", + "GetDirectConnectGatewayAttachmentResponse$DirectConnectGatewayAttachment": "

Shows details about the Direct Connect gateway attachment.

", + "UpdateDirectConnectGatewayAttachmentResponse$DirectConnectGatewayAttachment": "

Returns details of the Direct Connect gateway attachment with the updated edge locations.

" + } + }, "DisassociateConnectPeerRequest": { "base": null, "refs": { @@ -1299,7 +1332,7 @@ "ExternalRegionCode": { "base": null, "refs": { - "Attachment$EdgeLocation": "

The Region where the edge is located.

", + "Attachment$EdgeLocation": "

The Region where the edge is located. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.

", "ConnectPeer$EdgeLocation": "

The Connect peer Regions where edges are located.

", "ConnectPeerSummary$EdgeLocation": "

The Region where the edge is located.

", "CoreNetworkChangeEventValues$EdgeLocation": "

The edge location for the core network change event.

", @@ -1322,9 +1355,12 @@ "ExternalRegionCodeList": { "base": null, "refs": { + "Attachment$EdgeLocations": "

The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.

", "CoreNetworkChangeValues$EdgeLocations": "

The Regions where edges are located in a core network.

", "CoreNetworkNetworkFunctionGroup$EdgeLocations": "

The core network edge locations.

", - "CoreNetworkSegment$EdgeLocations": "

The Regions where the edges are located.

" + "CoreNetworkSegment$EdgeLocations": "

The Regions where the edges are located.

", + "CreateDirectConnectGatewayAttachmentRequest$EdgeLocations": "

One or more core network edge locations that the Direct Connect gateway attachment is associated with.

", + "UpdateDirectConnectGatewayAttachmentRequest$EdgeLocations": "

One or more edge locations to update for the Direct Connect gateway attachment. The updated array of edge locations overwrites the previous array of locations. EdgeLocations is only used for Direct Connect gateway attachments. Do

" } }, "FilterMap": { @@ -1451,6 +1487,16 @@ "refs": { } }, + "GetDirectConnectGatewayAttachmentRequest": { + "base": null, + "refs": { + } + }, + "GetDirectConnectGatewayAttachmentResponse": { + "base": null, + "refs": { + } + }, "GetLinkAssociationsRequest": { "base": null, "refs": { @@ -2609,6 +2655,7 @@ "CreateConnectionRequest$Tags": "

The tags to apply to the resource during creation.

", "CreateCoreNetworkRequest$Tags": "

Key-value tags associated with a core network request.

", "CreateDeviceRequest$Tags": "

The tags to apply to the resource during creation.

", + "CreateDirectConnectGatewayAttachmentRequest$Tags": "

The key value tags to apply to the Direct Connect gateway attachment during creation.

", "CreateGlobalNetworkRequest$Tags": "

The tags to apply to the resource during creation.

", "CreateLinkRequest$Tags": "

The tags to apply to the resource during creation.

", "CreateSiteRequest$Tags": "

The tags to apply to the resource during creation.

", @@ -2816,6 +2863,16 @@ "refs": { } }, + "UpdateDirectConnectGatewayAttachmentRequest": { + "base": null, + "refs": { + } + }, + "UpdateDirectConnectGatewayAttachmentResponse": { + "base": null, + "refs": { + } + }, "UpdateGlobalNetworkRequest": { "base": null, "refs": { diff --git a/src/data/networkmanager/2019-07-05/docs-2.json.php b/src/data/networkmanager/2019-07-05/docs-2.json.php index d17c1d3d92..0ebee84f2d 100644 --- a/src/data/networkmanager/2019-07-05/docs-2.json.php +++ b/src/data/networkmanager/2019-07-05/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.

', 'operations' => [ 'AcceptAttachment' => '

Accepts a core network attachment request.

Once the attachment request is accepted by a core network owner, the attachment is created and connected to a core network.

', 'AssociateConnectPeer' => '

Associates a core network Connect peer 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 core network Connect peers that have been created on a core network Connect attachment on a core network.

', 'AssociateCustomerGateway' => '

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 or core network registered in your global network. When you register a transit gateway or core network, 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' => '

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.

', 'AssociateTransitGatewayConnectPeer' => '

Associates a transit gateway Connect peer 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 transit gateway Connect peers that have been created on a transit gateway that\'s registered in your global network.

You cannot associate a transit gateway Connect peer with more than one device and link.

', 'CreateConnectAttachment' => '

Creates a core network Connect attachment from a specified core network attachment.

A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.

', 'CreateConnectPeer' => '

Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

', 'CreateConnection' => '

Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.

', 'CreateCoreNetwork' => '

Creates a core network as part of your global network, and optionally, with a core network policy.

', 'CreateDevice' => '

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' => '

Creates a new, empty global network.

', 'CreateLink' => '

Creates a new link for a specified site.

', 'CreateSite' => '

Creates a new site in a global network.

', 'CreateSiteToSiteVpnAttachment' => '

Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.

', 'CreateTransitGatewayPeering' => '

Creates a transit gateway peering connection.

', 'CreateTransitGatewayRouteTableAttachment' => '

Creates a transit gateway route table attachment.

', 'CreateVpcAttachment' => '

Creates a VPC attachment on an edge location of a core network.

', 'DeleteAttachment' => '

Deletes an attachment. Supports all attachment types.

', 'DeleteConnectPeer' => '

Deletes a Connect peer.

', 'DeleteConnection' => '

Deletes the specified connection in your global network.

', 'DeleteCoreNetwork' => '

Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.

', 'DeleteCoreNetworkPolicyVersion' => '

Deletes a policy version from a core network. You can\'t delete the current LIVE policy.

', 'DeleteDevice' => '

Deletes an existing device. You must first disassociate the device from any links and customer gateways.

', 'DeleteGlobalNetwork' => '

Deletes an existing global network. You must first delete all global network objects (devices, links, and sites), deregister all transit gateways, and delete any core networks.

', 'DeleteLink' => '

Deletes an existing link. You must first disassociate the link from any devices and customer gateways.

', 'DeletePeering' => '

Deletes an existing peering connection.

', 'DeleteResourcePolicy' => '

Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.

', 'DeleteSite' => '

Deletes an existing site. The site cannot be associated with any device or link.

', 'DeregisterTransitGateway' => '

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' => '

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.

', 'DisassociateConnectPeer' => '

Disassociates a core network Connect peer from a device and a link.

', 'DisassociateCustomerGateway' => '

Disassociates a customer gateway from a device and a link.

', 'DisassociateLink' => '

Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.

', 'DisassociateTransitGatewayConnectPeer' => '

Disassociates a transit gateway Connect peer from a device and link.

', 'ExecuteCoreNetworkChangeSet' => '

Executes a change set on your core network. Deploys changes globally based on the policy submitted..

', 'GetConnectAttachment' => '

Returns information about a core network Connect attachment.

', 'GetConnectPeer' => '

Returns information about a core network Connect peer.

', 'GetConnectPeerAssociations' => '

Returns information about a core network Connect peer associations.

', 'GetConnections' => '

Gets information about one or more of your connections in a global network.

', 'GetCoreNetwork' => '

Returns information about the LIVE policy for a core network.

', 'GetCoreNetworkChangeEvents' => '

Returns information about a core network change event.

', 'GetCoreNetworkChangeSet' => '

Returns a change set between the LIVE core network policy and a submitted policy.

', 'GetCoreNetworkPolicy' => '

Returns details about a core network policy. You can get details about your current live policy or any previous policy version.

', 'GetCustomerGatewayAssociations' => '

Gets the association information for customer gateways that are associated with devices and links in your global network.

', 'GetDevices' => '

Gets information about one or more of your devices in a global network.

', 'GetLinkAssociations' => '

Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.

', 'GetLinks' => '

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.

', 'GetNetworkResourceCounts' => '

Gets the count of network resources, by resource type, for the specified global network.

', 'GetNetworkResourceRelationships' => '

Gets the network resource relationships for the specified global network.

', 'GetNetworkResources' => '

Describes the network resources for the specified global network.

The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.

', 'GetNetworkRoutes' => '

Gets the network routes of the specified global network.

', 'GetNetworkTelemetry' => '

Gets the network telemetry of the specified global network.

', 'GetResourcePolicy' => '

Returns information about a resource policy.

', 'GetRouteAnalysis' => '

Gets information about the specified route analysis.

', 'GetSiteToSiteVpnAttachment' => '

Returns information about a site-to-site VPN attachment.

', 'GetSites' => '

Gets information about one or more of your sites in a global network.

', 'GetTransitGatewayConnectPeerAssociations' => '

Gets information about one or more of your transit gateway Connect peer associations in a global network.

', 'GetTransitGatewayPeering' => '

Returns information about a transit gateway peer.

', 'GetTransitGatewayRegistrations' => '

Gets information about the transit gateway registrations in a specified global network.

', 'GetTransitGatewayRouteTableAttachment' => '

Returns information about a transit gateway route table attachment.

', 'GetVpcAttachment' => '

Returns information about a VPC attachment.

', 'ListAttachments' => '

Returns a list of core network attachments.

', 'ListConnectPeers' => '

Returns a list of core network Connect peers.

', 'ListCoreNetworkPolicyVersions' => '

Returns a list of core network policy versions.

', 'ListCoreNetworks' => '

Returns a list of owned and shared core networks.

', 'ListOrganizationServiceAccessStatus' => '

Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization.

', 'ListPeerings' => '

Lists the peerings for a core network.

', 'ListTagsForResource' => '

Lists the tags for a specified resource.

', 'PutCoreNetworkPolicy' => '

Creates a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and the submitted policy.

', 'PutResourcePolicy' => '

Creates or updates a resource policy.

', 'RegisterTransitGateway' => '

Registers a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see Region Availability in the Amazon Web Services Transit Gateways for Global Networks User Guide. The transit gateway can be in any of the supported Amazon Web Services Regions, but it must be owned by the same Amazon Web Services account that owns the global network. You cannot register a transit gateway in more than one global network.

', 'RejectAttachment' => '

Rejects a core network attachment request.

', 'RestoreCoreNetworkPolicyVersion' => '

Restores a previous policy version as a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and restored policy.

', 'StartOrganizationServiceAccessUpdate' => '

Enables the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.

', 'StartRouteAnalysis' => '

Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer.

', 'TagResource' => '

Tags a specified resource.

', 'UntagResource' => '

Removes tags from a specified resource.

', 'UpdateConnection' => '

Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.

', 'UpdateCoreNetwork' => '

Updates the description of a core network.

', 'UpdateDevice' => '

Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.

', 'UpdateGlobalNetwork' => '

Updates an existing global network. To remove information for any of the parameters, specify an empty string.

', 'UpdateLink' => '

Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.

', 'UpdateNetworkResourceMetadata' => '

Updates the resource metadata for the specified global network.

', 'UpdateSite' => '

Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.

', 'UpdateVpcAttachment' => '

Updates a VPC attachment.

', ], 'shapes' => [ 'AWSAccountId' => [ 'base' => NULL, 'refs' => [ 'Attachment$OwnerAccountId' => '

The ID of the attachment account owner.

', 'CoreNetworkSummary$OwnerAccountId' => '

The ID of the account owner.

', 'GetNetworkResourceRelationshipsRequest$AccountId' => '

The Amazon Web Services account ID.

', 'GetNetworkResourcesRequest$AccountId' => '

The Amazon Web Services account ID.

', 'GetNetworkTelemetryRequest$AccountId' => '

The Amazon Web Services account ID.

', 'NetworkResource$AccountId' => '

The Amazon Web Services account ID.

', 'NetworkTelemetry$AccountId' => '

The Amazon Web Services account ID.

', 'Peering$OwnerAccountId' => '

The ID of the account owner.

', 'RouteAnalysis$OwnerAccountId' => '

The ID of the AWS account that created the route analysis.

', ], ], 'AWSLocation' => [ 'base' => '

Specifies a location in Amazon Web Services.

', 'refs' => [ 'CreateDeviceRequest$AWSLocation' => '

The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

', 'Device$AWSLocation' => '

The Amazon Web Services location of the device.

', 'UpdateDeviceRequest$AWSLocation' => '

The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

', ], ], 'AcceptAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'AcceptAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'AccessDeniedException' => [ 'base' => '

You do not have sufficient access to perform this action.

', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'AccountStatus$AccountId' => '

The ID of an account within the Amazon Web Services Organization.

', ], ], 'AccountStatus' => [ 'base' => '

Describes the current status of an account within an Amazon Web Services Organization, including service-linked roles (SLRs).

', 'refs' => [ 'AccountStatusList$member' => NULL, ], ], 'AccountStatusList' => [ 'base' => NULL, 'refs' => [ 'OrganizationStatus$AccountStatusList' => '

The current service-linked role (SLR) deployment status for an Amazon Web Services Organization\'s accounts. This will be either SUCCEEDED or IN_PROGRESS.

', ], ], 'Action' => [ 'base' => NULL, 'refs' => [ 'StartOrganizationServiceAccessUpdateRequest$Action' => '

The action to take for the update request. This can be either ENABLE or DISABLE.

', ], ], 'AssociateConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateCustomerGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateCustomerGatewayResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateLinkRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateLinkResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateTransitGatewayConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateTransitGatewayConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'Attachment' => [ 'base' => '

Describes a core network attachment.

', 'refs' => [ 'AcceptAttachmentResponse$Attachment' => '

The response to the attachment request.

', 'AttachmentList$member' => NULL, 'ConnectAttachment$Attachment' => '

The attachment details.

', 'DeleteAttachmentResponse$Attachment' => '

Information about the deleted attachment.

', 'RejectAttachmentResponse$Attachment' => '

Describes the rejected attachment request.

', 'SiteToSiteVpnAttachment$Attachment' => '

Provides details about a site-to-site VPN attachment.

', 'TransitGatewayRouteTableAttachment$Attachment' => NULL, 'VpcAttachment$Attachment' => '

Provides details about the VPC attachment.

', ], ], 'AttachmentError' => [ 'base' => '

Describes the error associated with an attachment request.

', 'refs' => [ 'AttachmentErrorList$member' => NULL, ], ], 'AttachmentErrorCode' => [ 'base' => NULL, 'refs' => [ 'AttachmentError$Code' => '

The error code for the attachment request.

', ], ], 'AttachmentErrorList' => [ 'base' => NULL, 'refs' => [ 'Attachment$LastModificationErrors' => '

Describes the error associated with the attachment request.

', ], ], 'AttachmentId' => [ 'base' => NULL, 'refs' => [ 'AcceptAttachmentRequest$AttachmentId' => '

The ID of the attachment.

', 'Attachment$AttachmentId' => '

The ID of the attachment.

', 'ConnectAttachment$TransportAttachmentId' => '

The ID of the transport attachment.

', 'ConnectPeer$ConnectAttachmentId' => '

The ID of the attachment to connect.

', 'ConnectPeerSummary$ConnectAttachmentId' => '

The ID of a Connect peer attachment.

', 'CoreNetworkChangeEventValues$AttachmentId' => '

The ID of the attachment if the change event is associated with an attachment.

', 'CreateConnectAttachmentRequest$TransportAttachmentId' => '

The ID of the attachment between the two connections.

', 'CreateConnectPeerRequest$ConnectAttachmentId' => '

The ID of the connection attachment.

', 'DeleteAttachmentRequest$AttachmentId' => '

The ID of the attachment to delete.

', 'GetConnectAttachmentRequest$AttachmentId' => '

The ID of the attachment.

', 'GetSiteToSiteVpnAttachmentRequest$AttachmentId' => '

The ID of the attachment.

', 'GetTransitGatewayRouteTableAttachmentRequest$AttachmentId' => '

The ID of the transit gateway route table attachment.

', 'GetVpcAttachmentRequest$AttachmentId' => '

The ID of the attachment.

', 'ListConnectPeersRequest$ConnectAttachmentId' => '

The ID of the attachment.

', 'NetworkRouteDestination$CoreNetworkAttachmentId' => '

The ID of a core network attachment.

', 'RejectAttachmentRequest$AttachmentId' => '

The ID of the attachment.

', 'UpdateVpcAttachmentRequest$AttachmentId' => '

The ID of the attachment.

', ], ], 'AttachmentList' => [ 'base' => NULL, 'refs' => [ 'ListAttachmentsResponse$Attachments' => '

Describes the list of attachments.

', ], ], 'AttachmentState' => [ 'base' => NULL, 'refs' => [ 'Attachment$State' => '

The state of the attachment.

', 'ListAttachmentsRequest$State' => '

The state of the attachment.

', ], ], 'AttachmentType' => [ 'base' => NULL, 'refs' => [ 'Attachment$AttachmentType' => '

The type of attachment.

', 'ListAttachmentsRequest$AttachmentType' => '

The type of attachment.

', ], ], 'Bandwidth' => [ 'base' => '

Describes bandwidth information.

', 'refs' => [ 'CreateLinkRequest$Bandwidth' => '

The upload speed and download speed in Mbps.

', 'Link$Bandwidth' => '

The bandwidth for the link.

', 'UpdateLinkRequest$Bandwidth' => '

The upload and download speed in Mbps.

', ], ], 'BgpOptions' => [ 'base' => '

Describes the BGP options.

', 'refs' => [ 'CreateConnectPeerRequest$BgpOptions' => '

The Connect peer BGP options. This only applies only when the protocol is GRE.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'NetworkResourceSummary$IsMiddlebox' => '

Indicates whether this is a middlebox appliance.

', 'RouteAnalysis$IncludeReturnPath' => '

Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

', 'RouteAnalysis$UseMiddleboxes' => '

Indicates whether to include the location of middlebox appliances in the route analysis.

', 'StartRouteAnalysisRequest$IncludeReturnPath' => '

Indicates whether to analyze the return path. The default is false.

', 'StartRouteAnalysisRequest$UseMiddleboxes' => '

Indicates whether to include the location of middlebox appliances in the route analysis. The default is false.

', 'VpcOptions$Ipv6Support' => '

Indicates whether IPv6 is supported.

', 'VpcOptions$ApplianceModeSupport' => '

Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.

', ], ], 'ChangeAction' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkChange$Action' => '

The action to take for a core network.

', 'CoreNetworkChangeEvent$Action' => '

The action taken for the change event.

', ], ], 'ChangeSetState' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkPolicy$ChangeSetState' => '

The state of a core network policy.

', 'CoreNetworkPolicyVersion$ChangeSetState' => '

The status of the policy version change set.

', ], ], 'ChangeStatus' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkChangeEvent$Status' => '

The status of the core network change event.

', ], ], 'ChangeType' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkChange$Type' => '

The type of change.

', 'CoreNetworkChangeEvent$Type' => '

Describes the type of change event.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateConnectAttachmentRequest$ClientToken' => '

The client token associated with the request.

', 'CreateConnectPeerRequest$ClientToken' => '

The client token associated with the request.

', 'CreateCoreNetworkRequest$ClientToken' => '

The client token associated with a core network request.

', 'CreateSiteToSiteVpnAttachmentRequest$ClientToken' => '

The client token associated with the request.

', 'CreateTransitGatewayPeeringRequest$ClientToken' => '

The client token associated with the request.

', 'CreateTransitGatewayRouteTableAttachmentRequest$ClientToken' => '

The client token associated with the request.

', 'CreateVpcAttachmentRequest$ClientToken' => '

The client token associated with the request.

', 'PutCoreNetworkPolicyRequest$ClientToken' => '

The client token associated with the request.

', ], ], 'ConflictException' => [ 'base' => '

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

', 'refs' => [], ], 'ConnectAttachment' => [ 'base' => '

Describes a core network Connect attachment.

', 'refs' => [ 'CreateConnectAttachmentResponse$ConnectAttachment' => '

The response to a Connect attachment request.

', 'GetConnectAttachmentResponse$ConnectAttachment' => '

Details about the Connect attachment.

', ], ], 'ConnectAttachmentOptions' => [ 'base' => '

Describes a core network Connect attachment options.

', 'refs' => [ 'ConnectAttachment$Options' => '

Options for connecting an attachment.

', 'CreateConnectAttachmentRequest$Options' => '

Options for creating an attachment.

', ], ], 'ConnectPeer' => [ 'base' => '

Describes a core network Connect peer.

', 'refs' => [ 'CreateConnectPeerResponse$ConnectPeer' => '

The response to the request.

', 'DeleteConnectPeerResponse$ConnectPeer' => '

Information about the deleted Connect peer.

', 'GetConnectPeerResponse$ConnectPeer' => '

Returns information about a core network Connect peer.

', ], ], 'ConnectPeerAssociation' => [ 'base' => '

Describes a core network Connect peer association.

', 'refs' => [ 'AssociateConnectPeerResponse$ConnectPeerAssociation' => '

The response to the Connect peer request.

', 'ConnectPeerAssociationList$member' => NULL, 'DisassociateConnectPeerResponse$ConnectPeerAssociation' => '

Describes the Connect peer association.

', ], ], 'ConnectPeerAssociationList' => [ 'base' => NULL, 'refs' => [ 'GetConnectPeerAssociationsResponse$ConnectPeerAssociations' => '

Displays a list of Connect peer associations.

', ], ], 'ConnectPeerAssociationState' => [ 'base' => NULL, 'refs' => [ 'ConnectPeerAssociation$State' => '

The state of the Connect peer association.

', ], ], 'ConnectPeerBgpConfiguration' => [ 'base' => '

Describes a core network BGP configuration.

', 'refs' => [ 'ConnectPeerBgpConfigurationList$member' => NULL, ], ], 'ConnectPeerBgpConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ConnectPeerConfiguration$BgpConfigurations' => '

The Connect peer BGP configurations.

', ], ], 'ConnectPeerConfiguration' => [ 'base' => '

Describes a core network Connect peer configuration.

', 'refs' => [ 'ConnectPeer$Configuration' => '

The configuration of the Connect peer.

', ], ], 'ConnectPeerError' => [ 'base' => '

Describes an error associated with a Connect peer request

', 'refs' => [ 'ConnectPeerErrorList$member' => NULL, ], ], 'ConnectPeerErrorCode' => [ 'base' => NULL, 'refs' => [ 'ConnectPeerError$Code' => '

The error code for the Connect peer request.

', ], ], 'ConnectPeerErrorList' => [ 'base' => NULL, 'refs' => [ 'ConnectPeer$LastModificationErrors' => '

Describes the error associated with the attachment request.

', ], ], 'ConnectPeerId' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectPeerRequest$ConnectPeerId' => '

The ID of the Connect peer.

', 'ConnectPeer$ConnectPeerId' => '

The ID of the Connect peer.

', 'ConnectPeerAssociation$ConnectPeerId' => '

The ID of the Connect peer.

', 'ConnectPeerIdList$member' => NULL, 'ConnectPeerSummary$ConnectPeerId' => '

The ID of a Connect peer.

', 'DeleteConnectPeerRequest$ConnectPeerId' => '

The ID of the deleted Connect peer.

', 'DisassociateConnectPeerRequest$ConnectPeerId' => '

The ID of the Connect peer to disassociate from a device.

', 'GetConnectPeerRequest$ConnectPeerId' => '

The ID of the Connect peer.

', ], ], 'ConnectPeerIdList' => [ 'base' => NULL, 'refs' => [ 'GetConnectPeerAssociationsRequest$ConnectPeerIds' => '

The IDs of the Connect peers.

', ], ], 'ConnectPeerState' => [ 'base' => NULL, 'refs' => [ 'ConnectPeer$State' => '

The state of the Connect peer.

', 'ConnectPeerSummary$ConnectPeerState' => '

The state of a Connect peer.

', ], ], 'ConnectPeerSummary' => [ 'base' => '

Summary description of a Connect peer.

', 'refs' => [ 'ConnectPeerSummaryList$member' => NULL, ], ], 'ConnectPeerSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListConnectPeersResponse$ConnectPeers' => '

Describes the Connect peers.

', ], ], 'Connection' => [ 'base' => '

Describes a connection.

', 'refs' => [ 'ConnectionList$member' => NULL, 'CreateConnectionResponse$Connection' => '

Information about the connection.

', 'DeleteConnectionResponse$Connection' => '

Information about the connection.

', 'UpdateConnectionResponse$Connection' => '

Information about the connection.

', ], ], 'ConnectionArn' => [ 'base' => NULL, 'refs' => [ 'Connection$ConnectionArn' => '

The Amazon Resource Name (ARN) of the connection.

', ], ], 'ConnectionHealth' => [ 'base' => '

Describes connection health.

', 'refs' => [ 'NetworkTelemetry$Health' => '

The connection health.

', ], ], 'ConnectionId' => [ 'base' => NULL, 'refs' => [ 'Connection$ConnectionId' => '

The ID of the connection.

', 'ConnectionIdList$member' => NULL, 'DeleteConnectionRequest$ConnectionId' => '

The ID of the connection.

', 'UpdateConnectionRequest$ConnectionId' => '

The ID of the connection.

', ], ], 'ConnectionIdList' => [ 'base' => NULL, 'refs' => [ 'GetConnectionsRequest$ConnectionIds' => '

One or more connection IDs.

', ], ], 'ConnectionList' => [ 'base' => NULL, 'refs' => [ 'GetConnectionsResponse$Connections' => '

Information about the connections.

', ], ], 'ConnectionState' => [ 'base' => NULL, 'refs' => [ 'Connection$State' => '

The state of the connection.

', ], ], 'ConnectionStatus' => [ 'base' => NULL, 'refs' => [ 'ConnectionHealth$Status' => '

The connection status.

', ], ], 'ConnectionType' => [ 'base' => NULL, 'refs' => [ 'ConnectionHealth$Type' => '

The connection type.

', ], ], 'ConstrainedString' => [ 'base' => NULL, 'refs' => [ 'AWSLocation$Zone' => '

The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

', 'Attachment$SegmentName' => '

The name of the segment attachment.

', 'Connection$Description' => '

The description of the connection.

', 'ConstrainedStringList$member' => NULL, 'CoreNetwork$Description' => '

The description of a core network.

', 'CoreNetworkChange$Identifier' => '

The resource identifier.

', 'CoreNetworkChange$IdentifierPath' => '

Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment".

', 'CoreNetworkChangeEvent$IdentifierPath' => '

Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment".

', 'CoreNetworkChangeEventValues$SegmentName' => '

The segment name if the change event is associated with a segment.

', 'CoreNetworkChangeEventValues$NetworkFunctionGroupName' => '

The changed network function group name.

', 'CoreNetworkChangeEventValues$Cidr' => '

For a STATIC_ROUTE event, this is the IP address.

', 'CoreNetworkChangeValues$SegmentName' => '

The names of the segments in a core network.

', 'CoreNetworkChangeValues$NetworkFunctionGroupName' => '

The network function group name if the change event is associated with a network function group.

', 'CoreNetworkChangeValues$Cidr' => '

The IP addresses used for a core network.

', 'CoreNetworkChangeValues$DestinationIdentifier' => '

The ID of the destination.

', 'CoreNetworkNetworkFunctionGroup$Name' => '

The name of the network function group.

', 'CoreNetworkNetworkFunctionGroupIdentifier$NetworkFunctionGroupName' => '

The network function group name.

', 'CoreNetworkPolicy$Description' => '

The description of a core network policy.

', 'CoreNetworkPolicyVersion$Description' => '

The description of a core network policy version.

', 'CoreNetworkSegment$Name' => '

The name of a core network segment.

', 'CoreNetworkSegmentEdgeIdentifier$SegmentName' => '

The name of the segment edge.

', 'CoreNetworkSummary$Description' => '

The description of a core network.

', 'CreateConnectionRequest$Description' => '

A description of the connection.

Length Constraints: Maximum length of 256 characters.

', 'CreateCoreNetworkRequest$Description' => '

The description of a core network.

', 'CreateDeviceRequest$Description' => '

A description of the device.

Constraints: Maximum length of 256 characters.

', 'CreateDeviceRequest$Type' => '

The type of the device.

', 'CreateDeviceRequest$Vendor' => '

The vendor of the device.

Constraints: Maximum length of 128 characters.

', 'CreateDeviceRequest$Model' => '

The model of the device.

Constraints: Maximum length of 128 characters.

', 'CreateDeviceRequest$SerialNumber' => '

The serial number of the device.

Constraints: Maximum length of 128 characters.

', 'CreateGlobalNetworkRequest$Description' => '

A description of the global network.

Constraints: Maximum length of 256 characters.

', 'CreateLinkRequest$Description' => '

A description of the link.

Constraints: Maximum length of 256 characters.

', 'CreateLinkRequest$Type' => '

The type of the link.

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \\ ^

', 'CreateLinkRequest$Provider' => '

The provider of the link.

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \\ ^

', 'CreateSiteRequest$Description' => '

A description of your site.

Constraints: Maximum length of 256 characters.

', 'Device$Description' => '

The description of the device.

', 'Device$Type' => '

The device type.

', 'Device$Vendor' => '

The device vendor.

', 'Device$Model' => '

The device model.

', 'Device$SerialNumber' => '

The device serial number.

', 'EdgeOverride$UseEdge' => '

The edge that should be used when overriding the current edge order.

', 'EdgeSet$member' => NULL, 'GetLinksRequest$Type' => '

The link type.

', 'GetLinksRequest$Provider' => '

The link provider.

', 'GetNetworkResourceCountsRequest$ResourceType' => '

The resource type.

The following are the supported resource types for Direct Connect:

The following are the supported resource types for Network Manager:

The following are the supported resource types for Amazon VPC:

', 'GetNetworkResourceRelationshipsRequest$ResourceType' => '

The resource type.

The following are the supported resource types for Direct Connect:

The following are the supported resource types for Network Manager:

The following are the supported resource types for Amazon VPC:

', 'GetNetworkResourcesRequest$ResourceType' => '

The resource type.

The following are the supported resource types for Direct Connect:

The following are the supported resource types for Network Manager:

The following are the supported resource types for Amazon VPC:

', 'GetNetworkTelemetryRequest$ResourceType' => '

The resource type. The following are the supported resource types:

', 'GetRouteAnalysisRequest$RouteAnalysisId' => '

The ID of the route analysis.

', 'GlobalNetwork$Description' => '

The description of the global network.

', 'Link$Description' => '

The description of the link.

', 'Link$Type' => '

The type of the link.

', 'Link$Provider' => '

The provider of the link.

', 'Location$Address' => '

The physical address.

', 'Location$Latitude' => '

The latitude.

', 'Location$Longitude' => '

The longitude.

', 'NetworkFunctionGroup$Name' => '

The name of the network function group.

', 'NetworkResource$ResourceType' => '

The resource type.

The following are the supported resource types for Direct Connect:

The following are the supported resource types for Network Manager:

The following are the supported resource types for Amazon VPC:

', 'NetworkResource$ResourceId' => '

The ID of the resource.

', 'NetworkResource$Definition' => '

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

', 'NetworkResourceCount$ResourceType' => '

The resource type.

', 'NetworkResourceMetadataMap$key' => NULL, 'NetworkResourceMetadataMap$value' => NULL, 'NetworkResourceSummary$ResourceType' => '

The resource type.

', 'NetworkResourceSummary$Definition' => '

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

', 'NetworkResourceSummary$NameTag' => '

The value for the Name tag.

', 'NetworkRoute$DestinationCidrBlock' => '

A unique identifier for the route, such as a CIDR block.

', 'NetworkRoute$PrefixListId' => '

The ID of the prefix list.

', 'NetworkRouteDestination$SegmentName' => '

The name of the segment.

', 'NetworkRouteDestination$NetworkFunctionGroupName' => '

The network function group name associated with the destination.

', 'NetworkRouteDestination$ResourceType' => '

The resource type.

', 'NetworkRouteDestination$ResourceId' => '

The ID of the resource.

', 'NetworkTelemetry$ResourceType' => '

The resource type.

', 'NetworkTelemetry$ResourceId' => '

The ID of the resource.

', 'NetworkTelemetry$Address' => '

The address.

', 'PathComponent$DestinationCidrBlock' => '

The destination CIDR block in the route table.

', 'ProposedNetworkFunctionGroupChange$NetworkFunctionGroupName' => '

The proposed name change for the network function group name.

', 'ProposedSegmentChange$SegmentName' => '

The name of the segment to change.

', 'PutCoreNetworkPolicyRequest$Description' => '

a core network policy description.

', 'Relationship$From' => '

The ARN of the resource.

', 'Relationship$To' => '

The ARN of the resource.

', 'RouteAnalysis$RouteAnalysisId' => '

The ID of the route analysis.

', 'Site$Description' => '

The description of the site.

', 'TransitGatewayRegistrationStateReason$Message' => '

The message for the state reason.

', 'UpdateConnectionRequest$Description' => '

A description of the connection.

Length Constraints: Maximum length of 256 characters.

', 'UpdateCoreNetworkRequest$Description' => '

The description of the update.

', 'UpdateDeviceRequest$Description' => '

A description of the device.

Constraints: Maximum length of 256 characters.

', 'UpdateDeviceRequest$Type' => '

The type of the device.

', 'UpdateDeviceRequest$Vendor' => '

The vendor of the device.

Constraints: Maximum length of 128 characters.

', 'UpdateDeviceRequest$Model' => '

The model of the device.

Constraints: Maximum length of 128 characters.

', 'UpdateDeviceRequest$SerialNumber' => '

The serial number of the device.

Constraints: Maximum length of 128 characters.

', 'UpdateGlobalNetworkRequest$Description' => '

A description of the global network.

Constraints: Maximum length of 256 characters.

', 'UpdateLinkRequest$Description' => '

A description of the link.

Constraints: Maximum length of 256 characters.

', 'UpdateLinkRequest$Type' => '

The type of the link.

Constraints: Maximum length of 128 characters.

', 'UpdateLinkRequest$Provider' => '

The provider of the link.

Constraints: Maximum length of 128 characters.

', 'UpdateSiteRequest$Description' => '

A description of your site.

Constraints: Maximum length of 256 characters.

', 'WhenSentToSegmentsList$member' => NULL, ], ], 'ConstrainedStringList' => [ 'base' => NULL, 'refs' => [ 'ConnectPeerConfiguration$InsideCidrBlocks' => '

The inside IP addresses used for a Connect peer configuration.

', 'CoreNetworkChangeValues$InsideCidrBlocks' => '

The inside IP addresses used for core network change values.

', 'CoreNetworkChangeValues$SharedSegments' => '

The shared segments for a core network change value.

', 'CoreNetworkEdge$InsideCidrBlocks' => '

The inside IP addresses used for core network edges.

', 'CoreNetworkSegment$SharedSegments' => '

The shared segments of a core network.

', 'CreateConnectPeerRequest$InsideCidrBlocks' => '

The inside IP addresses used for BGP peering.

', 'GetNetworkRoutesRequest$ExactCidrMatches' => '

An exact CIDR block.

', 'GetNetworkRoutesRequest$LongestPrefixMatches' => '

The most specific route that matches the traffic (longest prefix match).

', 'GetNetworkRoutesRequest$SubnetOfMatches' => '

The routes with a subnet that match the specified CIDR filter.

', 'GetNetworkRoutesRequest$SupernetOfMatches' => '

The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

', 'GetNetworkRoutesRequest$PrefixListIds' => '

The IDs of the prefix lists.

', 'ServiceInsertionSegments$SendVia' => '

The list of segments associated with the send-via action.

', 'ServiceInsertionSegments$SendTo' => '

The list of segments associated with the send-to action.

', ], ], 'CoreNetwork' => [ 'base' => '

Describes a core network.

', 'refs' => [ 'CreateCoreNetworkResponse$CoreNetwork' => '

Returns details about a core network.

', 'DeleteCoreNetworkResponse$CoreNetwork' => '

Information about the deleted core network.

', 'GetCoreNetworkResponse$CoreNetwork' => '

Details about a core network.

', 'UpdateCoreNetworkResponse$CoreNetwork' => '

Returns information about a core network update.

', ], ], 'CoreNetworkArn' => [ 'base' => NULL, 'refs' => [ 'Attachment$CoreNetworkArn' => '

The ARN of a core network.

', 'CoreNetwork$CoreNetworkArn' => '

The ARN of a core network.

', 'CoreNetworkSummary$CoreNetworkArn' => '

a core network ARN.

', 'Peering$CoreNetworkArn' => '

The ARN of a core network.

', ], ], 'CoreNetworkChange' => [ 'base' => '

Details describing a core network change.

', 'refs' => [ 'CoreNetworkChangeList$member' => NULL, ], ], 'CoreNetworkChangeEvent' => [ 'base' => '

Describes a core network change event. This can be a change to a segment, attachment, route, etc.

', 'refs' => [ 'CoreNetworkChangeEventList$member' => NULL, ], ], 'CoreNetworkChangeEventList' => [ 'base' => NULL, 'refs' => [ 'GetCoreNetworkChangeEventsResponse$CoreNetworkChangeEvents' => '

The response to GetCoreNetworkChangeEventsRequest.

', ], ], 'CoreNetworkChangeEventValues' => [ 'base' => '

Describes a core network change event.

', 'refs' => [ 'CoreNetworkChangeEvent$Values' => '

Details of the change event.

', ], ], 'CoreNetworkChangeList' => [ 'base' => NULL, 'refs' => [ 'GetCoreNetworkChangeSetResponse$CoreNetworkChanges' => '

Describes a core network changes.

', ], ], 'CoreNetworkChangeValues' => [ 'base' => '

Describes a core network change.

', 'refs' => [ 'CoreNetworkChange$PreviousValues' => '

The previous values for a core network.

', 'CoreNetworkChange$NewValues' => '

The new value for a core network

', ], ], 'CoreNetworkEdge' => [ 'base' => '

Describes a core network edge.

', 'refs' => [ 'CoreNetworkEdgeList$member' => NULL, ], ], 'CoreNetworkEdgeList' => [ 'base' => NULL, 'refs' => [ 'CoreNetwork$Edges' => '

The edges within a core network.

', ], ], 'CoreNetworkId' => [ 'base' => NULL, 'refs' => [ 'Attachment$CoreNetworkId' => '

The ID of a core network.

', 'ConnectPeer$CoreNetworkId' => '

The ID of a core network.

', 'ConnectPeerSummary$CoreNetworkId' => '

The ID of a core network.

', 'CoreNetwork$CoreNetworkId' => '

The ID of a core network.

', 'CoreNetworkNetworkFunctionGroupIdentifier$CoreNetworkId' => '

The ID of the core network.

', 'CoreNetworkPolicy$CoreNetworkId' => '

The ID of a core network.

', 'CoreNetworkPolicyVersion$CoreNetworkId' => '

The ID of a core network.

', 'CoreNetworkSegmentEdgeIdentifier$CoreNetworkId' => '

The ID of a core network.

', 'CoreNetworkSummary$CoreNetworkId' => '

The ID of a core network.

', 'CreateConnectAttachmentRequest$CoreNetworkId' => '

The ID of a core network where you want to create the attachment.

', 'CreateSiteToSiteVpnAttachmentRequest$CoreNetworkId' => '

The ID of a core network where you\'re creating a site-to-site VPN attachment.

', 'CreateTransitGatewayPeeringRequest$CoreNetworkId' => '

The ID of a core network.

', 'CreateVpcAttachmentRequest$CoreNetworkId' => '

The ID of a core network for the VPC attachment.

', 'DeleteCoreNetworkPolicyVersionRequest$CoreNetworkId' => '

The ID of a core network for the deleted policy.

', 'DeleteCoreNetworkRequest$CoreNetworkId' => '

The network ID of the deleted core network.

', 'ExecuteCoreNetworkChangeSetRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetCoreNetworkChangeEventsRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetCoreNetworkChangeSetRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetCoreNetworkPolicyRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetCoreNetworkRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetNetworkResourceRelationshipsRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetNetworkResourcesRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetNetworkTelemetryRequest$CoreNetworkId' => '

The ID of a core network.

', 'ListAttachmentsRequest$CoreNetworkId' => '

The ID of a core network.

', 'ListConnectPeersRequest$CoreNetworkId' => '

The ID of a core network.

', 'ListCoreNetworkPolicyVersionsRequest$CoreNetworkId' => '

The ID of a core network.

', 'ListPeeringsRequest$CoreNetworkId' => '

The ID of a core network.

', 'NetworkResource$CoreNetworkId' => '

The ID of a core network.

', 'NetworkTelemetry$CoreNetworkId' => '

The ID of a core network.

', 'Peering$CoreNetworkId' => '

The ID of the core network for the peering request.

', 'PutCoreNetworkPolicyRequest$CoreNetworkId' => '

The ID of a core network.

', 'RestoreCoreNetworkPolicyVersionRequest$CoreNetworkId' => '

The ID of a core network.

', 'UpdateCoreNetworkRequest$CoreNetworkId' => '

The ID of a core network.

', ], ], 'CoreNetworkNetworkFunctionGroup' => [ 'base' => '

Describes a network function group.

', 'refs' => [ 'CoreNetworkNetworkFunctionGroupList$member' => NULL, ], ], 'CoreNetworkNetworkFunctionGroupIdentifier' => [ 'base' => '

Describes a core network

', 'refs' => [ 'RouteTableIdentifier$CoreNetworkNetworkFunctionGroup' => '

The route table identifier associated with the network function group.

', ], ], 'CoreNetworkNetworkFunctionGroupList' => [ 'base' => NULL, 'refs' => [ 'CoreNetwork$NetworkFunctionGroups' => '

The network function groups associated with a core network.

', ], ], 'CoreNetworkPolicy' => [ 'base' => '

Describes a core network policy. You can have only one LIVE Core Policy.

', 'refs' => [ 'DeleteCoreNetworkPolicyVersionResponse$CoreNetworkPolicy' => '

Returns information about the deleted policy version.

', 'GetCoreNetworkPolicyResponse$CoreNetworkPolicy' => '

The details about a core network policy.

', 'PutCoreNetworkPolicyResponse$CoreNetworkPolicy' => '

Describes the changed core network policy.

', 'RestoreCoreNetworkPolicyVersionResponse$CoreNetworkPolicy' => '

Describes the restored core network policy.

', ], ], 'CoreNetworkPolicyAlias' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkPolicy$Alias' => '

Whether a core network policy is the current LIVE policy or the most recently submitted policy.

', 'CoreNetworkPolicyVersion$Alias' => '

Whether a core network policy is the current policy or the most recently submitted policy.

', 'GetCoreNetworkPolicyRequest$Alias' => '

The alias of a core network policy

', ], ], 'CoreNetworkPolicyDocument' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkPolicy$PolicyDocument' => '

Describes a core network policy.

', 'CreateCoreNetworkRequest$PolicyDocument' => '

The policy document for creating a core network.

', 'PutCoreNetworkPolicyRequest$PolicyDocument' => '

The policy document.

', ], ], 'CoreNetworkPolicyError' => [ 'base' => '

Provides details about an error in a core network policy.

', 'refs' => [ 'CoreNetworkPolicyErrorList$member' => NULL, ], ], 'CoreNetworkPolicyErrorList' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkPolicy$PolicyErrors' => '

Describes any errors in a core network policy.

', 'CoreNetworkPolicyException$Errors' => '

Describes a core network policy exception.

', ], ], 'CoreNetworkPolicyException' => [ 'base' => '

Describes a core network policy exception.

', 'refs' => [], ], 'CoreNetworkPolicyVersion' => [ 'base' => '

Describes a core network policy version.

', 'refs' => [ 'CoreNetworkPolicyVersionList$member' => NULL, ], ], 'CoreNetworkPolicyVersionList' => [ 'base' => NULL, 'refs' => [ 'ListCoreNetworkPolicyVersionsResponse$CoreNetworkPolicyVersions' => '

Describes core network policy versions.

', ], ], 'CoreNetworkSegment' => [ 'base' => '

Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.

', 'refs' => [ 'CoreNetworkSegmentList$member' => NULL, ], ], 'CoreNetworkSegmentEdgeIdentifier' => [ 'base' => '

Returns details about a core network edge.

', 'refs' => [ 'GetNetworkRoutesResponse$CoreNetworkSegmentEdge' => '

Describes a core network segment edge.

', 'RouteTableIdentifier$CoreNetworkSegmentEdge' => '

The segment edge in a core network.

', ], ], 'CoreNetworkSegmentList' => [ 'base' => NULL, 'refs' => [ 'CoreNetwork$Segments' => '

The segments within a core network.

', ], ], 'CoreNetworkState' => [ 'base' => NULL, 'refs' => [ 'CoreNetwork$State' => '

The current state of a core network.

', 'CoreNetworkSummary$State' => '

The state of a core network.

', ], ], 'CoreNetworkSummary' => [ 'base' => '

Returns summary information about a core network.

', 'refs' => [ 'CoreNetworkSummaryList$member' => NULL, ], ], 'CoreNetworkSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListCoreNetworksResponse$CoreNetworks' => '

Describes the list of core networks.

', ], ], 'CreateConnectAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateCoreNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCoreNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDeviceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDeviceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateLinkRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLinkResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSiteResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSiteToSiteVpnAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSiteToSiteVpnAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransitGatewayPeeringRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransitGatewayPeeringResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransitGatewayRouteTableAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransitGatewayRouteTableAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVpcAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVpcAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CustomerGatewayArn' => [ 'base' => NULL, 'refs' => [ 'AssociateCustomerGatewayRequest$CustomerGatewayArn' => '

The Amazon Resource Name (ARN) of the customer gateway.

', 'CustomerGatewayArnList$member' => NULL, 'CustomerGatewayAssociation$CustomerGatewayArn' => '

The Amazon Resource Name (ARN) of the customer gateway.

', 'DisassociateCustomerGatewayRequest$CustomerGatewayArn' => '

The Amazon Resource Name (ARN) of the customer gateway.

', ], ], 'CustomerGatewayArnList' => [ 'base' => NULL, 'refs' => [ 'GetCustomerGatewayAssociationsRequest$CustomerGatewayArns' => '

One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.

', ], ], 'CustomerGatewayAssociation' => [ 'base' => '

Describes the association between a customer gateway, a device, and a link.

', 'refs' => [ 'AssociateCustomerGatewayResponse$CustomerGatewayAssociation' => '

The customer gateway association.

', 'CustomerGatewayAssociationList$member' => NULL, 'DisassociateCustomerGatewayResponse$CustomerGatewayAssociation' => '

Information about the customer gateway association.

', ], ], 'CustomerGatewayAssociationList' => [ 'base' => NULL, 'refs' => [ 'GetCustomerGatewayAssociationsResponse$CustomerGatewayAssociations' => '

The customer gateway associations.

', ], ], 'CustomerGatewayAssociationState' => [ 'base' => NULL, 'refs' => [ 'CustomerGatewayAssociation$State' => '

The association state.

', ], ], 'DateTime' => [ 'base' => NULL, 'refs' => [ 'Attachment$CreatedAt' => '

The timestamp when the attachment was created.

', 'Attachment$UpdatedAt' => '

The timestamp when the attachment was last updated.

', 'ConnectPeer$CreatedAt' => '

The timestamp when the Connect peer was created.

', 'ConnectPeerSummary$CreatedAt' => '

The timestamp when a Connect peer was created.

', 'Connection$CreatedAt' => '

The date and time that the connection was created.

', 'ConnectionHealth$Timestamp' => '

The time the status was last updated.

', 'CoreNetwork$CreatedAt' => '

The timestamp when a core network was created.

', 'CoreNetworkChangeEvent$EventTime' => '

The timestamp for an event change in status.

', 'CoreNetworkPolicy$CreatedAt' => '

The timestamp when a core network policy was created.

', 'CoreNetworkPolicyVersion$CreatedAt' => '

The timestamp when a core network policy version was created.

', 'Device$CreatedAt' => '

The date and time that the site was created.

', 'GetNetworkRoutesResponse$RouteTableTimestamp' => '

The route table creation time.

', 'GlobalNetwork$CreatedAt' => '

The date and time that the global network was created.

', 'Link$CreatedAt' => '

The date and time that the link was created.

', 'NetworkResource$DefinitionTimestamp' => '

The time that the resource definition was retrieved.

', 'Peering$CreatedAt' => '

The timestamp when the attachment peer was created.

', 'RouteAnalysis$StartTimestamp' => '

The time that the analysis started.

', 'Site$CreatedAt' => '

The date and time that the site was created.

', ], ], 'DeleteAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCoreNetworkPolicyVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCoreNetworkPolicyVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCoreNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCoreNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDeviceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDeviceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGlobalNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGlobalNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLinkRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLinkResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePeeringRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePeeringResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSiteResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTransitGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTransitGatewayResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGlobalNetworksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGlobalNetworksResponse' => [ 'base' => NULL, 'refs' => [], ], 'Device' => [ 'base' => '

Describes a device.

', 'refs' => [ 'CreateDeviceResponse$Device' => '

Information about the device.

', 'DeleteDeviceResponse$Device' => '

Information about the device.

', 'DeviceList$member' => NULL, 'UpdateDeviceResponse$Device' => '

Information about the device.

', ], ], 'DeviceArn' => [ 'base' => NULL, 'refs' => [ 'Device$DeviceArn' => '

The Amazon Resource Name (ARN) of the device.

', ], ], 'DeviceId' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectPeerRequest$DeviceId' => '

The ID of the device.

', 'AssociateCustomerGatewayRequest$DeviceId' => '

The ID of the device.

', 'AssociateLinkRequest$DeviceId' => '

The ID of the device.

', 'AssociateTransitGatewayConnectPeerRequest$DeviceId' => '

The ID of the device.

', 'ConnectPeerAssociation$DeviceId' => '

The ID of the device to connect to.

', 'Connection$DeviceId' => '

The ID of the first device in the connection.

', 'Connection$ConnectedDeviceId' => '

The ID of the second device in the connection.

', 'CreateConnectionRequest$DeviceId' => '

The ID of the first device in the connection.

', 'CreateConnectionRequest$ConnectedDeviceId' => '

The ID of the second device in the connection.

', 'CustomerGatewayAssociation$DeviceId' => '

The ID of the device.

', 'DeleteDeviceRequest$DeviceId' => '

The ID of the device.

', 'Device$DeviceId' => '

The ID of the device.

', 'DeviceIdList$member' => NULL, 'DisassociateLinkRequest$DeviceId' => '

The ID of the device.

', 'GetConnectionsRequest$DeviceId' => '

The ID of the device.

', 'GetLinkAssociationsRequest$DeviceId' => '

The ID of the device.

', 'LinkAssociation$DeviceId' => '

The device ID for the link association.

', 'TransitGatewayConnectPeerAssociation$DeviceId' => '

The ID of the device.

', 'UpdateDeviceRequest$DeviceId' => '

The ID of the device.

', ], ], 'DeviceIdList' => [ 'base' => NULL, 'refs' => [ 'GetDevicesRequest$DeviceIds' => '

One or more device IDs. The maximum is 10.

', ], ], 'DeviceList' => [ 'base' => NULL, 'refs' => [ 'GetDevicesResponse$Devices' => '

The devices.

', ], ], 'DeviceState' => [ 'base' => NULL, 'refs' => [ 'Device$State' => '

The device state.

', ], ], 'DisassociateConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateCustomerGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateCustomerGatewayResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateLinkRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateLinkResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTransitGatewayConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTransitGatewayConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'EdgeOverride' => [ 'base' => '

Describes the edge that\'s used for the override.

', 'refs' => [ 'WithEdgeOverridesList$member' => NULL, ], ], 'EdgeSet' => [ 'base' => NULL, 'refs' => [ 'EdgeSetList$member' => NULL, ], ], 'EdgeSetList' => [ 'base' => NULL, 'refs' => [ 'EdgeOverride$EdgeSets' => '

The list of edge locations.

', ], ], 'ExceptionContextKey' => [ 'base' => NULL, 'refs' => [ 'ExceptionContextMap$key' => NULL, ], ], 'ExceptionContextMap' => [ 'base' => NULL, 'refs' => [ 'ResourceNotFoundException$Context' => '

The specified resource could not be found.

', ], ], 'ExceptionContextValue' => [ 'base' => NULL, 'refs' => [ 'ExceptionContextMap$value' => NULL, ], ], 'ExecuteCoreNetworkChangeSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'ExecuteCoreNetworkChangeSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'ExternalRegionCode' => [ 'base' => NULL, 'refs' => [ 'Attachment$EdgeLocation' => '

The Region where the edge is located.

', 'ConnectPeer$EdgeLocation' => '

The Connect peer Regions where edges are located.

', 'ConnectPeerSummary$EdgeLocation' => '

The Region where the edge is located.

', 'CoreNetworkChangeEventValues$EdgeLocation' => '

The edge location for the core network change event.

', 'CoreNetworkEdge$EdgeLocation' => '

The Region where a core network edge is located.

', 'CoreNetworkNetworkFunctionGroupIdentifier$EdgeLocation' => '

The location for the core network edge.

', 'CoreNetworkSegmentEdgeIdentifier$EdgeLocation' => '

The Region where the segment edge is located.

', 'CreateConnectAttachmentRequest$EdgeLocation' => '

The Region where the edge is located.

', 'ExternalRegionCodeList$member' => NULL, 'GetNetworkResourceRelationshipsRequest$AwsRegion' => '

The Amazon Web Services Region.

', 'GetNetworkResourcesRequest$AwsRegion' => '

The Amazon Web Services Region.

', 'GetNetworkTelemetryRequest$AwsRegion' => '

The Amazon Web Services Region.

', 'ListAttachmentsRequest$EdgeLocation' => '

The Region where the edge is located.

', 'ListPeeringsRequest$EdgeLocation' => '

Returns a list edge locations for the

', 'NetworkResource$AwsRegion' => '

The Amazon Web Services Region.

', 'NetworkRouteDestination$EdgeLocation' => '

The edge location for the network destination.

', 'NetworkTelemetry$AwsRegion' => '

The Amazon Web Services Region.

', 'Peering$EdgeLocation' => '

The edge location for the peer.

', ], ], 'ExternalRegionCodeList' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkChangeValues$EdgeLocations' => '

The Regions where edges are located in a core network.

', 'CoreNetworkNetworkFunctionGroup$EdgeLocations' => '

The core network edge locations.

', 'CoreNetworkSegment$EdgeLocations' => '

The Regions where the edges are located.

', ], ], 'FilterMap' => [ 'base' => NULL, 'refs' => [ 'GetNetworkRoutesRequest$DestinationFilters' => '

Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

', ], ], 'FilterName' => [ 'base' => NULL, 'refs' => [ 'FilterMap$key' => NULL, ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterValues$member' => NULL, ], ], 'FilterValues' => [ 'base' => NULL, 'refs' => [ 'FilterMap$value' => NULL, ], ], 'GetConnectAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectPeerAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectPeerAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkChangeEventsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkChangeEventsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkChangeSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkChangeSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomerGatewayAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomerGatewayAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLinkAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLinkAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLinksRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLinksResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkResourceCountsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkResourceCountsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkResourceRelationshipsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkResourceRelationshipsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkRoutesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkRoutesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkTelemetryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkTelemetryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRouteAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRouteAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSiteToSiteVpnAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSiteToSiteVpnAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSitesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSitesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayConnectPeerAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayConnectPeerAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayPeeringRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayPeeringResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayRegistrationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayRegistrationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayRouteTableAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayRouteTableAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVpcAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVpcAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GlobalNetwork' => [ 'base' => '

Describes a global network. This is a single private network acting as a high-level container for your network objects, including an Amazon Web Services-managed Core Network.

', 'refs' => [ 'CreateGlobalNetworkResponse$GlobalNetwork' => '

Information about the global network object.

', 'DeleteGlobalNetworkResponse$GlobalNetwork' => '

Information about the global network.

', 'GlobalNetworkList$member' => NULL, 'UpdateGlobalNetworkResponse$GlobalNetwork' => '

Information about the global network object.

', ], ], 'GlobalNetworkArn' => [ 'base' => NULL, 'refs' => [ 'GlobalNetwork$GlobalNetworkArn' => '

The Amazon Resource Name (ARN) of the global network.

', ], ], 'GlobalNetworkId' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectPeerRequest$GlobalNetworkId' => '

The ID of your global network.

', 'AssociateCustomerGatewayRequest$GlobalNetworkId' => '

The ID of the global network.

', 'AssociateLinkRequest$GlobalNetworkId' => '

The ID of the global network.

', 'AssociateTransitGatewayConnectPeerRequest$GlobalNetworkId' => '

The ID of the global network.

', 'ConnectPeerAssociation$GlobalNetworkId' => '

The ID of the global network.

', 'Connection$GlobalNetworkId' => '

The ID of the global network.

', 'CoreNetwork$GlobalNetworkId' => '

The ID of the global network that your core network is a part of.

', 'CoreNetworkSummary$GlobalNetworkId' => '

The global network ID.

', 'CreateConnectionRequest$GlobalNetworkId' => '

The ID of the global network.

', 'CreateCoreNetworkRequest$GlobalNetworkId' => '

The ID of the global network that a core network will be a part of.

', 'CreateDeviceRequest$GlobalNetworkId' => '

The ID of the global network.

', 'CreateLinkRequest$GlobalNetworkId' => '

The ID of the global network.

', 'CreateSiteRequest$GlobalNetworkId' => '

The ID of the global network.

', 'CustomerGatewayAssociation$GlobalNetworkId' => '

The ID of the global network.

', 'DeleteConnectionRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DeleteDeviceRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DeleteGlobalNetworkRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DeleteLinkRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DeleteSiteRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DeregisterTransitGatewayRequest$GlobalNetworkId' => '

The ID of the global network.

', 'Device$GlobalNetworkId' => '

The ID of the global network.

', 'DisassociateConnectPeerRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DisassociateCustomerGatewayRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DisassociateLinkRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DisassociateTransitGatewayConnectPeerRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetConnectPeerAssociationsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetConnectionsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetCustomerGatewayAssociationsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetDevicesRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetLinkAssociationsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetLinksRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetNetworkResourceCountsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetNetworkResourceRelationshipsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetNetworkResourcesRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetNetworkRoutesRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetNetworkTelemetryRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetRouteAnalysisRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetSitesRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetTransitGatewayConnectPeerAssociationsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetTransitGatewayRegistrationsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GlobalNetwork$GlobalNetworkId' => '

The ID of the global network.

', 'GlobalNetworkIdList$member' => NULL, 'Link$GlobalNetworkId' => '

The ID of the global network.

', 'LinkAssociation$GlobalNetworkId' => '

The ID of the global network.

', 'RegisterTransitGatewayRequest$GlobalNetworkId' => '

The ID of the global network.

', 'RouteAnalysis$GlobalNetworkId' => '

The ID of the global network.

', 'Site$GlobalNetworkId' => '

The ID of the global network.

', 'StartRouteAnalysisRequest$GlobalNetworkId' => '

The ID of the global network.

', 'TransitGatewayConnectPeerAssociation$GlobalNetworkId' => '

The ID of the global network.

', 'TransitGatewayRegistration$GlobalNetworkId' => '

The ID of the global network.

', 'UpdateConnectionRequest$GlobalNetworkId' => '

The ID of the global network.

', 'UpdateDeviceRequest$GlobalNetworkId' => '

The ID of the global network.

', 'UpdateGlobalNetworkRequest$GlobalNetworkId' => '

The ID of your global network.

', 'UpdateLinkRequest$GlobalNetworkId' => '

The ID of the global network.

', 'UpdateNetworkResourceMetadataRequest$GlobalNetworkId' => '

The ID of the global network.

', 'UpdateSiteRequest$GlobalNetworkId' => '

The ID of the global network.

', ], ], 'GlobalNetworkIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeGlobalNetworksRequest$GlobalNetworkIds' => '

The IDs of one or more global networks. The maximum is 10.

', ], ], 'GlobalNetworkList' => [ 'base' => NULL, 'refs' => [ 'DescribeGlobalNetworksResponse$GlobalNetworks' => '

Information about the global networks.

', ], ], 'GlobalNetworkState' => [ 'base' => NULL, 'refs' => [ 'GlobalNetwork$State' => '

The state of the global network.

', ], ], 'IPAddress' => [ 'base' => NULL, 'refs' => [ 'ConnectPeerBgpConfiguration$CoreNetworkAddress' => '

The address of a core network.

', 'ConnectPeerBgpConfiguration$PeerAddress' => '

The address of a core network Connect peer.

', 'ConnectPeerConfiguration$CoreNetworkAddress' => '

The IP address of a core network.

', 'ConnectPeerConfiguration$PeerAddress' => '

The IP address of the Connect peer.

', 'CreateConnectPeerRequest$CoreNetworkAddress' => '

A Connect peer core network address. This only applies only when the protocol is GRE.

', 'CreateConnectPeerRequest$PeerAddress' => '

The Connect peer address.

', 'RouteAnalysisEndpointOptions$IpAddress' => '

The IP address.

', 'RouteAnalysisEndpointOptionsSpecification$IpAddress' => '

The IP address.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Attachment$AttachmentPolicyRuleNumber' => '

The policy rule number associated with the attachment.

', 'Bandwidth$UploadSpeed' => '

Upload speed in Mbps.

', 'Bandwidth$DownloadSpeed' => '

Download speed in Mbps.

', 'CoreNetworkPolicy$PolicyVersionId' => '

The ID of the policy version.

', 'CoreNetworkPolicyVersion$PolicyVersionId' => '

The ID of the policy version.

', 'DeleteCoreNetworkPolicyVersionRequest$PolicyVersionId' => '

The version ID of the deleted policy.

', 'ExecuteCoreNetworkChangeSetRequest$PolicyVersionId' => '

The ID of the policy version.

', 'GetCoreNetworkChangeEventsRequest$PolicyVersionId' => '

The ID of the policy version.

', 'GetCoreNetworkChangeSetRequest$PolicyVersionId' => '

The ID of the policy version.

', 'GetCoreNetworkPolicyRequest$PolicyVersionId' => '

The ID of a core network policy version.

', 'NetworkResourceCount$Count' => '

The resource count.

', 'PathComponent$Sequence' => '

The sequence number in the path. The destination is 0.

', 'ProposedNetworkFunctionGroupChange$AttachmentPolicyRuleNumber' => '

The proposed new attachment policy rule number for the network function group.

', 'ProposedSegmentChange$AttachmentPolicyRuleNumber' => '

The rule number in the policy document that applies to this change.

', 'PutCoreNetworkPolicyRequest$LatestVersionId' => '

The ID of a core network policy.

', 'RestoreCoreNetworkPolicyVersionRequest$PolicyVersionId' => '

The ID of the policy version to restore.

', ], ], 'InternalServerException' => [ 'base' => '

The request has failed due to an internal error.

', 'refs' => [], ], 'Link' => [ 'base' => '

Describes a link.

', 'refs' => [ 'CreateLinkResponse$Link' => '

Information about the link.

', 'DeleteLinkResponse$Link' => '

Information about the link.

', 'LinkList$member' => NULL, 'UpdateLinkResponse$Link' => '

Information about the link.

', ], ], 'LinkArn' => [ 'base' => NULL, 'refs' => [ 'Link$LinkArn' => '

The Amazon Resource Name (ARN) of the link.

', ], ], 'LinkAssociation' => [ 'base' => '

Describes the association between a device and a link.

', 'refs' => [ 'AssociateLinkResponse$LinkAssociation' => '

The link association.

', 'DisassociateLinkResponse$LinkAssociation' => '

Information about the link association.

', 'LinkAssociationList$member' => NULL, ], ], 'LinkAssociationList' => [ 'base' => NULL, 'refs' => [ 'GetLinkAssociationsResponse$LinkAssociations' => '

The link associations.

', ], ], 'LinkAssociationState' => [ 'base' => NULL, 'refs' => [ 'LinkAssociation$LinkAssociationState' => '

The state of the association.

', ], ], 'LinkId' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectPeerRequest$LinkId' => '

The ID of the link.

', 'AssociateCustomerGatewayRequest$LinkId' => '

The ID of the link.

', 'AssociateLinkRequest$LinkId' => '

The ID of the link.

', 'AssociateTransitGatewayConnectPeerRequest$LinkId' => '

The ID of the link.

', 'ConnectPeerAssociation$LinkId' => '

The ID of the link.

', 'Connection$LinkId' => '

The ID of the link for the first device in the connection.

', 'Connection$ConnectedLinkId' => '

The ID of the link for the second device in the connection.

', 'CreateConnectionRequest$LinkId' => '

The ID of the link for the first device.

', 'CreateConnectionRequest$ConnectedLinkId' => '

The ID of the link for the second device.

', 'CustomerGatewayAssociation$LinkId' => '

The ID of the link.

', 'DeleteLinkRequest$LinkId' => '

The ID of the link.

', 'DisassociateLinkRequest$LinkId' => '

The ID of the link.

', 'GetLinkAssociationsRequest$LinkId' => '

The ID of the link.

', 'Link$LinkId' => '

The ID of the link.

', 'LinkAssociation$LinkId' => '

The ID of the link.

', 'LinkIdList$member' => NULL, 'TransitGatewayConnectPeerAssociation$LinkId' => '

The ID of the link.

', 'UpdateConnectionRequest$LinkId' => '

The ID of the link for the first device in the connection.

', 'UpdateConnectionRequest$ConnectedLinkId' => '

The ID of the link for the second device in the connection.

', 'UpdateLinkRequest$LinkId' => '

The ID of the link.

', ], ], 'LinkIdList' => [ 'base' => NULL, 'refs' => [ 'GetLinksRequest$LinkIds' => '

One or more link IDs. The maximum is 10.

', ], ], 'LinkList' => [ 'base' => NULL, 'refs' => [ 'GetLinksResponse$Links' => '

The links.

', ], ], 'LinkState' => [ 'base' => NULL, 'refs' => [ 'Link$State' => '

The state of the link.

', ], ], 'ListAttachmentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAttachmentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListConnectPeersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListConnectPeersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCoreNetworkPolicyVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCoreNetworkPolicyVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCoreNetworksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCoreNetworksResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListOrganizationServiceAccessStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListOrganizationServiceAccessStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPeeringsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPeeringsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Location' => [ 'base' => '

Describes a location.

', 'refs' => [ 'CreateDeviceRequest$Location' => '

The location of the device.

', 'CreateSiteRequest$Location' => '

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.

', 'Device$Location' => '

The site location.

', 'Site$Location' => '

The location of the site.

', 'UpdateDeviceRequest$Location' => NULL, 'UpdateSiteRequest$Location' => '

The site location:

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'BgpOptions$PeerAsn' => '

The Peer ASN of the BGP.

', 'ConnectPeerBgpConfiguration$CoreNetworkAsn' => '

The ASN of the Coret Network.

', 'ConnectPeerBgpConfiguration$PeerAsn' => '

The ASN of the Connect peer.

', 'CoreNetworkChangeValues$Asn' => '

The ASN of a core network.

', 'CoreNetworkEdge$Asn' => '

The ASN of a core network edge.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeGlobalNetworksRequest$MaxResults' => '

The maximum number of results to return.

', 'GetConnectPeerAssociationsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetConnectionsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetCoreNetworkChangeEventsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetCoreNetworkChangeSetRequest$MaxResults' => '

The maximum number of results to return.

', 'GetCustomerGatewayAssociationsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetDevicesRequest$MaxResults' => '

The maximum number of results to return.

', 'GetLinkAssociationsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetLinksRequest$MaxResults' => '

The maximum number of results to return.

', 'GetNetworkResourceCountsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetNetworkResourceRelationshipsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetNetworkResourcesRequest$MaxResults' => '

The maximum number of results to return.

', 'GetNetworkTelemetryRequest$MaxResults' => '

The maximum number of results to return.

', 'GetSitesRequest$MaxResults' => '

The maximum number of results to return.

', 'GetTransitGatewayConnectPeerAssociationsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetTransitGatewayRegistrationsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListAttachmentsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListConnectPeersRequest$MaxResults' => '

The maximum number of results to return.

', 'ListCoreNetworkPolicyVersionsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListCoreNetworksRequest$MaxResults' => '

The maximum number of results to return.

', 'ListOrganizationServiceAccessStatusRequest$MaxResults' => '

The maximum number of results to return.

', 'ListPeeringsRequest$MaxResults' => '

The maximum number of results to return.

', ], ], 'NetworkFunctionGroup' => [ 'base' => '

Describes a network function group for service insertion.

', 'refs' => [ 'NetworkFunctionGroupList$member' => NULL, ], ], 'NetworkFunctionGroupList' => [ 'base' => NULL, 'refs' => [ 'Via$NetworkFunctionGroups' => '

The list of network function groups associated with the service insertion action.

', ], ], 'NetworkFunctionGroupName' => [ 'base' => NULL, 'refs' => [ 'Attachment$NetworkFunctionGroupName' => '

The name of the network function group.

', ], ], 'NetworkResource' => [ 'base' => '

Describes a network resource.

', 'refs' => [ 'NetworkResourceList$member' => NULL, ], ], 'NetworkResourceCount' => [ 'base' => '

Describes a resource count.

', 'refs' => [ 'NetworkResourceCountList$member' => NULL, ], ], 'NetworkResourceCountList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkResourceCountsResponse$NetworkResourceCounts' => '

The count of resources.

', ], ], 'NetworkResourceList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkResourcesResponse$NetworkResources' => '

The network resources.

', ], ], 'NetworkResourceMetadataMap' => [ 'base' => NULL, 'refs' => [ 'NetworkResource$Metadata' => '

The resource metadata.

', 'UpdateNetworkResourceMetadataRequest$Metadata' => '

The resource metadata.

', 'UpdateNetworkResourceMetadataResponse$Metadata' => '

The updated resource metadata.

', ], ], 'NetworkResourceSummary' => [ 'base' => '

Describes a network resource.

', 'refs' => [ 'PathComponent$Resource' => '

The resource.

', ], ], 'NetworkRoute' => [ 'base' => '

Describes a network route.

', 'refs' => [ 'NetworkRouteList$member' => NULL, ], ], 'NetworkRouteDestination' => [ 'base' => '

Describes the destination of a network route.

', 'refs' => [ 'NetworkRouteDestinationList$member' => NULL, ], ], 'NetworkRouteDestinationList' => [ 'base' => NULL, 'refs' => [ 'NetworkRoute$Destinations' => '

The destinations.

', ], ], 'NetworkRouteList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkRoutesResponse$NetworkRoutes' => '

The network routes.

', ], ], 'NetworkTelemetry' => [ 'base' => '

Describes the telemetry information for a resource.

', 'refs' => [ 'NetworkTelemetryList$member' => NULL, ], ], 'NetworkTelemetryList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkTelemetryResponse$NetworkTelemetry' => '

The network telemetry.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeGlobalNetworksRequest$NextToken' => '

The token for the next page of results.

', 'DescribeGlobalNetworksResponse$NextToken' => '

The token for the next page of results.

', 'GetConnectPeerAssociationsRequest$NextToken' => '

The token for the next page of results.

', 'GetConnectPeerAssociationsResponse$NextToken' => '

The token for the next page of results.

', 'GetConnectionsRequest$NextToken' => '

The token for the next page of results.

', 'GetConnectionsResponse$NextToken' => '

The token to use for the next page of results.

', 'GetCoreNetworkChangeEventsRequest$NextToken' => '

The token for the next page of results.

', 'GetCoreNetworkChangeEventsResponse$NextToken' => '

The token for the next page of results.

', 'GetCoreNetworkChangeSetRequest$NextToken' => '

The token for the next page of results.

', 'GetCoreNetworkChangeSetResponse$NextToken' => '

The token for the next page of results.

', 'GetCustomerGatewayAssociationsRequest$NextToken' => '

The token for the next page of results.

', 'GetCustomerGatewayAssociationsResponse$NextToken' => '

The token for the next page of results.

', 'GetDevicesRequest$NextToken' => '

The token for the next page of results.

', 'GetDevicesResponse$NextToken' => '

The token for the next page of results.

', 'GetLinkAssociationsRequest$NextToken' => '

The token for the next page of results.

', 'GetLinkAssociationsResponse$NextToken' => '

The token for the next page of results.

', 'GetLinksRequest$NextToken' => '

The token for the next page of results.

', 'GetLinksResponse$NextToken' => '

The token for the next page of results.

', 'GetNetworkResourceCountsRequest$NextToken' => '

The token for the next page of results.

', 'GetNetworkResourceCountsResponse$NextToken' => '

The token for the next page of results.

', 'GetNetworkResourceRelationshipsRequest$NextToken' => '

The token for the next page of results.

', 'GetNetworkResourceRelationshipsResponse$NextToken' => '

The token for the next page of results.

', 'GetNetworkResourcesRequest$NextToken' => '

The token for the next page of results.

', 'GetNetworkResourcesResponse$NextToken' => '

The token for the next page of results.

', 'GetNetworkTelemetryRequest$NextToken' => '

The token for the next page of results.

', 'GetNetworkTelemetryResponse$NextToken' => '

The token for the next page of results.

', 'GetSitesRequest$NextToken' => '

The token for the next page of results.

', 'GetSitesResponse$NextToken' => '

The token for the next page of results.

', 'GetTransitGatewayConnectPeerAssociationsRequest$NextToken' => '

The token for the next page of results.

', 'GetTransitGatewayConnectPeerAssociationsResponse$NextToken' => '

The token to use for the next page of results.

', 'GetTransitGatewayRegistrationsRequest$NextToken' => '

The token for the next page of results.

', 'GetTransitGatewayRegistrationsResponse$NextToken' => '

The token for the next page of results.

', 'ListAttachmentsRequest$NextToken' => '

The token for the next page of results.

', 'ListAttachmentsResponse$NextToken' => '

The token for the next page of results.

', 'ListConnectPeersRequest$NextToken' => '

The token for the next page of results.

', 'ListConnectPeersResponse$NextToken' => '

The token for the next page of results.

', 'ListCoreNetworkPolicyVersionsRequest$NextToken' => '

The token for the next page of results.

', 'ListCoreNetworkPolicyVersionsResponse$NextToken' => '

The token for the next page of results.

', 'ListCoreNetworksRequest$NextToken' => '

The token for the next page of results.

', 'ListCoreNetworksResponse$NextToken' => '

The token for the next page of results.

', 'ListOrganizationServiceAccessStatusRequest$NextToken' => '

The token for the next page of results.

', 'ListOrganizationServiceAccessStatusResponse$NextToken' => '

The token for the next page of results.

', 'ListPeeringsRequest$NextToken' => '

The token for the next page of results.

', 'ListPeeringsResponse$NextToken' => '

The token for the next page of results.

', ], ], 'OrganizationAwsServiceAccessStatus' => [ 'base' => NULL, 'refs' => [ 'OrganizationStatus$OrganizationAwsServiceAccessStatus' => '

The status of the organization\'s AWS service access. This will be ENABLED or DISABLED.

', ], ], 'OrganizationId' => [ 'base' => NULL, 'refs' => [ 'OrganizationStatus$OrganizationId' => '

The ID of an Amazon Web Services Organization.

', ], ], 'OrganizationStatus' => [ 'base' => '

The status of an Amazon Web Services Organization and the accounts within that organization.

', 'refs' => [ 'ListOrganizationServiceAccessStatusResponse$OrganizationStatus' => '

Displays the status of an Amazon Web Services Organization.

', 'StartOrganizationServiceAccessUpdateResponse$OrganizationStatus' => '

The status of the service access update request for an Amazon Web Services Organization.

', ], ], 'PathComponent' => [ 'base' => '

Describes a path component.

', 'refs' => [ 'PathComponentList$member' => NULL, ], ], 'PathComponentList' => [ 'base' => NULL, 'refs' => [ 'RouteAnalysisPath$Path' => '

The route analysis path.

', ], ], 'Peering' => [ 'base' => '

Describes a peering connection.

', 'refs' => [ 'DeletePeeringResponse$Peering' => '

Information about a deleted peering connection.

', 'PeeringList$member' => NULL, 'TransitGatewayPeering$Peering' => '

Describes a transit gateway peer connection.

', ], ], 'PeeringError' => [ 'base' => '

Describes an error associated with a peering request.

', 'refs' => [ 'PeeringErrorList$member' => NULL, ], ], 'PeeringErrorCode' => [ 'base' => NULL, 'refs' => [ 'PeeringError$Code' => '

The error code for the peering request.

', ], ], 'PeeringErrorList' => [ 'base' => NULL, 'refs' => [ 'Peering$LastModificationErrors' => '

Describes the error associated with the Connect peer request.

', ], ], 'PeeringId' => [ 'base' => NULL, 'refs' => [ 'CreateTransitGatewayRouteTableAttachmentRequest$PeeringId' => '

The ID of the peer for the

', 'DeletePeeringRequest$PeeringId' => '

The ID of the peering connection to delete.

', 'GetTransitGatewayPeeringRequest$PeeringId' => '

The ID of the peering request.

', 'Peering$PeeringId' => '

The ID of the peering attachment.

', 'TransitGatewayRouteTableAttachment$PeeringId' => '

The ID of the peering attachment.

', ], ], 'PeeringList' => [ 'base' => NULL, 'refs' => [ 'ListPeeringsResponse$Peerings' => '

Lists the transit gateway peerings for the ListPeerings request.

', ], ], 'PeeringState' => [ 'base' => NULL, 'refs' => [ 'ListPeeringsRequest$State' => '

Returns a list of the peering request states.

', 'Peering$State' => '

The current state of the peering connection.

', ], ], 'PeeringType' => [ 'base' => NULL, 'refs' => [ 'ListPeeringsRequest$PeeringType' => '

Returns a list of a peering requests.

', 'Peering$PeeringType' => '

The type of peering. This will be TRANSIT_GATEWAY.

', ], ], 'PermissionsErrorContext' => [ 'base' => '

Describes additional information about missing permissions.

', 'refs' => [ 'PeeringError$MissingPermissionsContext' => '

Provides additional information about missing permissions for the peering error.

', ], ], 'ProposedNetworkFunctionGroupChange' => [ 'base' => '

Describes proposed changes to a network function group.

', 'refs' => [ 'Attachment$ProposedNetworkFunctionGroupChange' => '

Describes a proposed change to a network function group associated with the attachment.

', ], ], 'ProposedSegmentChange' => [ 'base' => '

Describes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.

', 'refs' => [ 'Attachment$ProposedSegmentChange' => '

The attachment to move from one segment to another.

', ], ], 'PutCoreNetworkPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutCoreNetworkPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'ReasonContextKey' => [ 'base' => NULL, 'refs' => [ 'ReasonContextMap$key' => NULL, ], ], 'ReasonContextMap' => [ 'base' => NULL, 'refs' => [ 'RouteAnalysisCompletion$ReasonContext' => '

Additional information about the path. Available only if a connection is not found.

', ], ], 'ReasonContextValue' => [ 'base' => NULL, 'refs' => [ 'ReasonContextMap$value' => NULL, ], ], 'RegisterTransitGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTransitGatewayResponse' => [ 'base' => NULL, 'refs' => [], ], 'RejectAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'RejectAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'Relationship' => [ 'base' => '

Describes a resource relationship.

', 'refs' => [ 'RelationshipList$member' => NULL, ], ], 'RelationshipList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkResourceRelationshipsResponse$Relationships' => '

The resource relationships.

', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'Attachment$ResourceArn' => '

The attachment resource ARN.

', 'AttachmentError$ResourceArn' => '

The ARN of the requested attachment resource.

', 'ConnectPeerError$ResourceArn' => '

The ARN of the requested Connect peer resource.

', 'DeleteResourcePolicyRequest$ResourceArn' => '

The ARN of the policy to delete.

', 'GetNetworkResourceRelationshipsRequest$RegisteredGatewayArn' => '

The ARN of the registered gateway.

', 'GetNetworkResourceRelationshipsRequest$ResourceArn' => '

The ARN of the gateway.

', 'GetNetworkResourcesRequest$RegisteredGatewayArn' => '

The ARN of the gateway.

', 'GetNetworkResourcesRequest$ResourceArn' => '

The ARN of the resource.

', 'GetNetworkRoutesResponse$RouteTableArn' => '

The ARN of the route table.

', 'GetNetworkTelemetryRequest$RegisteredGatewayArn' => '

The ARN of the gateway.

', 'GetNetworkTelemetryRequest$ResourceArn' => '

The ARN of the resource.

', 'GetResourcePolicyRequest$ResourceArn' => '

The ARN of the resource.

', 'ListTagsForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'NetworkResource$RegisteredGatewayArn' => '

The ARN of the gateway.

', 'NetworkResource$ResourceArn' => '

The ARN of the resource.

', 'NetworkResourceSummary$RegisteredGatewayArn' => '

The ARN of the gateway.

', 'NetworkResourceSummary$ResourceArn' => '

The ARN of the resource.

', 'NetworkTelemetry$RegisteredGatewayArn' => '

The ARN of the gateway.

', 'NetworkTelemetry$ResourceArn' => '

The ARN of the resource.

', 'Peering$ResourceArn' => '

The resource ARN of the peer.

', 'PeeringError$ResourceArn' => '

The ARN of the requested peering resource.

', 'PutResourcePolicyRequest$ResourceArn' => '

The ARN of the resource policy.

', 'TagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'UntagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'UpdateNetworkResourceMetadataRequest$ResourceArn' => '

The ARN of the resource.

', 'UpdateNetworkResourceMetadataResponse$ResourceArn' => '

The ARN of the resource.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

The specified resource could not be found.

', 'refs' => [], ], 'ResourcePolicyDocument' => [ 'base' => NULL, 'refs' => [ 'GetResourcePolicyResponse$PolicyDocument' => '

The resource policy document.

', 'PutResourcePolicyRequest$PolicyDocument' => '

The JSON resource policy document.

', ], ], 'RestoreCoreNetworkPolicyVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestoreCoreNetworkPolicyVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetryAfterSeconds' => [ 'base' => NULL, 'refs' => [ 'InternalServerException$RetryAfterSeconds' => '

Indicates when to retry the request.

', 'ThrottlingException$RetryAfterSeconds' => '

Indicates when to retry the request.

', ], ], 'RouteAnalysis' => [ 'base' => '

Describes a route analysis.

', 'refs' => [ 'GetRouteAnalysisResponse$RouteAnalysis' => '

The route analysis.

', 'StartRouteAnalysisResponse$RouteAnalysis' => '

The route analysis.

', ], ], 'RouteAnalysisCompletion' => [ 'base' => '

Describes the status of an analysis at completion.

', 'refs' => [ 'RouteAnalysisPath$CompletionStatus' => '

The status of the analysis at completion.

', ], ], 'RouteAnalysisCompletionReasonCode' => [ 'base' => NULL, 'refs' => [ 'RouteAnalysisCompletion$ReasonCode' => '

The reason code. Available only if a connection is not found.

', ], ], 'RouteAnalysisCompletionResultCode' => [ 'base' => NULL, 'refs' => [ 'RouteAnalysisCompletion$ResultCode' => '

The result of the analysis. If the status is NOT_CONNECTED, check the reason code.

', ], ], 'RouteAnalysisEndpointOptions' => [ 'base' => '

Describes a source or a destination.

', 'refs' => [ 'RouteAnalysis$Source' => '

The source.

', 'RouteAnalysis$Destination' => '

The destination.

', ], ], 'RouteAnalysisEndpointOptionsSpecification' => [ 'base' => '

Describes a source or a destination.

', 'refs' => [ 'StartRouteAnalysisRequest$Source' => '

The source from which traffic originates.

', 'StartRouteAnalysisRequest$Destination' => '

The destination.

', ], ], 'RouteAnalysisPath' => [ 'base' => '

Describes a route analysis path.

', 'refs' => [ 'RouteAnalysis$ForwardPath' => '

The forward path.

', 'RouteAnalysis$ReturnPath' => '

The return path.

', ], ], 'RouteAnalysisStatus' => [ 'base' => NULL, 'refs' => [ 'RouteAnalysis$Status' => '

The status of the route analysis.

', ], ], 'RouteState' => [ 'base' => NULL, 'refs' => [ 'NetworkRoute$State' => '

The route state. The possible values are active and blackhole.

', 'RouteStateList$member' => NULL, ], ], 'RouteStateList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkRoutesRequest$States' => '

The route states.

', ], ], 'RouteTableIdentifier' => [ 'base' => '

Describes a route table.

', 'refs' => [ 'GetNetworkRoutesRequest$RouteTableIdentifier' => '

The ID of the route table.

', ], ], 'RouteTableType' => [ 'base' => NULL, 'refs' => [ 'GetNetworkRoutesResponse$RouteTableType' => '

The route table type.

', ], ], 'RouteType' => [ 'base' => NULL, 'refs' => [ 'NetworkRoute$Type' => '

The route type. The possible values are propagated and static.

', 'RouteTypeList$member' => NULL, ], ], 'RouteTypeList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkRoutesRequest$Types' => '

The route types.

', ], ], 'SLRDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'AccountStatus$SLRDeploymentStatus' => '

The status of SLR deployment for the account.

', 'OrganizationStatus$SLRDeploymentStatus' => '

The status of the SLR deployment for the account. This will be either SUCCEEDED or IN_PROGRESS.

', ], ], 'SegmentActionServiceInsertion' => [ 'base' => NULL, 'refs' => [ 'ServiceInsertionAction$Action' => '

The action the service insertion takes for traffic. send-via sends east-west traffic between attachments. send-to sends north-south traffic to the security appliance, and then from that to either the Internet or to an on-premesis location.

', ], ], 'SendViaMode' => [ 'base' => NULL, 'refs' => [ 'ServiceInsertionAction$Mode' => '

Describes the mode packets take for the send-via action. This is not used when the action is send-to. dual-hop packets traverse attachments in both the source to the destination core network edges. This mode requires that an inspection attachment must be present in all Regions of the service insertion-enabled segments. For single-hop, packets traverse a single intermediate inserted attachment. You can use EdgeOverride to specify a specific edge to use.

', ], ], 'ServerSideString' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'AttachmentError$Message' => '

The message associated with the error code.

', 'AttachmentError$RequestId' => '

The ID of the attachment request.

', 'ConflictException$Message' => NULL, 'ConflictException$ResourceId' => '

The ID of the resource.

', 'ConflictException$ResourceType' => '

The resource type.

', 'ConnectPeerError$Message' => '

The message associated with the error code.

', 'ConnectPeerError$RequestId' => '

The ID of the Connect peer request.

', 'CoreNetworkPolicyError$ErrorCode' => '

The error code associated with a core network policy error.

', 'CoreNetworkPolicyError$Message' => '

The message associated with a core network policy error code.

', 'CoreNetworkPolicyError$Path' => '

The JSON path where the error was discovered in the policy document.

', 'CoreNetworkPolicyException$Message' => NULL, 'InternalServerException$Message' => NULL, 'PeeringError$Message' => '

The message associated with the error code.

', 'PeeringError$RequestId' => '

The ID of the Peering request.

', 'PermissionsErrorContext$MissingPermission' => '

The missing permissions.

', 'ResourceNotFoundException$Message' => NULL, 'ResourceNotFoundException$ResourceId' => '

The ID of the resource.

', 'ResourceNotFoundException$ResourceType' => '

The resource type.

', 'ServiceQuotaExceededException$Message' => '

The error message.

', 'ServiceQuotaExceededException$ResourceId' => '

The ID of the resource.

', 'ServiceQuotaExceededException$ResourceType' => '

The resource type.

', 'ServiceQuotaExceededException$LimitCode' => '

The limit code.

', 'ServiceQuotaExceededException$ServiceCode' => '

The service code.

', 'ThrottlingException$Message' => NULL, 'ValidationException$Message' => NULL, 'ValidationExceptionField$Name' => '

The name of the field.

', 'ValidationExceptionField$Message' => '

The message for the field.

', ], ], 'ServiceInsertionAction' => [ 'base' => '

Describes the action that the service insertion will take for any segments associated with it.

', 'refs' => [ 'ServiceInsertionActionList$member' => NULL, ], ], 'ServiceInsertionActionList' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkChangeValues$ServiceInsertionActions' => '

Describes the service insertion action.

', ], ], 'ServiceInsertionSegments' => [ 'base' => '

Describes the segments associated with the service insertion action.

', 'refs' => [ 'CoreNetworkNetworkFunctionGroup$Segments' => '

The segments associated with the network function group.

', ], ], 'ServiceQuotaExceededException' => [ 'base' => '

A service limit was exceeded.

', 'refs' => [], ], 'Site' => [ 'base' => '

Describes a site.

', 'refs' => [ 'CreateSiteResponse$Site' => '

Information about the site.

', 'DeleteSiteResponse$Site' => '

Information about the site.

', 'SiteList$member' => NULL, 'UpdateSiteResponse$Site' => '

Information about the site.

', ], ], 'SiteArn' => [ 'base' => NULL, 'refs' => [ 'Site$SiteArn' => '

The Amazon Resource Name (ARN) of the site.

', ], ], 'SiteId' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceRequest$SiteId' => '

The ID of the site.

', 'CreateLinkRequest$SiteId' => '

The ID of the site.

', 'DeleteSiteRequest$SiteId' => '

The ID of the site.

', 'Device$SiteId' => '

The site ID.

', 'GetDevicesRequest$SiteId' => '

The ID of the site.

', 'GetLinksRequest$SiteId' => '

The ID of the site.

', 'Link$SiteId' => '

The ID of the site.

', 'Site$SiteId' => '

The ID of the site.

', 'SiteIdList$member' => NULL, 'UpdateDeviceRequest$SiteId' => '

The ID of the site.

', 'UpdateSiteRequest$SiteId' => '

The ID of your site.

', ], ], 'SiteIdList' => [ 'base' => NULL, 'refs' => [ 'GetSitesRequest$SiteIds' => '

One or more site IDs. The maximum is 10.

', ], ], 'SiteList' => [ 'base' => NULL, 'refs' => [ 'GetSitesResponse$Sites' => '

The sites.

', ], ], 'SiteState' => [ 'base' => NULL, 'refs' => [ 'Site$State' => '

The state of the site.

', ], ], 'SiteToSiteVpnAttachment' => [ 'base' => '

Creates a site-to-site VPN attachment.

', 'refs' => [ 'CreateSiteToSiteVpnAttachmentResponse$SiteToSiteVpnAttachment' => '

Details about a site-to-site VPN attachment.

', 'GetSiteToSiteVpnAttachmentResponse$SiteToSiteVpnAttachment' => '

Describes the site-to-site attachment.

', ], ], 'StartOrganizationServiceAccessUpdateRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartOrganizationServiceAccessUpdateResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartRouteAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRouteAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'SubnetArn' => [ 'base' => NULL, 'refs' => [ 'AWSLocation$SubnetArn' => '

The Amazon Resource Name (ARN) of the subnet that the device is located in.

', 'ConnectPeer$SubnetArn' => '

The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.

', 'ConnectPeerSummary$SubnetArn' => '

The subnet ARN for the Connect peer summary.

', 'CreateConnectPeerRequest$SubnetArn' => '

The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.

', 'SubnetArnList$member' => NULL, ], ], 'SubnetArnList' => [ 'base' => NULL, 'refs' => [ 'CreateVpcAttachmentRequest$SubnetArns' => '

The subnet ARN of the VPC attachment.

', 'UpdateVpcAttachmentRequest$AddSubnetArns' => '

Adds a subnet ARN to the VPC attachment.

', 'UpdateVpcAttachmentRequest$RemoveSubnetArns' => '

Removes a subnet ARN from the attachment.

', 'VpcAttachment$SubnetArns' => '

The subnet ARNs.

', ], ], 'Tag' => [ 'base' => '

Describes a tag.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The tag key.

Constraints: Maximum length of 128 characters.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

The tag keys to remove from the specified resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'Attachment$Tags' => '

The tags associated with the attachment.

', 'ConnectPeer$Tags' => '

The list of key-value tags associated with the Connect peer.

', 'ConnectPeerSummary$Tags' => '

The list of key-value tags associated with the Connect peer summary.

', 'Connection$Tags' => '

The tags for the connection.

', 'CoreNetwork$Tags' => '

The list of key-value tags associated with a core network.

', 'CoreNetworkSummary$Tags' => '

The key-value tags associated with a core network summary.

', 'CreateConnectAttachmentRequest$Tags' => '

The list of key-value tags associated with the request.

', 'CreateConnectPeerRequest$Tags' => '

The tags associated with the peer request.

', 'CreateConnectionRequest$Tags' => '

The tags to apply to the resource during creation.

', 'CreateCoreNetworkRequest$Tags' => '

Key-value tags associated with a core network request.

', 'CreateDeviceRequest$Tags' => '

The tags to apply to the resource during creation.

', 'CreateGlobalNetworkRequest$Tags' => '

The tags to apply to the resource during creation.

', 'CreateLinkRequest$Tags' => '

The tags to apply to the resource during creation.

', 'CreateSiteRequest$Tags' => '

The tags to apply to the resource during creation.

', 'CreateSiteToSiteVpnAttachmentRequest$Tags' => '

The tags associated with the request.

', 'CreateTransitGatewayPeeringRequest$Tags' => '

The list of key-value tags associated with the request.

', 'CreateTransitGatewayRouteTableAttachmentRequest$Tags' => '

The list of key-value tags associated with the request.

', 'CreateVpcAttachmentRequest$Tags' => '

The key-value tags associated with the request.

', 'Device$Tags' => '

The tags for the device.

', 'GlobalNetwork$Tags' => '

The tags for the global network.

', 'Link$Tags' => '

The tags for the link.

', 'ListTagsForResourceResponse$TagList' => '

The list of tags.

', 'NetworkResource$Tags' => '

The tags.

', 'Peering$Tags' => '

The list of key-value tags associated with the peering.

', 'ProposedNetworkFunctionGroupChange$Tags' => '

The list of proposed changes to the key-value tags associated with the network function group.

', 'ProposedSegmentChange$Tags' => '

The list of key-value tags that changed for the segment.

', 'Site$Tags' => '

The tags for the site.

', 'TagResourceRequest$Tags' => '

The tags to apply to the specified resource.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The tag value.

Constraints: Maximum length of 256 characters.

', ], ], 'ThrottlingException' => [ 'base' => '

The request was denied due to request throttling.

', 'refs' => [], ], 'TransitGatewayArn' => [ 'base' => NULL, 'refs' => [ 'CreateTransitGatewayPeeringRequest$TransitGatewayArn' => '

The ARN of the transit gateway for the peering request.

', 'DeregisterTransitGatewayRequest$TransitGatewayArn' => '

The Amazon Resource Name (ARN) of the transit gateway.

', 'RegisterTransitGatewayRequest$TransitGatewayArn' => '

The Amazon Resource Name (ARN) of the transit gateway.

', 'RouteAnalysisEndpointOptions$TransitGatewayArn' => '

The ARN of the transit gateway.

', 'TransitGatewayArnList$member' => NULL, 'TransitGatewayPeering$TransitGatewayArn' => '

The ARN of the transit gateway.

', 'TransitGatewayRegistration$TransitGatewayArn' => '

The Amazon Resource Name (ARN) of the transit gateway.

', ], ], 'TransitGatewayArnList' => [ 'base' => NULL, 'refs' => [ 'GetTransitGatewayRegistrationsRequest$TransitGatewayArns' => '

The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.

', ], ], 'TransitGatewayAttachmentArn' => [ 'base' => NULL, 'refs' => [ 'RouteAnalysisEndpointOptions$TransitGatewayAttachmentArn' => '

The ARN of the transit gateway attachment.

', 'RouteAnalysisEndpointOptionsSpecification$TransitGatewayAttachmentArn' => '

The ARN of the transit gateway attachment.

', ], ], 'TransitGatewayAttachmentId' => [ 'base' => NULL, 'refs' => [ 'NetworkRouteDestination$TransitGatewayAttachmentId' => '

The ID of the transit gateway attachment.

', ], ], 'TransitGatewayConnectPeerArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTransitGatewayConnectPeerRequest$TransitGatewayConnectPeerArn' => '

The Amazon Resource Name (ARN) of the Connect peer.

', 'DisassociateTransitGatewayConnectPeerRequest$TransitGatewayConnectPeerArn' => '

The Amazon Resource Name (ARN) of the transit gateway Connect peer.

', 'TransitGatewayConnectPeerArnList$member' => NULL, 'TransitGatewayConnectPeerAssociation$TransitGatewayConnectPeerArn' => '

The Amazon Resource Name (ARN) of the transit gateway Connect peer.

', ], ], 'TransitGatewayConnectPeerArnList' => [ 'base' => NULL, 'refs' => [ 'GetTransitGatewayConnectPeerAssociationsRequest$TransitGatewayConnectPeerArns' => '

One or more transit gateway Connect peer Amazon Resource Names (ARNs).

', ], ], 'TransitGatewayConnectPeerAssociation' => [ 'base' => '

Describes a transit gateway Connect peer association.

', 'refs' => [ 'AssociateTransitGatewayConnectPeerResponse$TransitGatewayConnectPeerAssociation' => '

The transit gateway Connect peer association.

', 'DisassociateTransitGatewayConnectPeerResponse$TransitGatewayConnectPeerAssociation' => '

The transit gateway Connect peer association.

', 'TransitGatewayConnectPeerAssociationList$member' => NULL, ], ], 'TransitGatewayConnectPeerAssociationList' => [ 'base' => NULL, 'refs' => [ 'GetTransitGatewayConnectPeerAssociationsResponse$TransitGatewayConnectPeerAssociations' => '

Information about the transit gateway Connect peer associations.

', ], ], 'TransitGatewayConnectPeerAssociationState' => [ 'base' => NULL, 'refs' => [ 'TransitGatewayConnectPeerAssociation$State' => '

The state of the association.

', ], ], 'TransitGatewayPeering' => [ 'base' => '

Describes a transit gateway peering attachment.

', 'refs' => [ 'CreateTransitGatewayPeeringResponse$TransitGatewayPeering' => '

Returns information about the transit gateway peering connection request.

', 'GetTransitGatewayPeeringResponse$TransitGatewayPeering' => '

Returns information about a transit gateway peering.

', ], ], 'TransitGatewayPeeringAttachmentId' => [ 'base' => NULL, 'refs' => [ 'TransitGatewayPeering$TransitGatewayPeeringAttachmentId' => '

The ID of the transit gateway peering attachment.

', ], ], 'TransitGatewayRegistration' => [ 'base' => '

Describes the registration of a transit gateway to a global network.

', 'refs' => [ 'DeregisterTransitGatewayResponse$TransitGatewayRegistration' => '

The transit gateway registration information.

', 'RegisterTransitGatewayResponse$TransitGatewayRegistration' => '

Information about the transit gateway registration.

', 'TransitGatewayRegistrationList$member' => NULL, ], ], 'TransitGatewayRegistrationList' => [ 'base' => NULL, 'refs' => [ 'GetTransitGatewayRegistrationsResponse$TransitGatewayRegistrations' => '

The transit gateway registrations.

', ], ], 'TransitGatewayRegistrationState' => [ 'base' => NULL, 'refs' => [ 'TransitGatewayRegistrationStateReason$Code' => '

The code for the state reason.

', ], ], 'TransitGatewayRegistrationStateReason' => [ 'base' => '

Describes the status of a transit gateway registration.

', 'refs' => [ 'TransitGatewayRegistration$State' => '

The state of the transit gateway registration.

', ], ], 'TransitGatewayRouteTableArn' => [ 'base' => NULL, 'refs' => [ 'CreateTransitGatewayRouteTableAttachmentRequest$TransitGatewayRouteTableArn' => '

The ARN of the transit gateway route table for the attachment request. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

', 'RouteTableIdentifier$TransitGatewayRouteTableArn' => '

The ARN of the transit gateway route table for the attachment request. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

', 'TransitGatewayRouteTableAttachment$TransitGatewayRouteTableArn' => '

The ARN of the transit gateway attachment route table. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

', ], ], 'TransitGatewayRouteTableAttachment' => [ 'base' => '

Describes a transit gateway route table attachment.

', 'refs' => [ 'CreateTransitGatewayRouteTableAttachmentResponse$TransitGatewayRouteTableAttachment' => '

The route table associated with the create transit gateway route table attachment request.

', 'GetTransitGatewayRouteTableAttachmentResponse$TransitGatewayRouteTableAttachment' => '

Returns information about the transit gateway route table attachment.

', ], ], 'TunnelProtocol' => [ 'base' => NULL, 'refs' => [ 'ConnectAttachmentOptions$Protocol' => '

The protocol used for the attachment connection.

', 'ConnectPeerConfiguration$Protocol' => '

The protocol used for a Connect peer configuration.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCoreNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCoreNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGlobalNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGlobalNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLinkRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLinkResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNetworkResourceMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNetworkResourceMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSiteResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVpcAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVpcAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '

The input fails to satisfy the constraints.

', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => '

Describes a validation exception for a field.

', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => NULL, 'refs' => [ 'ValidationException$Fields' => '

The fields that caused the error, if applicable.

', ], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$Reason' => '

The reason for the error.

', ], ], 'Via' => [ 'base' => '

The list of network function groups and edge overrides for the service insertion action. Used for both the send-to and send-via actions.

', 'refs' => [ 'ServiceInsertionAction$Via' => '

The list of network function groups and any edge overrides for the chosen service insertion action. Used for both send-to or send-via.

', ], ], 'VpcArn' => [ 'base' => NULL, 'refs' => [ 'CreateVpcAttachmentRequest$VpcArn' => '

The ARN of the VPC.

', ], ], 'VpcAttachment' => [ 'base' => '

Describes a VPC attachment.

', 'refs' => [ 'CreateVpcAttachmentResponse$VpcAttachment' => '

Provides details about the VPC attachment.

', 'GetVpcAttachmentResponse$VpcAttachment' => '

Returns details about a VPC attachment.

', 'UpdateVpcAttachmentResponse$VpcAttachment' => '

Describes the updated VPC attachment.

', ], ], 'VpcOptions' => [ 'base' => '

Describes the VPC options.

', 'refs' => [ 'CreateVpcAttachmentRequest$Options' => '

Options for the VPC attachment.

', 'UpdateVpcAttachmentRequest$Options' => '

Additional options for updating the VPC attachment.

', 'VpcAttachment$Options' => '

Provides details about the VPC attachment.

', ], ], 'VpnConnectionArn' => [ 'base' => NULL, 'refs' => [ 'CreateSiteToSiteVpnAttachmentRequest$VpnConnectionArn' => '

The ARN identifying the VPN attachment.

', 'SiteToSiteVpnAttachment$VpnConnectionArn' => '

The ARN of the site-to-site VPN attachment.

', ], ], 'WhenSentTo' => [ 'base' => '

Displays a list of the destination segments. Used only when the service insertion action is send-to.

', 'refs' => [ 'ServiceInsertionAction$WhenSentTo' => '

The list of destination segments if the service insertion action is send-via.

', ], ], 'WhenSentToSegmentsList' => [ 'base' => NULL, 'refs' => [ 'WhenSentTo$WhenSentToSegmentsList' => '

The list of destination segments when the service insertion action is send-to.

', ], ], 'WithEdgeOverridesList' => [ 'base' => NULL, 'refs' => [ 'Via$WithEdgeOverrides' => '

Describes any edge overrides. An edge override is a specific edge to be used for traffic.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => '

Amazon Web Services enables you to centrally manage your Amazon Web Services Cloud WAN core network and your Transit Gateway network across Amazon Web Services accounts, Regions, and on-premises locations.

', 'operations' => [ 'AcceptAttachment' => '

Accepts a core network attachment request.

Once the attachment request is accepted by a core network owner, the attachment is created and connected to a core network.

', 'AssociateConnectPeer' => '

Associates a core network Connect peer 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 core network Connect peers that have been created on a core network Connect attachment on a core network.

', 'AssociateCustomerGateway' => '

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 or core network registered in your global network. When you register a transit gateway or core network, 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' => '

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.

', 'AssociateTransitGatewayConnectPeer' => '

Associates a transit gateway Connect peer 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 transit gateway Connect peers that have been created on a transit gateway that\'s registered in your global network.

You cannot associate a transit gateway Connect peer with more than one device and link.

', 'CreateConnectAttachment' => '

Creates a core network Connect attachment from a specified core network attachment.

A core network Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a core network and an appliance. A core network Connect attachment uses an existing VPC attachment as the underlying transport mechanism.

', 'CreateConnectPeer' => '

Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

', 'CreateConnection' => '

Creates a connection between two devices. The devices can be a physical or virtual appliance that connects to a third-party appliance in a VPC, or a physical appliance that connects to another physical appliance in an on-premises network.

', 'CreateCoreNetwork' => '

Creates a core network as part of your global network, and optionally, with a core network policy.

', 'CreateDevice' => '

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.

', 'CreateDirectConnectGatewayAttachment' => '

Creates an Amazon Web Services Direct Connect gateway attachment

', 'CreateGlobalNetwork' => '

Creates a new, empty global network.

', 'CreateLink' => '

Creates a new link for a specified site.

', 'CreateSite' => '

Creates a new site in a global network.

', 'CreateSiteToSiteVpnAttachment' => '

Creates an Amazon Web Services site-to-site VPN attachment on an edge location of a core network.

', 'CreateTransitGatewayPeering' => '

Creates a transit gateway peering connection.

', 'CreateTransitGatewayRouteTableAttachment' => '

Creates a transit gateway route table attachment.

', 'CreateVpcAttachment' => '

Creates a VPC attachment on an edge location of a core network.

', 'DeleteAttachment' => '

Deletes an attachment. Supports all attachment types.

', 'DeleteConnectPeer' => '

Deletes a Connect peer.

', 'DeleteConnection' => '

Deletes the specified connection in your global network.

', 'DeleteCoreNetwork' => '

Deletes a core network along with all core network policies. This can only be done if there are no attachments on a core network.

', 'DeleteCoreNetworkPolicyVersion' => '

Deletes a policy version from a core network. You can\'t delete the current LIVE policy.

', 'DeleteDevice' => '

Deletes an existing device. You must first disassociate the device from any links and customer gateways.

', 'DeleteGlobalNetwork' => '

Deletes an existing global network. You must first delete all global network objects (devices, links, and sites), deregister all transit gateways, and delete any core networks.

', 'DeleteLink' => '

Deletes an existing link. You must first disassociate the link from any devices and customer gateways.

', 'DeletePeering' => '

Deletes an existing peering connection.

', 'DeleteResourcePolicy' => '

Deletes a resource policy for the specified resource. This revokes the access of the principals specified in the resource policy.

', 'DeleteSite' => '

Deletes an existing site. The site cannot be associated with any device or link.

', 'DeregisterTransitGateway' => '

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' => '

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.

', 'DisassociateConnectPeer' => '

Disassociates a core network Connect peer from a device and a link.

', 'DisassociateCustomerGateway' => '

Disassociates a customer gateway from a device and a link.

', 'DisassociateLink' => '

Disassociates an existing device from a link. You must first disassociate any customer gateways that are associated with the link.

', 'DisassociateTransitGatewayConnectPeer' => '

Disassociates a transit gateway Connect peer from a device and link.

', 'ExecuteCoreNetworkChangeSet' => '

Executes a change set on your core network. Deploys changes globally based on the policy submitted..

', 'GetConnectAttachment' => '

Returns information about a core network Connect attachment.

', 'GetConnectPeer' => '

Returns information about a core network Connect peer.

', 'GetConnectPeerAssociations' => '

Returns information about a core network Connect peer associations.

', 'GetConnections' => '

Gets information about one or more of your connections in a global network.

', 'GetCoreNetwork' => '

Returns information about the LIVE policy for a core network.

', 'GetCoreNetworkChangeEvents' => '

Returns information about a core network change event.

', 'GetCoreNetworkChangeSet' => '

Returns a change set between the LIVE core network policy and a submitted policy.

', 'GetCoreNetworkPolicy' => '

Returns details about a core network policy. You can get details about your current live policy or any previous policy version.

', 'GetCustomerGatewayAssociations' => '

Gets the association information for customer gateways that are associated with devices and links in your global network.

', 'GetDevices' => '

Gets information about one or more of your devices in a global network.

', 'GetDirectConnectGatewayAttachment' => '

Returns information about a specific Amazon Web Services Direct Connect gateway attachment.

', 'GetLinkAssociations' => '

Gets the link associations for a device or a link. Either the device ID or the link ID must be specified.

', 'GetLinks' => '

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.

', 'GetNetworkResourceCounts' => '

Gets the count of network resources, by resource type, for the specified global network.

', 'GetNetworkResourceRelationships' => '

Gets the network resource relationships for the specified global network.

', 'GetNetworkResources' => '

Describes the network resources for the specified global network.

The results include information from the corresponding Describe call for the resource, minus any sensitive information such as pre-shared keys.

', 'GetNetworkRoutes' => '

Gets the network routes of the specified global network.

', 'GetNetworkTelemetry' => '

Gets the network telemetry of the specified global network.

', 'GetResourcePolicy' => '

Returns information about a resource policy.

', 'GetRouteAnalysis' => '

Gets information about the specified route analysis.

', 'GetSiteToSiteVpnAttachment' => '

Returns information about a site-to-site VPN attachment.

', 'GetSites' => '

Gets information about one or more of your sites in a global network.

', 'GetTransitGatewayConnectPeerAssociations' => '

Gets information about one or more of your transit gateway Connect peer associations in a global network.

', 'GetTransitGatewayPeering' => '

Returns information about a transit gateway peer.

', 'GetTransitGatewayRegistrations' => '

Gets information about the transit gateway registrations in a specified global network.

', 'GetTransitGatewayRouteTableAttachment' => '

Returns information about a transit gateway route table attachment.

', 'GetVpcAttachment' => '

Returns information about a VPC attachment.

', 'ListAttachments' => '

Returns a list of core network attachments.

', 'ListConnectPeers' => '

Returns a list of core network Connect peers.

', 'ListCoreNetworkPolicyVersions' => '

Returns a list of core network policy versions.

', 'ListCoreNetworks' => '

Returns a list of owned and shared core networks.

', 'ListOrganizationServiceAccessStatus' => '

Gets the status of the Service Linked Role (SLR) deployment for the accounts in a given Amazon Web Services Organization.

', 'ListPeerings' => '

Lists the peerings for a core network.

', 'ListTagsForResource' => '

Lists the tags for a specified resource.

', 'PutCoreNetworkPolicy' => '

Creates a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and the submitted policy.

', 'PutResourcePolicy' => '

Creates or updates a resource policy.

', 'RegisterTransitGateway' => '

Registers a transit gateway in your global network. Not all Regions support transit gateways for global networks. For a list of the supported Regions, see Region Availability in the Amazon Web Services Transit Gateways for Global Networks User Guide. The transit gateway can be in any of the supported Amazon Web Services Regions, but it must be owned by the same Amazon Web Services account that owns the global network. You cannot register a transit gateway in more than one global network.

', 'RejectAttachment' => '

Rejects a core network attachment request.

', 'RestoreCoreNetworkPolicyVersion' => '

Restores a previous policy version as a new, immutable version of a core network policy. A subsequent change set is created showing the differences between the LIVE policy and restored policy.

', 'StartOrganizationServiceAccessUpdate' => '

Enables the Network Manager service for an Amazon Web Services Organization. This can only be called by a management account within the organization.

', 'StartRouteAnalysis' => '

Starts analyzing the routing path between the specified source and destination. For more information, see Route Analyzer.

', 'TagResource' => '

Tags a specified resource.

', 'UntagResource' => '

Removes tags from a specified resource.

', 'UpdateConnection' => '

Updates the information for an existing connection. To remove information for any of the parameters, specify an empty string.

', 'UpdateCoreNetwork' => '

Updates the description of a core network.

', 'UpdateDevice' => '

Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.

', 'UpdateDirectConnectGatewayAttachment' => '

Updates the edge locations associated with an Amazon Web Services Direct Connect gateway attachment.

', 'UpdateGlobalNetwork' => '

Updates an existing global network. To remove information for any of the parameters, specify an empty string.

', 'UpdateLink' => '

Updates the details for an existing link. To remove information for any of the parameters, specify an empty string.

', 'UpdateNetworkResourceMetadata' => '

Updates the resource metadata for the specified global network.

', 'UpdateSite' => '

Updates the information for an existing site. To remove information for any of the parameters, specify an empty string.

', 'UpdateVpcAttachment' => '

Updates a VPC attachment.

', ], 'shapes' => [ 'AWSAccountId' => [ 'base' => NULL, 'refs' => [ 'Attachment$OwnerAccountId' => '

The ID of the attachment account owner.

', 'CoreNetworkSummary$OwnerAccountId' => '

The ID of the account owner.

', 'GetNetworkResourceRelationshipsRequest$AccountId' => '

The Amazon Web Services account ID.

', 'GetNetworkResourcesRequest$AccountId' => '

The Amazon Web Services account ID.

', 'GetNetworkTelemetryRequest$AccountId' => '

The Amazon Web Services account ID.

', 'NetworkResource$AccountId' => '

The Amazon Web Services account ID.

', 'NetworkTelemetry$AccountId' => '

The Amazon Web Services account ID.

', 'Peering$OwnerAccountId' => '

The ID of the account owner.

', 'RouteAnalysis$OwnerAccountId' => '

The ID of the AWS account that created the route analysis.

', ], ], 'AWSLocation' => [ 'base' => '

Specifies a location in Amazon Web Services.

', 'refs' => [ 'CreateDeviceRequest$AWSLocation' => '

The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

', 'Device$AWSLocation' => '

The Amazon Web Services location of the device.

', 'UpdateDeviceRequest$AWSLocation' => '

The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.

', ], ], 'AcceptAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'AcceptAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'AccessDeniedException' => [ 'base' => '

You do not have sufficient access to perform this action.

', 'refs' => [], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'AccountStatus$AccountId' => '

The ID of an account within the Amazon Web Services Organization.

', ], ], 'AccountStatus' => [ 'base' => '

Describes the current status of an account within an Amazon Web Services Organization, including service-linked roles (SLRs).

', 'refs' => [ 'AccountStatusList$member' => NULL, ], ], 'AccountStatusList' => [ 'base' => NULL, 'refs' => [ 'OrganizationStatus$AccountStatusList' => '

The current service-linked role (SLR) deployment status for an Amazon Web Services Organization\'s accounts. This will be either SUCCEEDED or IN_PROGRESS.

', ], ], 'Action' => [ 'base' => NULL, 'refs' => [ 'StartOrganizationServiceAccessUpdateRequest$Action' => '

The action to take for the update request. This can be either ENABLE or DISABLE.

', ], ], 'AssociateConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateCustomerGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateCustomerGatewayResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateLinkRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateLinkResponse' => [ 'base' => NULL, 'refs' => [], ], 'AssociateTransitGatewayConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'AssociateTransitGatewayConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'Attachment' => [ 'base' => '

Describes a core network attachment.

', 'refs' => [ 'AcceptAttachmentResponse$Attachment' => '

The response to the attachment request.

', 'AttachmentList$member' => NULL, 'ConnectAttachment$Attachment' => '

The attachment details.

', 'DeleteAttachmentResponse$Attachment' => '

Information about the deleted attachment.

', 'DirectConnectGatewayAttachment$Attachment' => NULL, 'RejectAttachmentResponse$Attachment' => '

Describes the rejected attachment request.

', 'SiteToSiteVpnAttachment$Attachment' => '

Provides details about a site-to-site VPN attachment.

', 'TransitGatewayRouteTableAttachment$Attachment' => NULL, 'VpcAttachment$Attachment' => '

Provides details about the VPC attachment.

', ], ], 'AttachmentError' => [ 'base' => '

Describes the error associated with an attachment request.

', 'refs' => [ 'AttachmentErrorList$member' => NULL, ], ], 'AttachmentErrorCode' => [ 'base' => NULL, 'refs' => [ 'AttachmentError$Code' => '

The error code for the attachment request.

', ], ], 'AttachmentErrorList' => [ 'base' => NULL, 'refs' => [ 'Attachment$LastModificationErrors' => '

Describes the error associated with the attachment request.

', ], ], 'AttachmentId' => [ 'base' => NULL, 'refs' => [ 'AcceptAttachmentRequest$AttachmentId' => '

The ID of the attachment.

', 'Attachment$AttachmentId' => '

The ID of the attachment.

', 'ConnectAttachment$TransportAttachmentId' => '

The ID of the transport attachment.

', 'ConnectPeer$ConnectAttachmentId' => '

The ID of the attachment to connect.

', 'ConnectPeerSummary$ConnectAttachmentId' => '

The ID of a Connect peer attachment.

', 'CoreNetworkChangeEventValues$AttachmentId' => '

The ID of the attachment if the change event is associated with an attachment.

', 'CreateConnectAttachmentRequest$TransportAttachmentId' => '

The ID of the attachment between the two connections.

', 'CreateConnectPeerRequest$ConnectAttachmentId' => '

The ID of the connection attachment.

', 'DeleteAttachmentRequest$AttachmentId' => '

The ID of the attachment to delete.

', 'GetConnectAttachmentRequest$AttachmentId' => '

The ID of the attachment.

', 'GetDirectConnectGatewayAttachmentRequest$AttachmentId' => '

The ID of the Direct Connect gateway attachment that you want to see details about.

', 'GetSiteToSiteVpnAttachmentRequest$AttachmentId' => '

The ID of the attachment.

', 'GetTransitGatewayRouteTableAttachmentRequest$AttachmentId' => '

The ID of the transit gateway route table attachment.

', 'GetVpcAttachmentRequest$AttachmentId' => '

The ID of the attachment.

', 'ListConnectPeersRequest$ConnectAttachmentId' => '

The ID of the attachment.

', 'NetworkRouteDestination$CoreNetworkAttachmentId' => '

The ID of a core network attachment.

', 'RejectAttachmentRequest$AttachmentId' => '

The ID of the attachment.

', 'UpdateDirectConnectGatewayAttachmentRequest$AttachmentId' => '

The ID of the Direct Connect gateway attachment for the updated edge locations.

', 'UpdateVpcAttachmentRequest$AttachmentId' => '

The ID of the attachment.

', ], ], 'AttachmentList' => [ 'base' => NULL, 'refs' => [ 'ListAttachmentsResponse$Attachments' => '

Describes the list of attachments.

', ], ], 'AttachmentState' => [ 'base' => NULL, 'refs' => [ 'Attachment$State' => '

The state of the attachment.

', 'ListAttachmentsRequest$State' => '

The state of the attachment.

', ], ], 'AttachmentType' => [ 'base' => NULL, 'refs' => [ 'Attachment$AttachmentType' => '

The type of attachment.

', 'ListAttachmentsRequest$AttachmentType' => '

The type of attachment.

', ], ], 'Bandwidth' => [ 'base' => '

Describes bandwidth information.

', 'refs' => [ 'CreateLinkRequest$Bandwidth' => '

The upload speed and download speed in Mbps.

', 'Link$Bandwidth' => '

The bandwidth for the link.

', 'UpdateLinkRequest$Bandwidth' => '

The upload and download speed in Mbps.

', ], ], 'BgpOptions' => [ 'base' => '

Describes the BGP options.

', 'refs' => [ 'CreateConnectPeerRequest$BgpOptions' => '

The Connect peer BGP options. This only applies only when the protocol is GRE.

', ], ], 'Boolean' => [ 'base' => NULL, 'refs' => [ 'NetworkResourceSummary$IsMiddlebox' => '

Indicates whether this is a middlebox appliance.

', 'RouteAnalysis$IncludeReturnPath' => '

Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.

', 'RouteAnalysis$UseMiddleboxes' => '

Indicates whether to include the location of middlebox appliances in the route analysis.

', 'StartRouteAnalysisRequest$IncludeReturnPath' => '

Indicates whether to analyze the return path. The default is false.

', 'StartRouteAnalysisRequest$UseMiddleboxes' => '

Indicates whether to include the location of middlebox appliances in the route analysis. The default is false.

', 'VpcOptions$Ipv6Support' => '

Indicates whether IPv6 is supported.

', 'VpcOptions$ApplianceModeSupport' => '

Indicates whether appliance mode is supported. If enabled, traffic flow between a source and destination use the same Availability Zone for the VPC attachment for the lifetime of that flow. The default value is false.

', ], ], 'ChangeAction' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkChange$Action' => '

The action to take for a core network.

', 'CoreNetworkChangeEvent$Action' => '

The action taken for the change event.

', ], ], 'ChangeSetState' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkPolicy$ChangeSetState' => '

The state of a core network policy.

', 'CoreNetworkPolicyVersion$ChangeSetState' => '

The status of the policy version change set.

', ], ], 'ChangeStatus' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkChangeEvent$Status' => '

The status of the core network change event.

', ], ], 'ChangeType' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkChange$Type' => '

The type of change.

', 'CoreNetworkChangeEvent$Type' => '

Describes the type of change event.

', ], ], 'ClientToken' => [ 'base' => NULL, 'refs' => [ 'CreateConnectAttachmentRequest$ClientToken' => '

The client token associated with the request.

', 'CreateConnectPeerRequest$ClientToken' => '

The client token associated with the request.

', 'CreateCoreNetworkRequest$ClientToken' => '

The client token associated with a core network request.

', 'CreateDirectConnectGatewayAttachmentRequest$ClientToken' => '

client token

', 'CreateSiteToSiteVpnAttachmentRequest$ClientToken' => '

The client token associated with the request.

', 'CreateTransitGatewayPeeringRequest$ClientToken' => '

The client token associated with the request.

', 'CreateTransitGatewayRouteTableAttachmentRequest$ClientToken' => '

The client token associated with the request.

', 'CreateVpcAttachmentRequest$ClientToken' => '

The client token associated with the request.

', 'PutCoreNetworkPolicyRequest$ClientToken' => '

The client token associated with the request.

', ], ], 'ConflictException' => [ 'base' => '

There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.

', 'refs' => [], ], 'ConnectAttachment' => [ 'base' => '

Describes a core network Connect attachment.

', 'refs' => [ 'CreateConnectAttachmentResponse$ConnectAttachment' => '

The response to a Connect attachment request.

', 'GetConnectAttachmentResponse$ConnectAttachment' => '

Details about the Connect attachment.

', ], ], 'ConnectAttachmentOptions' => [ 'base' => '

Describes a core network Connect attachment options.

', 'refs' => [ 'ConnectAttachment$Options' => '

Options for connecting an attachment.

', 'CreateConnectAttachmentRequest$Options' => '

Options for creating an attachment.

', ], ], 'ConnectPeer' => [ 'base' => '

Describes a core network Connect peer.

', 'refs' => [ 'CreateConnectPeerResponse$ConnectPeer' => '

The response to the request.

', 'DeleteConnectPeerResponse$ConnectPeer' => '

Information about the deleted Connect peer.

', 'GetConnectPeerResponse$ConnectPeer' => '

Returns information about a core network Connect peer.

', ], ], 'ConnectPeerAssociation' => [ 'base' => '

Describes a core network Connect peer association.

', 'refs' => [ 'AssociateConnectPeerResponse$ConnectPeerAssociation' => '

The response to the Connect peer request.

', 'ConnectPeerAssociationList$member' => NULL, 'DisassociateConnectPeerResponse$ConnectPeerAssociation' => '

Describes the Connect peer association.

', ], ], 'ConnectPeerAssociationList' => [ 'base' => NULL, 'refs' => [ 'GetConnectPeerAssociationsResponse$ConnectPeerAssociations' => '

Displays a list of Connect peer associations.

', ], ], 'ConnectPeerAssociationState' => [ 'base' => NULL, 'refs' => [ 'ConnectPeerAssociation$State' => '

The state of the Connect peer association.

', ], ], 'ConnectPeerBgpConfiguration' => [ 'base' => '

Describes a core network BGP configuration.

', 'refs' => [ 'ConnectPeerBgpConfigurationList$member' => NULL, ], ], 'ConnectPeerBgpConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ConnectPeerConfiguration$BgpConfigurations' => '

The Connect peer BGP configurations.

', ], ], 'ConnectPeerConfiguration' => [ 'base' => '

Describes a core network Connect peer configuration.

', 'refs' => [ 'ConnectPeer$Configuration' => '

The configuration of the Connect peer.

', ], ], 'ConnectPeerError' => [ 'base' => '

Describes an error associated with a Connect peer request

', 'refs' => [ 'ConnectPeerErrorList$member' => NULL, ], ], 'ConnectPeerErrorCode' => [ 'base' => NULL, 'refs' => [ 'ConnectPeerError$Code' => '

The error code for the Connect peer request.

', ], ], 'ConnectPeerErrorList' => [ 'base' => NULL, 'refs' => [ 'ConnectPeer$LastModificationErrors' => '

Describes the error associated with the attachment request.

', ], ], 'ConnectPeerId' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectPeerRequest$ConnectPeerId' => '

The ID of the Connect peer.

', 'ConnectPeer$ConnectPeerId' => '

The ID of the Connect peer.

', 'ConnectPeerAssociation$ConnectPeerId' => '

The ID of the Connect peer.

', 'ConnectPeerIdList$member' => NULL, 'ConnectPeerSummary$ConnectPeerId' => '

The ID of a Connect peer.

', 'DeleteConnectPeerRequest$ConnectPeerId' => '

The ID of the deleted Connect peer.

', 'DisassociateConnectPeerRequest$ConnectPeerId' => '

The ID of the Connect peer to disassociate from a device.

', 'GetConnectPeerRequest$ConnectPeerId' => '

The ID of the Connect peer.

', ], ], 'ConnectPeerIdList' => [ 'base' => NULL, 'refs' => [ 'GetConnectPeerAssociationsRequest$ConnectPeerIds' => '

The IDs of the Connect peers.

', ], ], 'ConnectPeerState' => [ 'base' => NULL, 'refs' => [ 'ConnectPeer$State' => '

The state of the Connect peer.

', 'ConnectPeerSummary$ConnectPeerState' => '

The state of a Connect peer.

', ], ], 'ConnectPeerSummary' => [ 'base' => '

Summary description of a Connect peer.

', 'refs' => [ 'ConnectPeerSummaryList$member' => NULL, ], ], 'ConnectPeerSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListConnectPeersResponse$ConnectPeers' => '

Describes the Connect peers.

', ], ], 'Connection' => [ 'base' => '

Describes a connection.

', 'refs' => [ 'ConnectionList$member' => NULL, 'CreateConnectionResponse$Connection' => '

Information about the connection.

', 'DeleteConnectionResponse$Connection' => '

Information about the connection.

', 'UpdateConnectionResponse$Connection' => '

Information about the connection.

', ], ], 'ConnectionArn' => [ 'base' => NULL, 'refs' => [ 'Connection$ConnectionArn' => '

The Amazon Resource Name (ARN) of the connection.

', ], ], 'ConnectionHealth' => [ 'base' => '

Describes connection health.

', 'refs' => [ 'NetworkTelemetry$Health' => '

The connection health.

', ], ], 'ConnectionId' => [ 'base' => NULL, 'refs' => [ 'Connection$ConnectionId' => '

The ID of the connection.

', 'ConnectionIdList$member' => NULL, 'DeleteConnectionRequest$ConnectionId' => '

The ID of the connection.

', 'UpdateConnectionRequest$ConnectionId' => '

The ID of the connection.

', ], ], 'ConnectionIdList' => [ 'base' => NULL, 'refs' => [ 'GetConnectionsRequest$ConnectionIds' => '

One or more connection IDs.

', ], ], 'ConnectionList' => [ 'base' => NULL, 'refs' => [ 'GetConnectionsResponse$Connections' => '

Information about the connections.

', ], ], 'ConnectionState' => [ 'base' => NULL, 'refs' => [ 'Connection$State' => '

The state of the connection.

', ], ], 'ConnectionStatus' => [ 'base' => NULL, 'refs' => [ 'ConnectionHealth$Status' => '

The connection status.

', ], ], 'ConnectionType' => [ 'base' => NULL, 'refs' => [ 'ConnectionHealth$Type' => '

The connection type.

', ], ], 'ConstrainedString' => [ 'base' => NULL, 'refs' => [ 'AWSLocation$Zone' => '

The Zone that the device is located in. Specify the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.

', 'Attachment$SegmentName' => '

The name of the segment attachment.

', 'Connection$Description' => '

The description of the connection.

', 'ConstrainedStringList$member' => NULL, 'CoreNetwork$Description' => '

The description of a core network.

', 'CoreNetworkChange$Identifier' => '

The resource identifier.

', 'CoreNetworkChange$IdentifierPath' => '

Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment".

', 'CoreNetworkChangeEvent$IdentifierPath' => '

Uniquely identifies the path for a change within the changeset. For example, the IdentifierPath for a core network segment change might be "CORE_NETWORK_SEGMENT/us-east-1/devsegment".

', 'CoreNetworkChangeEventValues$SegmentName' => '

The segment name if the change event is associated with a segment.

', 'CoreNetworkChangeEventValues$NetworkFunctionGroupName' => '

The changed network function group name.

', 'CoreNetworkChangeEventValues$Cidr' => '

For a STATIC_ROUTE event, this is the IP address.

', 'CoreNetworkChangeValues$SegmentName' => '

The names of the segments in a core network.

', 'CoreNetworkChangeValues$NetworkFunctionGroupName' => '

The network function group name if the change event is associated with a network function group.

', 'CoreNetworkChangeValues$Cidr' => '

The IP addresses used for a core network.

', 'CoreNetworkChangeValues$DestinationIdentifier' => '

The ID of the destination.

', 'CoreNetworkNetworkFunctionGroup$Name' => '

The name of the network function group.

', 'CoreNetworkNetworkFunctionGroupIdentifier$NetworkFunctionGroupName' => '

The network function group name.

', 'CoreNetworkPolicy$Description' => '

The description of a core network policy.

', 'CoreNetworkPolicyVersion$Description' => '

The description of a core network policy version.

', 'CoreNetworkSegment$Name' => '

The name of a core network segment.

', 'CoreNetworkSegmentEdgeIdentifier$SegmentName' => '

The name of the segment edge.

', 'CoreNetworkSummary$Description' => '

The description of a core network.

', 'CreateConnectionRequest$Description' => '

A description of the connection.

Length Constraints: Maximum length of 256 characters.

', 'CreateCoreNetworkRequest$Description' => '

The description of a core network.

', 'CreateDeviceRequest$Description' => '

A description of the device.

Constraints: Maximum length of 256 characters.

', 'CreateDeviceRequest$Type' => '

The type of the device.

', 'CreateDeviceRequest$Vendor' => '

The vendor of the device.

Constraints: Maximum length of 128 characters.

', 'CreateDeviceRequest$Model' => '

The model of the device.

Constraints: Maximum length of 128 characters.

', 'CreateDeviceRequest$SerialNumber' => '

The serial number of the device.

Constraints: Maximum length of 128 characters.

', 'CreateGlobalNetworkRequest$Description' => '

A description of the global network.

Constraints: Maximum length of 256 characters.

', 'CreateLinkRequest$Description' => '

A description of the link.

Constraints: Maximum length of 256 characters.

', 'CreateLinkRequest$Type' => '

The type of the link.

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \\ ^

', 'CreateLinkRequest$Provider' => '

The provider of the link.

Constraints: Maximum length of 128 characters. Cannot include the following characters: | \\ ^

', 'CreateSiteRequest$Description' => '

A description of your site.

Constraints: Maximum length of 256 characters.

', 'Device$Description' => '

The description of the device.

', 'Device$Type' => '

The device type.

', 'Device$Vendor' => '

The device vendor.

', 'Device$Model' => '

The device model.

', 'Device$SerialNumber' => '

The device serial number.

', 'EdgeOverride$UseEdge' => '

The edge that should be used when overriding the current edge order.

', 'EdgeSet$member' => NULL, 'GetLinksRequest$Type' => '

The link type.

', 'GetLinksRequest$Provider' => '

The link provider.

', 'GetNetworkResourceCountsRequest$ResourceType' => '

The resource type.

The following are the supported resource types for Direct Connect:

The following are the supported resource types for Network Manager:

The following are the supported resource types for Amazon VPC:

', 'GetNetworkResourceRelationshipsRequest$ResourceType' => '

The resource type.

The following are the supported resource types for Direct Connect:

The following are the supported resource types for Network Manager:

The following are the supported resource types for Amazon VPC:

', 'GetNetworkResourcesRequest$ResourceType' => '

The resource type.

The following are the supported resource types for Direct Connect:

The following are the supported resource types for Network Manager:

The following are the supported resource types for Amazon VPC:

', 'GetNetworkTelemetryRequest$ResourceType' => '

The resource type. The following are the supported resource types:

', 'GetRouteAnalysisRequest$RouteAnalysisId' => '

The ID of the route analysis.

', 'GlobalNetwork$Description' => '

The description of the global network.

', 'Link$Description' => '

The description of the link.

', 'Link$Type' => '

The type of the link.

', 'Link$Provider' => '

The provider of the link.

', 'Location$Address' => '

The physical address.

', 'Location$Latitude' => '

The latitude.

', 'Location$Longitude' => '

The longitude.

', 'NetworkFunctionGroup$Name' => '

The name of the network function group.

', 'NetworkResource$ResourceType' => '

The resource type.

The following are the supported resource types for Direct Connect:

The following are the supported resource types for Network Manager:

The following are the supported resource types for Amazon VPC:

', 'NetworkResource$ResourceId' => '

The ID of the resource.

', 'NetworkResource$Definition' => '

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

', 'NetworkResourceCount$ResourceType' => '

The resource type.

', 'NetworkResourceMetadataMap$key' => NULL, 'NetworkResourceMetadataMap$value' => NULL, 'NetworkResourceSummary$ResourceType' => '

The resource type.

', 'NetworkResourceSummary$Definition' => '

Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.

', 'NetworkResourceSummary$NameTag' => '

The value for the Name tag.

', 'NetworkRoute$DestinationCidrBlock' => '

A unique identifier for the route, such as a CIDR block.

', 'NetworkRoute$PrefixListId' => '

The ID of the prefix list.

', 'NetworkRouteDestination$SegmentName' => '

The name of the segment.

', 'NetworkRouteDestination$NetworkFunctionGroupName' => '

The network function group name associated with the destination.

', 'NetworkRouteDestination$ResourceType' => '

The resource type.

', 'NetworkRouteDestination$ResourceId' => '

The ID of the resource.

', 'NetworkTelemetry$ResourceType' => '

The resource type.

', 'NetworkTelemetry$ResourceId' => '

The ID of the resource.

', 'NetworkTelemetry$Address' => '

The address.

', 'PathComponent$DestinationCidrBlock' => '

The destination CIDR block in the route table.

', 'ProposedNetworkFunctionGroupChange$NetworkFunctionGroupName' => '

The proposed name change for the network function group name.

', 'ProposedSegmentChange$SegmentName' => '

The name of the segment to change.

', 'PutCoreNetworkPolicyRequest$Description' => '

a core network policy description.

', 'Relationship$From' => '

The ARN of the resource.

', 'Relationship$To' => '

The ARN of the resource.

', 'RouteAnalysis$RouteAnalysisId' => '

The ID of the route analysis.

', 'Site$Description' => '

The description of the site.

', 'TransitGatewayRegistrationStateReason$Message' => '

The message for the state reason.

', 'UpdateConnectionRequest$Description' => '

A description of the connection.

Length Constraints: Maximum length of 256 characters.

', 'UpdateCoreNetworkRequest$Description' => '

The description of the update.

', 'UpdateDeviceRequest$Description' => '

A description of the device.

Constraints: Maximum length of 256 characters.

', 'UpdateDeviceRequest$Type' => '

The type of the device.

', 'UpdateDeviceRequest$Vendor' => '

The vendor of the device.

Constraints: Maximum length of 128 characters.

', 'UpdateDeviceRequest$Model' => '

The model of the device.

Constraints: Maximum length of 128 characters.

', 'UpdateDeviceRequest$SerialNumber' => '

The serial number of the device.

Constraints: Maximum length of 128 characters.

', 'UpdateGlobalNetworkRequest$Description' => '

A description of the global network.

Constraints: Maximum length of 256 characters.

', 'UpdateLinkRequest$Description' => '

A description of the link.

Constraints: Maximum length of 256 characters.

', 'UpdateLinkRequest$Type' => '

The type of the link.

Constraints: Maximum length of 128 characters.

', 'UpdateLinkRequest$Provider' => '

The provider of the link.

Constraints: Maximum length of 128 characters.

', 'UpdateSiteRequest$Description' => '

A description of your site.

Constraints: Maximum length of 256 characters.

', 'WhenSentToSegmentsList$member' => NULL, ], ], 'ConstrainedStringList' => [ 'base' => NULL, 'refs' => [ 'ConnectPeerConfiguration$InsideCidrBlocks' => '

The inside IP addresses used for a Connect peer configuration.

', 'CoreNetworkChangeValues$InsideCidrBlocks' => '

The inside IP addresses used for core network change values.

', 'CoreNetworkChangeValues$SharedSegments' => '

The shared segments for a core network change value.

', 'CoreNetworkEdge$InsideCidrBlocks' => '

The inside IP addresses used for core network edges.

', 'CoreNetworkSegment$SharedSegments' => '

The shared segments of a core network.

', 'CreateConnectPeerRequest$InsideCidrBlocks' => '

The inside IP addresses used for BGP peering.

', 'GetNetworkRoutesRequest$ExactCidrMatches' => '

An exact CIDR block.

', 'GetNetworkRoutesRequest$LongestPrefixMatches' => '

The most specific route that matches the traffic (longest prefix match).

', 'GetNetworkRoutesRequest$SubnetOfMatches' => '

The routes with a subnet that match the specified CIDR filter.

', 'GetNetworkRoutesRequest$SupernetOfMatches' => '

The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.

', 'GetNetworkRoutesRequest$PrefixListIds' => '

The IDs of the prefix lists.

', 'ServiceInsertionSegments$SendVia' => '

The list of segments associated with the send-via action.

', 'ServiceInsertionSegments$SendTo' => '

The list of segments associated with the send-to action.

', ], ], 'CoreNetwork' => [ 'base' => '

Describes a core network.

', 'refs' => [ 'CreateCoreNetworkResponse$CoreNetwork' => '

Returns details about a core network.

', 'DeleteCoreNetworkResponse$CoreNetwork' => '

Information about the deleted core network.

', 'GetCoreNetworkResponse$CoreNetwork' => '

Details about a core network.

', 'UpdateCoreNetworkResponse$CoreNetwork' => '

Returns information about a core network update.

', ], ], 'CoreNetworkArn' => [ 'base' => NULL, 'refs' => [ 'Attachment$CoreNetworkArn' => '

The ARN of a core network.

', 'CoreNetwork$CoreNetworkArn' => '

The ARN of a core network.

', 'CoreNetworkSummary$CoreNetworkArn' => '

a core network ARN.

', 'Peering$CoreNetworkArn' => '

The ARN of a core network.

', ], ], 'CoreNetworkChange' => [ 'base' => '

Details describing a core network change.

', 'refs' => [ 'CoreNetworkChangeList$member' => NULL, ], ], 'CoreNetworkChangeEvent' => [ 'base' => '

Describes a core network change event. This can be a change to a segment, attachment, route, etc.

', 'refs' => [ 'CoreNetworkChangeEventList$member' => NULL, ], ], 'CoreNetworkChangeEventList' => [ 'base' => NULL, 'refs' => [ 'GetCoreNetworkChangeEventsResponse$CoreNetworkChangeEvents' => '

The response to GetCoreNetworkChangeEventsRequest.

', ], ], 'CoreNetworkChangeEventValues' => [ 'base' => '

Describes a core network change event.

', 'refs' => [ 'CoreNetworkChangeEvent$Values' => '

Details of the change event.

', ], ], 'CoreNetworkChangeList' => [ 'base' => NULL, 'refs' => [ 'GetCoreNetworkChangeSetResponse$CoreNetworkChanges' => '

Describes a core network changes.

', ], ], 'CoreNetworkChangeValues' => [ 'base' => '

Describes a core network change.

', 'refs' => [ 'CoreNetworkChange$PreviousValues' => '

The previous values for a core network.

', 'CoreNetworkChange$NewValues' => '

The new value for a core network

', ], ], 'CoreNetworkEdge' => [ 'base' => '

Describes a core network edge.

', 'refs' => [ 'CoreNetworkEdgeList$member' => NULL, ], ], 'CoreNetworkEdgeList' => [ 'base' => NULL, 'refs' => [ 'CoreNetwork$Edges' => '

The edges within a core network.

', ], ], 'CoreNetworkId' => [ 'base' => NULL, 'refs' => [ 'Attachment$CoreNetworkId' => '

The ID of a core network.

', 'ConnectPeer$CoreNetworkId' => '

The ID of a core network.

', 'ConnectPeerSummary$CoreNetworkId' => '

The ID of a core network.

', 'CoreNetwork$CoreNetworkId' => '

The ID of a core network.

', 'CoreNetworkNetworkFunctionGroupIdentifier$CoreNetworkId' => '

The ID of the core network.

', 'CoreNetworkPolicy$CoreNetworkId' => '

The ID of a core network.

', 'CoreNetworkPolicyVersion$CoreNetworkId' => '

The ID of a core network.

', 'CoreNetworkSegmentEdgeIdentifier$CoreNetworkId' => '

The ID of a core network.

', 'CoreNetworkSummary$CoreNetworkId' => '

The ID of a core network.

', 'CreateConnectAttachmentRequest$CoreNetworkId' => '

The ID of a core network where you want to create the attachment.

', 'CreateDirectConnectGatewayAttachmentRequest$CoreNetworkId' => '

The ID of the Cloud WAN core network that the Direct Connect gateway attachment should be attached to.

', 'CreateSiteToSiteVpnAttachmentRequest$CoreNetworkId' => '

The ID of a core network where you\'re creating a site-to-site VPN attachment.

', 'CreateTransitGatewayPeeringRequest$CoreNetworkId' => '

The ID of a core network.

', 'CreateVpcAttachmentRequest$CoreNetworkId' => '

The ID of a core network for the VPC attachment.

', 'DeleteCoreNetworkPolicyVersionRequest$CoreNetworkId' => '

The ID of a core network for the deleted policy.

', 'DeleteCoreNetworkRequest$CoreNetworkId' => '

The network ID of the deleted core network.

', 'ExecuteCoreNetworkChangeSetRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetCoreNetworkChangeEventsRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetCoreNetworkChangeSetRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetCoreNetworkPolicyRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetCoreNetworkRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetNetworkResourceRelationshipsRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetNetworkResourcesRequest$CoreNetworkId' => '

The ID of a core network.

', 'GetNetworkTelemetryRequest$CoreNetworkId' => '

The ID of a core network.

', 'ListAttachmentsRequest$CoreNetworkId' => '

The ID of a core network.

', 'ListConnectPeersRequest$CoreNetworkId' => '

The ID of a core network.

', 'ListCoreNetworkPolicyVersionsRequest$CoreNetworkId' => '

The ID of a core network.

', 'ListPeeringsRequest$CoreNetworkId' => '

The ID of a core network.

', 'NetworkResource$CoreNetworkId' => '

The ID of a core network.

', 'NetworkTelemetry$CoreNetworkId' => '

The ID of a core network.

', 'Peering$CoreNetworkId' => '

The ID of the core network for the peering request.

', 'PutCoreNetworkPolicyRequest$CoreNetworkId' => '

The ID of a core network.

', 'RestoreCoreNetworkPolicyVersionRequest$CoreNetworkId' => '

The ID of a core network.

', 'UpdateCoreNetworkRequest$CoreNetworkId' => '

The ID of a core network.

', ], ], 'CoreNetworkNetworkFunctionGroup' => [ 'base' => '

Describes a network function group.

', 'refs' => [ 'CoreNetworkNetworkFunctionGroupList$member' => NULL, ], ], 'CoreNetworkNetworkFunctionGroupIdentifier' => [ 'base' => '

Describes a core network

', 'refs' => [ 'RouteTableIdentifier$CoreNetworkNetworkFunctionGroup' => '

The route table identifier associated with the network function group.

', ], ], 'CoreNetworkNetworkFunctionGroupList' => [ 'base' => NULL, 'refs' => [ 'CoreNetwork$NetworkFunctionGroups' => '

The network function groups associated with a core network.

', ], ], 'CoreNetworkPolicy' => [ 'base' => '

Describes a core network policy. You can have only one LIVE Core Policy.

', 'refs' => [ 'DeleteCoreNetworkPolicyVersionResponse$CoreNetworkPolicy' => '

Returns information about the deleted policy version.

', 'GetCoreNetworkPolicyResponse$CoreNetworkPolicy' => '

The details about a core network policy.

', 'PutCoreNetworkPolicyResponse$CoreNetworkPolicy' => '

Describes the changed core network policy.

', 'RestoreCoreNetworkPolicyVersionResponse$CoreNetworkPolicy' => '

Describes the restored core network policy.

', ], ], 'CoreNetworkPolicyAlias' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkPolicy$Alias' => '

Whether a core network policy is the current LIVE policy or the most recently submitted policy.

', 'CoreNetworkPolicyVersion$Alias' => '

Whether a core network policy is the current policy or the most recently submitted policy.

', 'GetCoreNetworkPolicyRequest$Alias' => '

The alias of a core network policy

', ], ], 'CoreNetworkPolicyDocument' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkPolicy$PolicyDocument' => '

Describes a core network policy.

', 'CreateCoreNetworkRequest$PolicyDocument' => '

The policy document for creating a core network.

', 'PutCoreNetworkPolicyRequest$PolicyDocument' => '

The policy document.

', ], ], 'CoreNetworkPolicyError' => [ 'base' => '

Provides details about an error in a core network policy.

', 'refs' => [ 'CoreNetworkPolicyErrorList$member' => NULL, ], ], 'CoreNetworkPolicyErrorList' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkPolicy$PolicyErrors' => '

Describes any errors in a core network policy.

', 'CoreNetworkPolicyException$Errors' => '

Describes a core network policy exception.

', ], ], 'CoreNetworkPolicyException' => [ 'base' => '

Describes a core network policy exception.

', 'refs' => [], ], 'CoreNetworkPolicyVersion' => [ 'base' => '

Describes a core network policy version.

', 'refs' => [ 'CoreNetworkPolicyVersionList$member' => NULL, ], ], 'CoreNetworkPolicyVersionList' => [ 'base' => NULL, 'refs' => [ 'ListCoreNetworkPolicyVersionsResponse$CoreNetworkPolicyVersions' => '

Describes core network policy versions.

', ], ], 'CoreNetworkSegment' => [ 'base' => '

Describes a core network segment, which are dedicated routes. Only attachments within this segment can communicate with each other.

', 'refs' => [ 'CoreNetworkSegmentList$member' => NULL, ], ], 'CoreNetworkSegmentEdgeIdentifier' => [ 'base' => '

Returns details about a core network edge.

', 'refs' => [ 'GetNetworkRoutesResponse$CoreNetworkSegmentEdge' => '

Describes a core network segment edge.

', 'RouteTableIdentifier$CoreNetworkSegmentEdge' => '

The segment edge in a core network.

', ], ], 'CoreNetworkSegmentList' => [ 'base' => NULL, 'refs' => [ 'CoreNetwork$Segments' => '

The segments within a core network.

', ], ], 'CoreNetworkState' => [ 'base' => NULL, 'refs' => [ 'CoreNetwork$State' => '

The current state of a core network.

', 'CoreNetworkSummary$State' => '

The state of a core network.

', ], ], 'CoreNetworkSummary' => [ 'base' => '

Returns summary information about a core network.

', 'refs' => [ 'CoreNetworkSummaryList$member' => NULL, ], ], 'CoreNetworkSummaryList' => [ 'base' => NULL, 'refs' => [ 'ListCoreNetworksResponse$CoreNetworks' => '

Describes the list of core networks.

', ], ], 'CreateConnectAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateCoreNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateCoreNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDeviceRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDeviceResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateDirectConnectGatewayAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateGlobalNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateLinkRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateLinkResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSiteResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateSiteToSiteVpnAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSiteToSiteVpnAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransitGatewayPeeringRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransitGatewayPeeringResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransitGatewayRouteTableAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateTransitGatewayRouteTableAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateVpcAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateVpcAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'CustomerGatewayArn' => [ 'base' => NULL, 'refs' => [ 'AssociateCustomerGatewayRequest$CustomerGatewayArn' => '

The Amazon Resource Name (ARN) of the customer gateway.

', 'CustomerGatewayArnList$member' => NULL, 'CustomerGatewayAssociation$CustomerGatewayArn' => '

The Amazon Resource Name (ARN) of the customer gateway.

', 'DisassociateCustomerGatewayRequest$CustomerGatewayArn' => '

The Amazon Resource Name (ARN) of the customer gateway.

', ], ], 'CustomerGatewayArnList' => [ 'base' => NULL, 'refs' => [ 'GetCustomerGatewayAssociationsRequest$CustomerGatewayArns' => '

One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.

', ], ], 'CustomerGatewayAssociation' => [ 'base' => '

Describes the association between a customer gateway, a device, and a link.

', 'refs' => [ 'AssociateCustomerGatewayResponse$CustomerGatewayAssociation' => '

The customer gateway association.

', 'CustomerGatewayAssociationList$member' => NULL, 'DisassociateCustomerGatewayResponse$CustomerGatewayAssociation' => '

Information about the customer gateway association.

', ], ], 'CustomerGatewayAssociationList' => [ 'base' => NULL, 'refs' => [ 'GetCustomerGatewayAssociationsResponse$CustomerGatewayAssociations' => '

The customer gateway associations.

', ], ], 'CustomerGatewayAssociationState' => [ 'base' => NULL, 'refs' => [ 'CustomerGatewayAssociation$State' => '

The association state.

', ], ], 'DateTime' => [ 'base' => NULL, 'refs' => [ 'Attachment$CreatedAt' => '

The timestamp when the attachment was created.

', 'Attachment$UpdatedAt' => '

The timestamp when the attachment was last updated.

', 'ConnectPeer$CreatedAt' => '

The timestamp when the Connect peer was created.

', 'ConnectPeerSummary$CreatedAt' => '

The timestamp when a Connect peer was created.

', 'Connection$CreatedAt' => '

The date and time that the connection was created.

', 'ConnectionHealth$Timestamp' => '

The time the status was last updated.

', 'CoreNetwork$CreatedAt' => '

The timestamp when a core network was created.

', 'CoreNetworkChangeEvent$EventTime' => '

The timestamp for an event change in status.

', 'CoreNetworkPolicy$CreatedAt' => '

The timestamp when a core network policy was created.

', 'CoreNetworkPolicyVersion$CreatedAt' => '

The timestamp when a core network policy version was created.

', 'Device$CreatedAt' => '

The date and time that the site was created.

', 'GetNetworkRoutesResponse$RouteTableTimestamp' => '

The route table creation time.

', 'GlobalNetwork$CreatedAt' => '

The date and time that the global network was created.

', 'Link$CreatedAt' => '

The date and time that the link was created.

', 'NetworkResource$DefinitionTimestamp' => '

The time that the resource definition was retrieved.

', 'Peering$CreatedAt' => '

The timestamp when the attachment peer was created.

', 'RouteAnalysis$StartTimestamp' => '

The time that the analysis started.

', 'Site$CreatedAt' => '

The date and time that the site was created.

', ], ], 'DeleteAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCoreNetworkPolicyVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCoreNetworkPolicyVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCoreNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteCoreNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDeviceRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteDeviceResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGlobalNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteGlobalNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLinkRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteLinkResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeletePeeringRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePeeringResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteSiteResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTransitGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeregisterTransitGatewayResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGlobalNetworksRequest' => [ 'base' => NULL, 'refs' => [], ], 'DescribeGlobalNetworksResponse' => [ 'base' => NULL, 'refs' => [], ], 'Device' => [ 'base' => '

Describes a device.

', 'refs' => [ 'CreateDeviceResponse$Device' => '

Information about the device.

', 'DeleteDeviceResponse$Device' => '

Information about the device.

', 'DeviceList$member' => NULL, 'UpdateDeviceResponse$Device' => '

Information about the device.

', ], ], 'DeviceArn' => [ 'base' => NULL, 'refs' => [ 'Device$DeviceArn' => '

The Amazon Resource Name (ARN) of the device.

', ], ], 'DeviceId' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectPeerRequest$DeviceId' => '

The ID of the device.

', 'AssociateCustomerGatewayRequest$DeviceId' => '

The ID of the device.

', 'AssociateLinkRequest$DeviceId' => '

The ID of the device.

', 'AssociateTransitGatewayConnectPeerRequest$DeviceId' => '

The ID of the device.

', 'ConnectPeerAssociation$DeviceId' => '

The ID of the device to connect to.

', 'Connection$DeviceId' => '

The ID of the first device in the connection.

', 'Connection$ConnectedDeviceId' => '

The ID of the second device in the connection.

', 'CreateConnectionRequest$DeviceId' => '

The ID of the first device in the connection.

', 'CreateConnectionRequest$ConnectedDeviceId' => '

The ID of the second device in the connection.

', 'CustomerGatewayAssociation$DeviceId' => '

The ID of the device.

', 'DeleteDeviceRequest$DeviceId' => '

The ID of the device.

', 'Device$DeviceId' => '

The ID of the device.

', 'DeviceIdList$member' => NULL, 'DisassociateLinkRequest$DeviceId' => '

The ID of the device.

', 'GetConnectionsRequest$DeviceId' => '

The ID of the device.

', 'GetLinkAssociationsRequest$DeviceId' => '

The ID of the device.

', 'LinkAssociation$DeviceId' => '

The device ID for the link association.

', 'TransitGatewayConnectPeerAssociation$DeviceId' => '

The ID of the device.

', 'UpdateDeviceRequest$DeviceId' => '

The ID of the device.

', ], ], 'DeviceIdList' => [ 'base' => NULL, 'refs' => [ 'GetDevicesRequest$DeviceIds' => '

One or more device IDs. The maximum is 10.

', ], ], 'DeviceList' => [ 'base' => NULL, 'refs' => [ 'GetDevicesResponse$Devices' => '

The devices.

', ], ], 'DeviceState' => [ 'base' => NULL, 'refs' => [ 'Device$State' => '

The device state.

', ], ], 'DirectConnectGatewayArn' => [ 'base' => NULL, 'refs' => [ 'CreateDirectConnectGatewayAttachmentRequest$DirectConnectGatewayArn' => '

The ARN of the Direct Connect gateway attachment.

', 'DirectConnectGatewayAttachment$DirectConnectGatewayArn' => '

The Direct Connect gateway attachment ARN.

', ], ], 'DirectConnectGatewayAttachment' => [ 'base' => '

Describes a Direct Connect gateway attachment.

', 'refs' => [ 'CreateDirectConnectGatewayAttachmentResponse$DirectConnectGatewayAttachment' => '

Describes the details of a CreateDirectConnectGatewayAttachment request.

', 'GetDirectConnectGatewayAttachmentResponse$DirectConnectGatewayAttachment' => '

Shows details about the Direct Connect gateway attachment.

', 'UpdateDirectConnectGatewayAttachmentResponse$DirectConnectGatewayAttachment' => '

Returns details of the Direct Connect gateway attachment with the updated edge locations.

', ], ], 'DisassociateConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateCustomerGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateCustomerGatewayResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateLinkRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateLinkResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTransitGatewayConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateTransitGatewayConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'EdgeOverride' => [ 'base' => '

Describes the edge that\'s used for the override.

', 'refs' => [ 'WithEdgeOverridesList$member' => NULL, ], ], 'EdgeSet' => [ 'base' => NULL, 'refs' => [ 'EdgeSetList$member' => NULL, ], ], 'EdgeSetList' => [ 'base' => NULL, 'refs' => [ 'EdgeOverride$EdgeSets' => '

The list of edge locations.

', ], ], 'ExceptionContextKey' => [ 'base' => NULL, 'refs' => [ 'ExceptionContextMap$key' => NULL, ], ], 'ExceptionContextMap' => [ 'base' => NULL, 'refs' => [ 'ResourceNotFoundException$Context' => '

The specified resource could not be found.

', ], ], 'ExceptionContextValue' => [ 'base' => NULL, 'refs' => [ 'ExceptionContextMap$value' => NULL, ], ], 'ExecuteCoreNetworkChangeSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'ExecuteCoreNetworkChangeSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'ExternalRegionCode' => [ 'base' => NULL, 'refs' => [ 'Attachment$EdgeLocation' => '

The Region where the edge is located. This is returned for all attachment types except a Direct Connect gateway attachment, which instead returns EdgeLocations.

', 'ConnectPeer$EdgeLocation' => '

The Connect peer Regions where edges are located.

', 'ConnectPeerSummary$EdgeLocation' => '

The Region where the edge is located.

', 'CoreNetworkChangeEventValues$EdgeLocation' => '

The edge location for the core network change event.

', 'CoreNetworkEdge$EdgeLocation' => '

The Region where a core network edge is located.

', 'CoreNetworkNetworkFunctionGroupIdentifier$EdgeLocation' => '

The location for the core network edge.

', 'CoreNetworkSegmentEdgeIdentifier$EdgeLocation' => '

The Region where the segment edge is located.

', 'CreateConnectAttachmentRequest$EdgeLocation' => '

The Region where the edge is located.

', 'ExternalRegionCodeList$member' => NULL, 'GetNetworkResourceRelationshipsRequest$AwsRegion' => '

The Amazon Web Services Region.

', 'GetNetworkResourcesRequest$AwsRegion' => '

The Amazon Web Services Region.

', 'GetNetworkTelemetryRequest$AwsRegion' => '

The Amazon Web Services Region.

', 'ListAttachmentsRequest$EdgeLocation' => '

The Region where the edge is located.

', 'ListPeeringsRequest$EdgeLocation' => '

Returns a list edge locations for the

', 'NetworkResource$AwsRegion' => '

The Amazon Web Services Region.

', 'NetworkRouteDestination$EdgeLocation' => '

The edge location for the network destination.

', 'NetworkTelemetry$AwsRegion' => '

The Amazon Web Services Region.

', 'Peering$EdgeLocation' => '

The edge location for the peer.

', ], ], 'ExternalRegionCodeList' => [ 'base' => NULL, 'refs' => [ 'Attachment$EdgeLocations' => '

The edge locations that the Direct Connect gateway is associated with. This is returned only for Direct Connect gateway attachments. All other attachment types retrun EdgeLocation.

', 'CoreNetworkChangeValues$EdgeLocations' => '

The Regions where edges are located in a core network.

', 'CoreNetworkNetworkFunctionGroup$EdgeLocations' => '

The core network edge locations.

', 'CoreNetworkSegment$EdgeLocations' => '

The Regions where the edges are located.

', 'CreateDirectConnectGatewayAttachmentRequest$EdgeLocations' => '

One or more core network edge locations that the Direct Connect gateway attachment is associated with.

', 'UpdateDirectConnectGatewayAttachmentRequest$EdgeLocations' => '

One or more edge locations to update for the Direct Connect gateway attachment. The updated array of edge locations overwrites the previous array of locations. EdgeLocations is only used for Direct Connect gateway attachments. Do

', ], ], 'FilterMap' => [ 'base' => NULL, 'refs' => [ 'GetNetworkRoutesRequest$DestinationFilters' => '

Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.

', ], ], 'FilterName' => [ 'base' => NULL, 'refs' => [ 'FilterMap$key' => NULL, ], ], 'FilterValue' => [ 'base' => NULL, 'refs' => [ 'FilterValues$member' => NULL, ], ], 'FilterValues' => [ 'base' => NULL, 'refs' => [ 'FilterMap$value' => NULL, ], ], 'GetConnectAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectPeerAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectPeerAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectPeerRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectPeerResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetConnectionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkChangeEventsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkChangeEventsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkChangeSetRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkChangeSetResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCoreNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomerGatewayAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetCustomerGatewayAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDevicesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetDirectConnectGatewayAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetDirectConnectGatewayAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLinkAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLinkAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetLinksRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetLinksResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkResourceCountsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkResourceCountsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkResourceRelationshipsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkResourceRelationshipsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkResourcesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkResourcesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkRoutesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkRoutesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkTelemetryRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetNetworkTelemetryResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetRouteAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetRouteAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSiteToSiteVpnAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSiteToSiteVpnAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetSitesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetSitesResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayConnectPeerAssociationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayConnectPeerAssociationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayPeeringRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayPeeringResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayRegistrationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayRegistrationsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayRouteTableAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetTransitGatewayRouteTableAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetVpcAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetVpcAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'GlobalNetwork' => [ 'base' => '

Describes a global network. This is a single private network acting as a high-level container for your network objects, including an Amazon Web Services-managed Core Network.

', 'refs' => [ 'CreateGlobalNetworkResponse$GlobalNetwork' => '

Information about the global network object.

', 'DeleteGlobalNetworkResponse$GlobalNetwork' => '

Information about the global network.

', 'GlobalNetworkList$member' => NULL, 'UpdateGlobalNetworkResponse$GlobalNetwork' => '

Information about the global network object.

', ], ], 'GlobalNetworkArn' => [ 'base' => NULL, 'refs' => [ 'GlobalNetwork$GlobalNetworkArn' => '

The Amazon Resource Name (ARN) of the global network.

', ], ], 'GlobalNetworkId' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectPeerRequest$GlobalNetworkId' => '

The ID of your global network.

', 'AssociateCustomerGatewayRequest$GlobalNetworkId' => '

The ID of the global network.

', 'AssociateLinkRequest$GlobalNetworkId' => '

The ID of the global network.

', 'AssociateTransitGatewayConnectPeerRequest$GlobalNetworkId' => '

The ID of the global network.

', 'ConnectPeerAssociation$GlobalNetworkId' => '

The ID of the global network.

', 'Connection$GlobalNetworkId' => '

The ID of the global network.

', 'CoreNetwork$GlobalNetworkId' => '

The ID of the global network that your core network is a part of.

', 'CoreNetworkSummary$GlobalNetworkId' => '

The global network ID.

', 'CreateConnectionRequest$GlobalNetworkId' => '

The ID of the global network.

', 'CreateCoreNetworkRequest$GlobalNetworkId' => '

The ID of the global network that a core network will be a part of.

', 'CreateDeviceRequest$GlobalNetworkId' => '

The ID of the global network.

', 'CreateLinkRequest$GlobalNetworkId' => '

The ID of the global network.

', 'CreateSiteRequest$GlobalNetworkId' => '

The ID of the global network.

', 'CustomerGatewayAssociation$GlobalNetworkId' => '

The ID of the global network.

', 'DeleteConnectionRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DeleteDeviceRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DeleteGlobalNetworkRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DeleteLinkRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DeleteSiteRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DeregisterTransitGatewayRequest$GlobalNetworkId' => '

The ID of the global network.

', 'Device$GlobalNetworkId' => '

The ID of the global network.

', 'DisassociateConnectPeerRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DisassociateCustomerGatewayRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DisassociateLinkRequest$GlobalNetworkId' => '

The ID of the global network.

', 'DisassociateTransitGatewayConnectPeerRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetConnectPeerAssociationsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetConnectionsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetCustomerGatewayAssociationsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetDevicesRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetLinkAssociationsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetLinksRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetNetworkResourceCountsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetNetworkResourceRelationshipsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetNetworkResourcesRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetNetworkRoutesRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetNetworkTelemetryRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetRouteAnalysisRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetSitesRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetTransitGatewayConnectPeerAssociationsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GetTransitGatewayRegistrationsRequest$GlobalNetworkId' => '

The ID of the global network.

', 'GlobalNetwork$GlobalNetworkId' => '

The ID of the global network.

', 'GlobalNetworkIdList$member' => NULL, 'Link$GlobalNetworkId' => '

The ID of the global network.

', 'LinkAssociation$GlobalNetworkId' => '

The ID of the global network.

', 'RegisterTransitGatewayRequest$GlobalNetworkId' => '

The ID of the global network.

', 'RouteAnalysis$GlobalNetworkId' => '

The ID of the global network.

', 'Site$GlobalNetworkId' => '

The ID of the global network.

', 'StartRouteAnalysisRequest$GlobalNetworkId' => '

The ID of the global network.

', 'TransitGatewayConnectPeerAssociation$GlobalNetworkId' => '

The ID of the global network.

', 'TransitGatewayRegistration$GlobalNetworkId' => '

The ID of the global network.

', 'UpdateConnectionRequest$GlobalNetworkId' => '

The ID of the global network.

', 'UpdateDeviceRequest$GlobalNetworkId' => '

The ID of the global network.

', 'UpdateGlobalNetworkRequest$GlobalNetworkId' => '

The ID of your global network.

', 'UpdateLinkRequest$GlobalNetworkId' => '

The ID of the global network.

', 'UpdateNetworkResourceMetadataRequest$GlobalNetworkId' => '

The ID of the global network.

', 'UpdateSiteRequest$GlobalNetworkId' => '

The ID of the global network.

', ], ], 'GlobalNetworkIdList' => [ 'base' => NULL, 'refs' => [ 'DescribeGlobalNetworksRequest$GlobalNetworkIds' => '

The IDs of one or more global networks. The maximum is 10.

', ], ], 'GlobalNetworkList' => [ 'base' => NULL, 'refs' => [ 'DescribeGlobalNetworksResponse$GlobalNetworks' => '

Information about the global networks.

', ], ], 'GlobalNetworkState' => [ 'base' => NULL, 'refs' => [ 'GlobalNetwork$State' => '

The state of the global network.

', ], ], 'IPAddress' => [ 'base' => NULL, 'refs' => [ 'ConnectPeerBgpConfiguration$CoreNetworkAddress' => '

The address of a core network.

', 'ConnectPeerBgpConfiguration$PeerAddress' => '

The address of a core network Connect peer.

', 'ConnectPeerConfiguration$CoreNetworkAddress' => '

The IP address of a core network.

', 'ConnectPeerConfiguration$PeerAddress' => '

The IP address of the Connect peer.

', 'CreateConnectPeerRequest$CoreNetworkAddress' => '

A Connect peer core network address. This only applies only when the protocol is GRE.

', 'CreateConnectPeerRequest$PeerAddress' => '

The Connect peer address.

', 'RouteAnalysisEndpointOptions$IpAddress' => '

The IP address.

', 'RouteAnalysisEndpointOptionsSpecification$IpAddress' => '

The IP address.

', ], ], 'Integer' => [ 'base' => NULL, 'refs' => [ 'Attachment$AttachmentPolicyRuleNumber' => '

The policy rule number associated with the attachment.

', 'Bandwidth$UploadSpeed' => '

Upload speed in Mbps.

', 'Bandwidth$DownloadSpeed' => '

Download speed in Mbps.

', 'CoreNetworkPolicy$PolicyVersionId' => '

The ID of the policy version.

', 'CoreNetworkPolicyVersion$PolicyVersionId' => '

The ID of the policy version.

', 'DeleteCoreNetworkPolicyVersionRequest$PolicyVersionId' => '

The version ID of the deleted policy.

', 'ExecuteCoreNetworkChangeSetRequest$PolicyVersionId' => '

The ID of the policy version.

', 'GetCoreNetworkChangeEventsRequest$PolicyVersionId' => '

The ID of the policy version.

', 'GetCoreNetworkChangeSetRequest$PolicyVersionId' => '

The ID of the policy version.

', 'GetCoreNetworkPolicyRequest$PolicyVersionId' => '

The ID of a core network policy version.

', 'NetworkResourceCount$Count' => '

The resource count.

', 'PathComponent$Sequence' => '

The sequence number in the path. The destination is 0.

', 'ProposedNetworkFunctionGroupChange$AttachmentPolicyRuleNumber' => '

The proposed new attachment policy rule number for the network function group.

', 'ProposedSegmentChange$AttachmentPolicyRuleNumber' => '

The rule number in the policy document that applies to this change.

', 'PutCoreNetworkPolicyRequest$LatestVersionId' => '

The ID of a core network policy.

', 'RestoreCoreNetworkPolicyVersionRequest$PolicyVersionId' => '

The ID of the policy version to restore.

', ], ], 'InternalServerException' => [ 'base' => '

The request has failed due to an internal error.

', 'refs' => [], ], 'Link' => [ 'base' => '

Describes a link.

', 'refs' => [ 'CreateLinkResponse$Link' => '

Information about the link.

', 'DeleteLinkResponse$Link' => '

Information about the link.

', 'LinkList$member' => NULL, 'UpdateLinkResponse$Link' => '

Information about the link.

', ], ], 'LinkArn' => [ 'base' => NULL, 'refs' => [ 'Link$LinkArn' => '

The Amazon Resource Name (ARN) of the link.

', ], ], 'LinkAssociation' => [ 'base' => '

Describes the association between a device and a link.

', 'refs' => [ 'AssociateLinkResponse$LinkAssociation' => '

The link association.

', 'DisassociateLinkResponse$LinkAssociation' => '

Information about the link association.

', 'LinkAssociationList$member' => NULL, ], ], 'LinkAssociationList' => [ 'base' => NULL, 'refs' => [ 'GetLinkAssociationsResponse$LinkAssociations' => '

The link associations.

', ], ], 'LinkAssociationState' => [ 'base' => NULL, 'refs' => [ 'LinkAssociation$LinkAssociationState' => '

The state of the association.

', ], ], 'LinkId' => [ 'base' => NULL, 'refs' => [ 'AssociateConnectPeerRequest$LinkId' => '

The ID of the link.

', 'AssociateCustomerGatewayRequest$LinkId' => '

The ID of the link.

', 'AssociateLinkRequest$LinkId' => '

The ID of the link.

', 'AssociateTransitGatewayConnectPeerRequest$LinkId' => '

The ID of the link.

', 'ConnectPeerAssociation$LinkId' => '

The ID of the link.

', 'Connection$LinkId' => '

The ID of the link for the first device in the connection.

', 'Connection$ConnectedLinkId' => '

The ID of the link for the second device in the connection.

', 'CreateConnectionRequest$LinkId' => '

The ID of the link for the first device.

', 'CreateConnectionRequest$ConnectedLinkId' => '

The ID of the link for the second device.

', 'CustomerGatewayAssociation$LinkId' => '

The ID of the link.

', 'DeleteLinkRequest$LinkId' => '

The ID of the link.

', 'DisassociateLinkRequest$LinkId' => '

The ID of the link.

', 'GetLinkAssociationsRequest$LinkId' => '

The ID of the link.

', 'Link$LinkId' => '

The ID of the link.

', 'LinkAssociation$LinkId' => '

The ID of the link.

', 'LinkIdList$member' => NULL, 'TransitGatewayConnectPeerAssociation$LinkId' => '

The ID of the link.

', 'UpdateConnectionRequest$LinkId' => '

The ID of the link for the first device in the connection.

', 'UpdateConnectionRequest$ConnectedLinkId' => '

The ID of the link for the second device in the connection.

', 'UpdateLinkRequest$LinkId' => '

The ID of the link.

', ], ], 'LinkIdList' => [ 'base' => NULL, 'refs' => [ 'GetLinksRequest$LinkIds' => '

One or more link IDs. The maximum is 10.

', ], ], 'LinkList' => [ 'base' => NULL, 'refs' => [ 'GetLinksResponse$Links' => '

The links.

', ], ], 'LinkState' => [ 'base' => NULL, 'refs' => [ 'Link$State' => '

The state of the link.

', ], ], 'ListAttachmentsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListAttachmentsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListConnectPeersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListConnectPeersResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCoreNetworkPolicyVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCoreNetworkPolicyVersionsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListCoreNetworksRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListCoreNetworksResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListOrganizationServiceAccessStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListOrganizationServiceAccessStatusResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPeeringsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPeeringsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListTagsForResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Location' => [ 'base' => '

Describes a location.

', 'refs' => [ 'CreateDeviceRequest$Location' => '

The location of the device.

', 'CreateSiteRequest$Location' => '

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.

', 'Device$Location' => '

The site location.

', 'Site$Location' => '

The location of the site.

', 'UpdateDeviceRequest$Location' => NULL, 'UpdateSiteRequest$Location' => '

The site location:

', ], ], 'Long' => [ 'base' => NULL, 'refs' => [ 'BgpOptions$PeerAsn' => '

The Peer ASN of the BGP.

', 'ConnectPeerBgpConfiguration$CoreNetworkAsn' => '

The ASN of the Coret Network.

', 'ConnectPeerBgpConfiguration$PeerAsn' => '

The ASN of the Connect peer.

', 'CoreNetworkChangeValues$Asn' => '

The ASN of a core network.

', 'CoreNetworkEdge$Asn' => '

The ASN of a core network edge.

', ], ], 'MaxResults' => [ 'base' => NULL, 'refs' => [ 'DescribeGlobalNetworksRequest$MaxResults' => '

The maximum number of results to return.

', 'GetConnectPeerAssociationsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetConnectionsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetCoreNetworkChangeEventsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetCoreNetworkChangeSetRequest$MaxResults' => '

The maximum number of results to return.

', 'GetCustomerGatewayAssociationsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetDevicesRequest$MaxResults' => '

The maximum number of results to return.

', 'GetLinkAssociationsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetLinksRequest$MaxResults' => '

The maximum number of results to return.

', 'GetNetworkResourceCountsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetNetworkResourceRelationshipsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetNetworkResourcesRequest$MaxResults' => '

The maximum number of results to return.

', 'GetNetworkTelemetryRequest$MaxResults' => '

The maximum number of results to return.

', 'GetSitesRequest$MaxResults' => '

The maximum number of results to return.

', 'GetTransitGatewayConnectPeerAssociationsRequest$MaxResults' => '

The maximum number of results to return.

', 'GetTransitGatewayRegistrationsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListAttachmentsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListConnectPeersRequest$MaxResults' => '

The maximum number of results to return.

', 'ListCoreNetworkPolicyVersionsRequest$MaxResults' => '

The maximum number of results to return.

', 'ListCoreNetworksRequest$MaxResults' => '

The maximum number of results to return.

', 'ListOrganizationServiceAccessStatusRequest$MaxResults' => '

The maximum number of results to return.

', 'ListPeeringsRequest$MaxResults' => '

The maximum number of results to return.

', ], ], 'NetworkFunctionGroup' => [ 'base' => '

Describes a network function group for service insertion.

', 'refs' => [ 'NetworkFunctionGroupList$member' => NULL, ], ], 'NetworkFunctionGroupList' => [ 'base' => NULL, 'refs' => [ 'Via$NetworkFunctionGroups' => '

The list of network function groups associated with the service insertion action.

', ], ], 'NetworkFunctionGroupName' => [ 'base' => NULL, 'refs' => [ 'Attachment$NetworkFunctionGroupName' => '

The name of the network function group.

', ], ], 'NetworkResource' => [ 'base' => '

Describes a network resource.

', 'refs' => [ 'NetworkResourceList$member' => NULL, ], ], 'NetworkResourceCount' => [ 'base' => '

Describes a resource count.

', 'refs' => [ 'NetworkResourceCountList$member' => NULL, ], ], 'NetworkResourceCountList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkResourceCountsResponse$NetworkResourceCounts' => '

The count of resources.

', ], ], 'NetworkResourceList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkResourcesResponse$NetworkResources' => '

The network resources.

', ], ], 'NetworkResourceMetadataMap' => [ 'base' => NULL, 'refs' => [ 'NetworkResource$Metadata' => '

The resource metadata.

', 'UpdateNetworkResourceMetadataRequest$Metadata' => '

The resource metadata.

', 'UpdateNetworkResourceMetadataResponse$Metadata' => '

The updated resource metadata.

', ], ], 'NetworkResourceSummary' => [ 'base' => '

Describes a network resource.

', 'refs' => [ 'PathComponent$Resource' => '

The resource.

', ], ], 'NetworkRoute' => [ 'base' => '

Describes a network route.

', 'refs' => [ 'NetworkRouteList$member' => NULL, ], ], 'NetworkRouteDestination' => [ 'base' => '

Describes the destination of a network route.

', 'refs' => [ 'NetworkRouteDestinationList$member' => NULL, ], ], 'NetworkRouteDestinationList' => [ 'base' => NULL, 'refs' => [ 'NetworkRoute$Destinations' => '

The destinations.

', ], ], 'NetworkRouteList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkRoutesResponse$NetworkRoutes' => '

The network routes.

', ], ], 'NetworkTelemetry' => [ 'base' => '

Describes the telemetry information for a resource.

', 'refs' => [ 'NetworkTelemetryList$member' => NULL, ], ], 'NetworkTelemetryList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkTelemetryResponse$NetworkTelemetry' => '

The network telemetry.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'DescribeGlobalNetworksRequest$NextToken' => '

The token for the next page of results.

', 'DescribeGlobalNetworksResponse$NextToken' => '

The token for the next page of results.

', 'GetConnectPeerAssociationsRequest$NextToken' => '

The token for the next page of results.

', 'GetConnectPeerAssociationsResponse$NextToken' => '

The token for the next page of results.

', 'GetConnectionsRequest$NextToken' => '

The token for the next page of results.

', 'GetConnectionsResponse$NextToken' => '

The token to use for the next page of results.

', 'GetCoreNetworkChangeEventsRequest$NextToken' => '

The token for the next page of results.

', 'GetCoreNetworkChangeEventsResponse$NextToken' => '

The token for the next page of results.

', 'GetCoreNetworkChangeSetRequest$NextToken' => '

The token for the next page of results.

', 'GetCoreNetworkChangeSetResponse$NextToken' => '

The token for the next page of results.

', 'GetCustomerGatewayAssociationsRequest$NextToken' => '

The token for the next page of results.

', 'GetCustomerGatewayAssociationsResponse$NextToken' => '

The token for the next page of results.

', 'GetDevicesRequest$NextToken' => '

The token for the next page of results.

', 'GetDevicesResponse$NextToken' => '

The token for the next page of results.

', 'GetLinkAssociationsRequest$NextToken' => '

The token for the next page of results.

', 'GetLinkAssociationsResponse$NextToken' => '

The token for the next page of results.

', 'GetLinksRequest$NextToken' => '

The token for the next page of results.

', 'GetLinksResponse$NextToken' => '

The token for the next page of results.

', 'GetNetworkResourceCountsRequest$NextToken' => '

The token for the next page of results.

', 'GetNetworkResourceCountsResponse$NextToken' => '

The token for the next page of results.

', 'GetNetworkResourceRelationshipsRequest$NextToken' => '

The token for the next page of results.

', 'GetNetworkResourceRelationshipsResponse$NextToken' => '

The token for the next page of results.

', 'GetNetworkResourcesRequest$NextToken' => '

The token for the next page of results.

', 'GetNetworkResourcesResponse$NextToken' => '

The token for the next page of results.

', 'GetNetworkTelemetryRequest$NextToken' => '

The token for the next page of results.

', 'GetNetworkTelemetryResponse$NextToken' => '

The token for the next page of results.

', 'GetSitesRequest$NextToken' => '

The token for the next page of results.

', 'GetSitesResponse$NextToken' => '

The token for the next page of results.

', 'GetTransitGatewayConnectPeerAssociationsRequest$NextToken' => '

The token for the next page of results.

', 'GetTransitGatewayConnectPeerAssociationsResponse$NextToken' => '

The token to use for the next page of results.

', 'GetTransitGatewayRegistrationsRequest$NextToken' => '

The token for the next page of results.

', 'GetTransitGatewayRegistrationsResponse$NextToken' => '

The token for the next page of results.

', 'ListAttachmentsRequest$NextToken' => '

The token for the next page of results.

', 'ListAttachmentsResponse$NextToken' => '

The token for the next page of results.

', 'ListConnectPeersRequest$NextToken' => '

The token for the next page of results.

', 'ListConnectPeersResponse$NextToken' => '

The token for the next page of results.

', 'ListCoreNetworkPolicyVersionsRequest$NextToken' => '

The token for the next page of results.

', 'ListCoreNetworkPolicyVersionsResponse$NextToken' => '

The token for the next page of results.

', 'ListCoreNetworksRequest$NextToken' => '

The token for the next page of results.

', 'ListCoreNetworksResponse$NextToken' => '

The token for the next page of results.

', 'ListOrganizationServiceAccessStatusRequest$NextToken' => '

The token for the next page of results.

', 'ListOrganizationServiceAccessStatusResponse$NextToken' => '

The token for the next page of results.

', 'ListPeeringsRequest$NextToken' => '

The token for the next page of results.

', 'ListPeeringsResponse$NextToken' => '

The token for the next page of results.

', ], ], 'OrganizationAwsServiceAccessStatus' => [ 'base' => NULL, 'refs' => [ 'OrganizationStatus$OrganizationAwsServiceAccessStatus' => '

The status of the organization\'s AWS service access. This will be ENABLED or DISABLED.

', ], ], 'OrganizationId' => [ 'base' => NULL, 'refs' => [ 'OrganizationStatus$OrganizationId' => '

The ID of an Amazon Web Services Organization.

', ], ], 'OrganizationStatus' => [ 'base' => '

The status of an Amazon Web Services Organization and the accounts within that organization.

', 'refs' => [ 'ListOrganizationServiceAccessStatusResponse$OrganizationStatus' => '

Displays the status of an Amazon Web Services Organization.

', 'StartOrganizationServiceAccessUpdateResponse$OrganizationStatus' => '

The status of the service access update request for an Amazon Web Services Organization.

', ], ], 'PathComponent' => [ 'base' => '

Describes a path component.

', 'refs' => [ 'PathComponentList$member' => NULL, ], ], 'PathComponentList' => [ 'base' => NULL, 'refs' => [ 'RouteAnalysisPath$Path' => '

The route analysis path.

', ], ], 'Peering' => [ 'base' => '

Describes a peering connection.

', 'refs' => [ 'DeletePeeringResponse$Peering' => '

Information about a deleted peering connection.

', 'PeeringList$member' => NULL, 'TransitGatewayPeering$Peering' => '

Describes a transit gateway peer connection.

', ], ], 'PeeringError' => [ 'base' => '

Describes an error associated with a peering request.

', 'refs' => [ 'PeeringErrorList$member' => NULL, ], ], 'PeeringErrorCode' => [ 'base' => NULL, 'refs' => [ 'PeeringError$Code' => '

The error code for the peering request.

', ], ], 'PeeringErrorList' => [ 'base' => NULL, 'refs' => [ 'Peering$LastModificationErrors' => '

Describes the error associated with the Connect peer request.

', ], ], 'PeeringId' => [ 'base' => NULL, 'refs' => [ 'CreateTransitGatewayRouteTableAttachmentRequest$PeeringId' => '

The ID of the peer for the

', 'DeletePeeringRequest$PeeringId' => '

The ID of the peering connection to delete.

', 'GetTransitGatewayPeeringRequest$PeeringId' => '

The ID of the peering request.

', 'Peering$PeeringId' => '

The ID of the peering attachment.

', 'TransitGatewayRouteTableAttachment$PeeringId' => '

The ID of the peering attachment.

', ], ], 'PeeringList' => [ 'base' => NULL, 'refs' => [ 'ListPeeringsResponse$Peerings' => '

Lists the transit gateway peerings for the ListPeerings request.

', ], ], 'PeeringState' => [ 'base' => NULL, 'refs' => [ 'ListPeeringsRequest$State' => '

Returns a list of the peering request states.

', 'Peering$State' => '

The current state of the peering connection.

', ], ], 'PeeringType' => [ 'base' => NULL, 'refs' => [ 'ListPeeringsRequest$PeeringType' => '

Returns a list of a peering requests.

', 'Peering$PeeringType' => '

The type of peering. This will be TRANSIT_GATEWAY.

', ], ], 'PermissionsErrorContext' => [ 'base' => '

Describes additional information about missing permissions.

', 'refs' => [ 'PeeringError$MissingPermissionsContext' => '

Provides additional information about missing permissions for the peering error.

', ], ], 'ProposedNetworkFunctionGroupChange' => [ 'base' => '

Describes proposed changes to a network function group.

', 'refs' => [ 'Attachment$ProposedNetworkFunctionGroupChange' => '

Describes a proposed change to a network function group associated with the attachment.

', ], ], 'ProposedSegmentChange' => [ 'base' => '

Describes a proposed segment change. In some cases, the segment change must first be evaluated and accepted.

', 'refs' => [ 'Attachment$ProposedSegmentChange' => '

The attachment to move from one segment to another.

', ], ], 'PutCoreNetworkPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutCoreNetworkPolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'PutResourcePolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutResourcePolicyResponse' => [ 'base' => NULL, 'refs' => [], ], 'ReasonContextKey' => [ 'base' => NULL, 'refs' => [ 'ReasonContextMap$key' => NULL, ], ], 'ReasonContextMap' => [ 'base' => NULL, 'refs' => [ 'RouteAnalysisCompletion$ReasonContext' => '

Additional information about the path. Available only if a connection is not found.

', ], ], 'ReasonContextValue' => [ 'base' => NULL, 'refs' => [ 'ReasonContextMap$value' => NULL, ], ], 'RegisterTransitGatewayRequest' => [ 'base' => NULL, 'refs' => [], ], 'RegisterTransitGatewayResponse' => [ 'base' => NULL, 'refs' => [], ], 'RejectAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'RejectAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'Relationship' => [ 'base' => '

Describes a resource relationship.

', 'refs' => [ 'RelationshipList$member' => NULL, ], ], 'RelationshipList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkResourceRelationshipsResponse$Relationships' => '

The resource relationships.

', ], ], 'ResourceArn' => [ 'base' => NULL, 'refs' => [ 'Attachment$ResourceArn' => '

The attachment resource ARN.

', 'AttachmentError$ResourceArn' => '

The ARN of the requested attachment resource.

', 'ConnectPeerError$ResourceArn' => '

The ARN of the requested Connect peer resource.

', 'DeleteResourcePolicyRequest$ResourceArn' => '

The ARN of the policy to delete.

', 'GetNetworkResourceRelationshipsRequest$RegisteredGatewayArn' => '

The ARN of the registered gateway.

', 'GetNetworkResourceRelationshipsRequest$ResourceArn' => '

The ARN of the gateway.

', 'GetNetworkResourcesRequest$RegisteredGatewayArn' => '

The ARN of the gateway.

', 'GetNetworkResourcesRequest$ResourceArn' => '

The ARN of the resource.

', 'GetNetworkRoutesResponse$RouteTableArn' => '

The ARN of the route table.

', 'GetNetworkTelemetryRequest$RegisteredGatewayArn' => '

The ARN of the gateway.

', 'GetNetworkTelemetryRequest$ResourceArn' => '

The ARN of the resource.

', 'GetResourcePolicyRequest$ResourceArn' => '

The ARN of the resource.

', 'ListTagsForResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'NetworkResource$RegisteredGatewayArn' => '

The ARN of the gateway.

', 'NetworkResource$ResourceArn' => '

The ARN of the resource.

', 'NetworkResourceSummary$RegisteredGatewayArn' => '

The ARN of the gateway.

', 'NetworkResourceSummary$ResourceArn' => '

The ARN of the resource.

', 'NetworkTelemetry$RegisteredGatewayArn' => '

The ARN of the gateway.

', 'NetworkTelemetry$ResourceArn' => '

The ARN of the resource.

', 'Peering$ResourceArn' => '

The resource ARN of the peer.

', 'PeeringError$ResourceArn' => '

The ARN of the requested peering resource.

', 'PutResourcePolicyRequest$ResourceArn' => '

The ARN of the resource policy.

', 'TagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'UntagResourceRequest$ResourceArn' => '

The Amazon Resource Name (ARN) of the resource.

', 'UpdateNetworkResourceMetadataRequest$ResourceArn' => '

The ARN of the resource.

', 'UpdateNetworkResourceMetadataResponse$ResourceArn' => '

The ARN of the resource.

', ], ], 'ResourceNotFoundException' => [ 'base' => '

The specified resource could not be found.

', 'refs' => [], ], 'ResourcePolicyDocument' => [ 'base' => NULL, 'refs' => [ 'GetResourcePolicyResponse$PolicyDocument' => '

The resource policy document.

', 'PutResourcePolicyRequest$PolicyDocument' => '

The JSON resource policy document.

', ], ], 'RestoreCoreNetworkPolicyVersionRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestoreCoreNetworkPolicyVersionResponse' => [ 'base' => NULL, 'refs' => [], ], 'RetryAfterSeconds' => [ 'base' => NULL, 'refs' => [ 'InternalServerException$RetryAfterSeconds' => '

Indicates when to retry the request.

', 'ThrottlingException$RetryAfterSeconds' => '

Indicates when to retry the request.

', ], ], 'RouteAnalysis' => [ 'base' => '

Describes a route analysis.

', 'refs' => [ 'GetRouteAnalysisResponse$RouteAnalysis' => '

The route analysis.

', 'StartRouteAnalysisResponse$RouteAnalysis' => '

The route analysis.

', ], ], 'RouteAnalysisCompletion' => [ 'base' => '

Describes the status of an analysis at completion.

', 'refs' => [ 'RouteAnalysisPath$CompletionStatus' => '

The status of the analysis at completion.

', ], ], 'RouteAnalysisCompletionReasonCode' => [ 'base' => NULL, 'refs' => [ 'RouteAnalysisCompletion$ReasonCode' => '

The reason code. Available only if a connection is not found.

', ], ], 'RouteAnalysisCompletionResultCode' => [ 'base' => NULL, 'refs' => [ 'RouteAnalysisCompletion$ResultCode' => '

The result of the analysis. If the status is NOT_CONNECTED, check the reason code.

', ], ], 'RouteAnalysisEndpointOptions' => [ 'base' => '

Describes a source or a destination.

', 'refs' => [ 'RouteAnalysis$Source' => '

The source.

', 'RouteAnalysis$Destination' => '

The destination.

', ], ], 'RouteAnalysisEndpointOptionsSpecification' => [ 'base' => '

Describes a source or a destination.

', 'refs' => [ 'StartRouteAnalysisRequest$Source' => '

The source from which traffic originates.

', 'StartRouteAnalysisRequest$Destination' => '

The destination.

', ], ], 'RouteAnalysisPath' => [ 'base' => '

Describes a route analysis path.

', 'refs' => [ 'RouteAnalysis$ForwardPath' => '

The forward path.

', 'RouteAnalysis$ReturnPath' => '

The return path.

', ], ], 'RouteAnalysisStatus' => [ 'base' => NULL, 'refs' => [ 'RouteAnalysis$Status' => '

The status of the route analysis.

', ], ], 'RouteState' => [ 'base' => NULL, 'refs' => [ 'NetworkRoute$State' => '

The route state. The possible values are active and blackhole.

', 'RouteStateList$member' => NULL, ], ], 'RouteStateList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkRoutesRequest$States' => '

The route states.

', ], ], 'RouteTableIdentifier' => [ 'base' => '

Describes a route table.

', 'refs' => [ 'GetNetworkRoutesRequest$RouteTableIdentifier' => '

The ID of the route table.

', ], ], 'RouteTableType' => [ 'base' => NULL, 'refs' => [ 'GetNetworkRoutesResponse$RouteTableType' => '

The route table type.

', ], ], 'RouteType' => [ 'base' => NULL, 'refs' => [ 'NetworkRoute$Type' => '

The route type. The possible values are propagated and static.

', 'RouteTypeList$member' => NULL, ], ], 'RouteTypeList' => [ 'base' => NULL, 'refs' => [ 'GetNetworkRoutesRequest$Types' => '

The route types.

', ], ], 'SLRDeploymentStatus' => [ 'base' => NULL, 'refs' => [ 'AccountStatus$SLRDeploymentStatus' => '

The status of SLR deployment for the account.

', 'OrganizationStatus$SLRDeploymentStatus' => '

The status of the SLR deployment for the account. This will be either SUCCEEDED or IN_PROGRESS.

', ], ], 'SegmentActionServiceInsertion' => [ 'base' => NULL, 'refs' => [ 'ServiceInsertionAction$Action' => '

The action the service insertion takes for traffic. send-via sends east-west traffic between attachments. send-to sends north-south traffic to the security appliance, and then from that to either the Internet or to an on-premesis location.

', ], ], 'SendViaMode' => [ 'base' => NULL, 'refs' => [ 'ServiceInsertionAction$Mode' => '

Describes the mode packets take for the send-via action. This is not used when the action is send-to. dual-hop packets traverse attachments in both the source to the destination core network edges. This mode requires that an inspection attachment must be present in all Regions of the service insertion-enabled segments. For single-hop, packets traverse a single intermediate inserted attachment. You can use EdgeOverride to specify a specific edge to use.

', ], ], 'ServerSideString' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$Message' => NULL, 'AttachmentError$Message' => '

The message associated with the error code.

', 'AttachmentError$RequestId' => '

The ID of the attachment request.

', 'ConflictException$Message' => NULL, 'ConflictException$ResourceId' => '

The ID of the resource.

', 'ConflictException$ResourceType' => '

The resource type.

', 'ConnectPeerError$Message' => '

The message associated with the error code.

', 'ConnectPeerError$RequestId' => '

The ID of the Connect peer request.

', 'CoreNetworkPolicyError$ErrorCode' => '

The error code associated with a core network policy error.

', 'CoreNetworkPolicyError$Message' => '

The message associated with a core network policy error code.

', 'CoreNetworkPolicyError$Path' => '

The JSON path where the error was discovered in the policy document.

', 'CoreNetworkPolicyException$Message' => NULL, 'InternalServerException$Message' => NULL, 'PeeringError$Message' => '

The message associated with the error code.

', 'PeeringError$RequestId' => '

The ID of the Peering request.

', 'PermissionsErrorContext$MissingPermission' => '

The missing permissions.

', 'ResourceNotFoundException$Message' => NULL, 'ResourceNotFoundException$ResourceId' => '

The ID of the resource.

', 'ResourceNotFoundException$ResourceType' => '

The resource type.

', 'ServiceQuotaExceededException$Message' => '

The error message.

', 'ServiceQuotaExceededException$ResourceId' => '

The ID of the resource.

', 'ServiceQuotaExceededException$ResourceType' => '

The resource type.

', 'ServiceQuotaExceededException$LimitCode' => '

The limit code.

', 'ServiceQuotaExceededException$ServiceCode' => '

The service code.

', 'ThrottlingException$Message' => NULL, 'ValidationException$Message' => NULL, 'ValidationExceptionField$Name' => '

The name of the field.

', 'ValidationExceptionField$Message' => '

The message for the field.

', ], ], 'ServiceInsertionAction' => [ 'base' => '

Describes the action that the service insertion will take for any segments associated with it.

', 'refs' => [ 'ServiceInsertionActionList$member' => NULL, ], ], 'ServiceInsertionActionList' => [ 'base' => NULL, 'refs' => [ 'CoreNetworkChangeValues$ServiceInsertionActions' => '

Describes the service insertion action.

', ], ], 'ServiceInsertionSegments' => [ 'base' => '

Describes the segments associated with the service insertion action.

', 'refs' => [ 'CoreNetworkNetworkFunctionGroup$Segments' => '

The segments associated with the network function group.

', ], ], 'ServiceQuotaExceededException' => [ 'base' => '

A service limit was exceeded.

', 'refs' => [], ], 'Site' => [ 'base' => '

Describes a site.

', 'refs' => [ 'CreateSiteResponse$Site' => '

Information about the site.

', 'DeleteSiteResponse$Site' => '

Information about the site.

', 'SiteList$member' => NULL, 'UpdateSiteResponse$Site' => '

Information about the site.

', ], ], 'SiteArn' => [ 'base' => NULL, 'refs' => [ 'Site$SiteArn' => '

The Amazon Resource Name (ARN) of the site.

', ], ], 'SiteId' => [ 'base' => NULL, 'refs' => [ 'CreateDeviceRequest$SiteId' => '

The ID of the site.

', 'CreateLinkRequest$SiteId' => '

The ID of the site.

', 'DeleteSiteRequest$SiteId' => '

The ID of the site.

', 'Device$SiteId' => '

The site ID.

', 'GetDevicesRequest$SiteId' => '

The ID of the site.

', 'GetLinksRequest$SiteId' => '

The ID of the site.

', 'Link$SiteId' => '

The ID of the site.

', 'Site$SiteId' => '

The ID of the site.

', 'SiteIdList$member' => NULL, 'UpdateDeviceRequest$SiteId' => '

The ID of the site.

', 'UpdateSiteRequest$SiteId' => '

The ID of your site.

', ], ], 'SiteIdList' => [ 'base' => NULL, 'refs' => [ 'GetSitesRequest$SiteIds' => '

One or more site IDs. The maximum is 10.

', ], ], 'SiteList' => [ 'base' => NULL, 'refs' => [ 'GetSitesResponse$Sites' => '

The sites.

', ], ], 'SiteState' => [ 'base' => NULL, 'refs' => [ 'Site$State' => '

The state of the site.

', ], ], 'SiteToSiteVpnAttachment' => [ 'base' => '

Creates a site-to-site VPN attachment.

', 'refs' => [ 'CreateSiteToSiteVpnAttachmentResponse$SiteToSiteVpnAttachment' => '

Details about a site-to-site VPN attachment.

', 'GetSiteToSiteVpnAttachmentResponse$SiteToSiteVpnAttachment' => '

Describes the site-to-site attachment.

', ], ], 'StartOrganizationServiceAccessUpdateRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartOrganizationServiceAccessUpdateResponse' => [ 'base' => NULL, 'refs' => [], ], 'StartRouteAnalysisRequest' => [ 'base' => NULL, 'refs' => [], ], 'StartRouteAnalysisResponse' => [ 'base' => NULL, 'refs' => [], ], 'SubnetArn' => [ 'base' => NULL, 'refs' => [ 'AWSLocation$SubnetArn' => '

The Amazon Resource Name (ARN) of the subnet that the device is located in.

', 'ConnectPeer$SubnetArn' => '

The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.

', 'ConnectPeerSummary$SubnetArn' => '

The subnet ARN for the Connect peer summary.

', 'CreateConnectPeerRequest$SubnetArn' => '

The subnet ARN for the Connect peer. This only applies only when the protocol is NO_ENCAP.

', 'SubnetArnList$member' => NULL, ], ], 'SubnetArnList' => [ 'base' => NULL, 'refs' => [ 'CreateVpcAttachmentRequest$SubnetArns' => '

The subnet ARN of the VPC attachment.

', 'UpdateVpcAttachmentRequest$AddSubnetArns' => '

Adds a subnet ARN to the VPC attachment.

', 'UpdateVpcAttachmentRequest$RemoveSubnetArns' => '

Removes a subnet ARN from the attachment.

', 'VpcAttachment$SubnetArns' => '

The subnet ARNs.

', ], ], 'Tag' => [ 'base' => '

Describes a tag.

', 'refs' => [ 'TagList$member' => NULL, ], ], 'TagKey' => [ 'base' => NULL, 'refs' => [ 'Tag$Key' => '

The tag key.

Constraints: Maximum length of 128 characters.

', 'TagKeyList$member' => NULL, ], ], 'TagKeyList' => [ 'base' => NULL, 'refs' => [ 'UntagResourceRequest$TagKeys' => '

The tag keys to remove from the specified resource.

', ], ], 'TagList' => [ 'base' => NULL, 'refs' => [ 'Attachment$Tags' => '

The tags associated with the attachment.

', 'ConnectPeer$Tags' => '

The list of key-value tags associated with the Connect peer.

', 'ConnectPeerSummary$Tags' => '

The list of key-value tags associated with the Connect peer summary.

', 'Connection$Tags' => '

The tags for the connection.

', 'CoreNetwork$Tags' => '

The list of key-value tags associated with a core network.

', 'CoreNetworkSummary$Tags' => '

The key-value tags associated with a core network summary.

', 'CreateConnectAttachmentRequest$Tags' => '

The list of key-value tags associated with the request.

', 'CreateConnectPeerRequest$Tags' => '

The tags associated with the peer request.

', 'CreateConnectionRequest$Tags' => '

The tags to apply to the resource during creation.

', 'CreateCoreNetworkRequest$Tags' => '

Key-value tags associated with a core network request.

', 'CreateDeviceRequest$Tags' => '

The tags to apply to the resource during creation.

', 'CreateDirectConnectGatewayAttachmentRequest$Tags' => '

The key value tags to apply to the Direct Connect gateway attachment during creation.

', 'CreateGlobalNetworkRequest$Tags' => '

The tags to apply to the resource during creation.

', 'CreateLinkRequest$Tags' => '

The tags to apply to the resource during creation.

', 'CreateSiteRequest$Tags' => '

The tags to apply to the resource during creation.

', 'CreateSiteToSiteVpnAttachmentRequest$Tags' => '

The tags associated with the request.

', 'CreateTransitGatewayPeeringRequest$Tags' => '

The list of key-value tags associated with the request.

', 'CreateTransitGatewayRouteTableAttachmentRequest$Tags' => '

The list of key-value tags associated with the request.

', 'CreateVpcAttachmentRequest$Tags' => '

The key-value tags associated with the request.

', 'Device$Tags' => '

The tags for the device.

', 'GlobalNetwork$Tags' => '

The tags for the global network.

', 'Link$Tags' => '

The tags for the link.

', 'ListTagsForResourceResponse$TagList' => '

The list of tags.

', 'NetworkResource$Tags' => '

The tags.

', 'Peering$Tags' => '

The list of key-value tags associated with the peering.

', 'ProposedNetworkFunctionGroupChange$Tags' => '

The list of proposed changes to the key-value tags associated with the network function group.

', 'ProposedSegmentChange$Tags' => '

The list of key-value tags that changed for the segment.

', 'Site$Tags' => '

The tags for the site.

', 'TagResourceRequest$Tags' => '

The tags to apply to the specified resource.

', ], ], 'TagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'TagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'TagValue' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

The tag value.

Constraints: Maximum length of 256 characters.

', ], ], 'ThrottlingException' => [ 'base' => '

The request was denied due to request throttling.

', 'refs' => [], ], 'TransitGatewayArn' => [ 'base' => NULL, 'refs' => [ 'CreateTransitGatewayPeeringRequest$TransitGatewayArn' => '

The ARN of the transit gateway for the peering request.

', 'DeregisterTransitGatewayRequest$TransitGatewayArn' => '

The Amazon Resource Name (ARN) of the transit gateway.

', 'RegisterTransitGatewayRequest$TransitGatewayArn' => '

The Amazon Resource Name (ARN) of the transit gateway.

', 'RouteAnalysisEndpointOptions$TransitGatewayArn' => '

The ARN of the transit gateway.

', 'TransitGatewayArnList$member' => NULL, 'TransitGatewayPeering$TransitGatewayArn' => '

The ARN of the transit gateway.

', 'TransitGatewayRegistration$TransitGatewayArn' => '

The Amazon Resource Name (ARN) of the transit gateway.

', ], ], 'TransitGatewayArnList' => [ 'base' => NULL, 'refs' => [ 'GetTransitGatewayRegistrationsRequest$TransitGatewayArns' => '

The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.

', ], ], 'TransitGatewayAttachmentArn' => [ 'base' => NULL, 'refs' => [ 'RouteAnalysisEndpointOptions$TransitGatewayAttachmentArn' => '

The ARN of the transit gateway attachment.

', 'RouteAnalysisEndpointOptionsSpecification$TransitGatewayAttachmentArn' => '

The ARN of the transit gateway attachment.

', ], ], 'TransitGatewayAttachmentId' => [ 'base' => NULL, 'refs' => [ 'NetworkRouteDestination$TransitGatewayAttachmentId' => '

The ID of the transit gateway attachment.

', ], ], 'TransitGatewayConnectPeerArn' => [ 'base' => NULL, 'refs' => [ 'AssociateTransitGatewayConnectPeerRequest$TransitGatewayConnectPeerArn' => '

The Amazon Resource Name (ARN) of the Connect peer.

', 'DisassociateTransitGatewayConnectPeerRequest$TransitGatewayConnectPeerArn' => '

The Amazon Resource Name (ARN) of the transit gateway Connect peer.

', 'TransitGatewayConnectPeerArnList$member' => NULL, 'TransitGatewayConnectPeerAssociation$TransitGatewayConnectPeerArn' => '

The Amazon Resource Name (ARN) of the transit gateway Connect peer.

', ], ], 'TransitGatewayConnectPeerArnList' => [ 'base' => NULL, 'refs' => [ 'GetTransitGatewayConnectPeerAssociationsRequest$TransitGatewayConnectPeerArns' => '

One or more transit gateway Connect peer Amazon Resource Names (ARNs).

', ], ], 'TransitGatewayConnectPeerAssociation' => [ 'base' => '

Describes a transit gateway Connect peer association.

', 'refs' => [ 'AssociateTransitGatewayConnectPeerResponse$TransitGatewayConnectPeerAssociation' => '

The transit gateway Connect peer association.

', 'DisassociateTransitGatewayConnectPeerResponse$TransitGatewayConnectPeerAssociation' => '

The transit gateway Connect peer association.

', 'TransitGatewayConnectPeerAssociationList$member' => NULL, ], ], 'TransitGatewayConnectPeerAssociationList' => [ 'base' => NULL, 'refs' => [ 'GetTransitGatewayConnectPeerAssociationsResponse$TransitGatewayConnectPeerAssociations' => '

Information about the transit gateway Connect peer associations.

', ], ], 'TransitGatewayConnectPeerAssociationState' => [ 'base' => NULL, 'refs' => [ 'TransitGatewayConnectPeerAssociation$State' => '

The state of the association.

', ], ], 'TransitGatewayPeering' => [ 'base' => '

Describes a transit gateway peering attachment.

', 'refs' => [ 'CreateTransitGatewayPeeringResponse$TransitGatewayPeering' => '

Returns information about the transit gateway peering connection request.

', 'GetTransitGatewayPeeringResponse$TransitGatewayPeering' => '

Returns information about a transit gateway peering.

', ], ], 'TransitGatewayPeeringAttachmentId' => [ 'base' => NULL, 'refs' => [ 'TransitGatewayPeering$TransitGatewayPeeringAttachmentId' => '

The ID of the transit gateway peering attachment.

', ], ], 'TransitGatewayRegistration' => [ 'base' => '

Describes the registration of a transit gateway to a global network.

', 'refs' => [ 'DeregisterTransitGatewayResponse$TransitGatewayRegistration' => '

The transit gateway registration information.

', 'RegisterTransitGatewayResponse$TransitGatewayRegistration' => '

Information about the transit gateway registration.

', 'TransitGatewayRegistrationList$member' => NULL, ], ], 'TransitGatewayRegistrationList' => [ 'base' => NULL, 'refs' => [ 'GetTransitGatewayRegistrationsResponse$TransitGatewayRegistrations' => '

The transit gateway registrations.

', ], ], 'TransitGatewayRegistrationState' => [ 'base' => NULL, 'refs' => [ 'TransitGatewayRegistrationStateReason$Code' => '

The code for the state reason.

', ], ], 'TransitGatewayRegistrationStateReason' => [ 'base' => '

Describes the status of a transit gateway registration.

', 'refs' => [ 'TransitGatewayRegistration$State' => '

The state of the transit gateway registration.

', ], ], 'TransitGatewayRouteTableArn' => [ 'base' => NULL, 'refs' => [ 'CreateTransitGatewayRouteTableAttachmentRequest$TransitGatewayRouteTableArn' => '

The ARN of the transit gateway route table for the attachment request. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

', 'RouteTableIdentifier$TransitGatewayRouteTableArn' => '

The ARN of the transit gateway route table for the attachment request. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

', 'TransitGatewayRouteTableAttachment$TransitGatewayRouteTableArn' => '

The ARN of the transit gateway attachment route table. For example, "TransitGatewayRouteTableArn": "arn:aws:ec2:us-west-2:123456789012:transit-gateway-route-table/tgw-rtb-9876543210123456".

', ], ], 'TransitGatewayRouteTableAttachment' => [ 'base' => '

Describes a transit gateway route table attachment.

', 'refs' => [ 'CreateTransitGatewayRouteTableAttachmentResponse$TransitGatewayRouteTableAttachment' => '

The route table associated with the create transit gateway route table attachment request.

', 'GetTransitGatewayRouteTableAttachmentResponse$TransitGatewayRouteTableAttachment' => '

Returns information about the transit gateway route table attachment.

', ], ], 'TunnelProtocol' => [ 'base' => NULL, 'refs' => [ 'ConnectAttachmentOptions$Protocol' => '

The protocol used for the attachment connection.

', 'ConnectPeerConfiguration$Protocol' => '

The protocol used for a Connect peer configuration.

', ], ], 'UntagResourceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UntagResourceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateConnectionResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCoreNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateCoreNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDirectConnectGatewayAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDirectConnectGatewayAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGlobalNetworkRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateGlobalNetworkResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLinkRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateLinkResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNetworkResourceMetadataRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateNetworkResourceMetadataResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateSiteResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVpcAttachmentRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateVpcAttachmentResponse' => [ 'base' => NULL, 'refs' => [], ], 'ValidationException' => [ 'base' => '

The input fails to satisfy the constraints.

', 'refs' => [], ], 'ValidationExceptionField' => [ 'base' => '

Describes a validation exception for a field.

', 'refs' => [ 'ValidationExceptionFieldList$member' => NULL, ], ], 'ValidationExceptionFieldList' => [ 'base' => NULL, 'refs' => [ 'ValidationException$Fields' => '

The fields that caused the error, if applicable.

', ], ], 'ValidationExceptionReason' => [ 'base' => NULL, 'refs' => [ 'ValidationException$Reason' => '

The reason for the error.

', ], ], 'Via' => [ 'base' => '

The list of network function groups and edge overrides for the service insertion action. Used for both the send-to and send-via actions.

', 'refs' => [ 'ServiceInsertionAction$Via' => '

The list of network function groups and any edge overrides for the chosen service insertion action. Used for both send-to or send-via.

', ], ], 'VpcArn' => [ 'base' => NULL, 'refs' => [ 'CreateVpcAttachmentRequest$VpcArn' => '

The ARN of the VPC.

', ], ], 'VpcAttachment' => [ 'base' => '

Describes a VPC attachment.

', 'refs' => [ 'CreateVpcAttachmentResponse$VpcAttachment' => '

Provides details about the VPC attachment.

', 'GetVpcAttachmentResponse$VpcAttachment' => '

Returns details about a VPC attachment.

', 'UpdateVpcAttachmentResponse$VpcAttachment' => '

Describes the updated VPC attachment.

', ], ], 'VpcOptions' => [ 'base' => '

Describes the VPC options.

', 'refs' => [ 'CreateVpcAttachmentRequest$Options' => '

Options for the VPC attachment.

', 'UpdateVpcAttachmentRequest$Options' => '

Additional options for updating the VPC attachment.

', 'VpcAttachment$Options' => '

Provides details about the VPC attachment.

', ], ], 'VpnConnectionArn' => [ 'base' => NULL, 'refs' => [ 'CreateSiteToSiteVpnAttachmentRequest$VpnConnectionArn' => '

The ARN identifying the VPN attachment.

', 'SiteToSiteVpnAttachment$VpnConnectionArn' => '

The ARN of the site-to-site VPN attachment.

', ], ], 'WhenSentTo' => [ 'base' => '

Displays a list of the destination segments. Used only when the service insertion action is send-to.

', 'refs' => [ 'ServiceInsertionAction$WhenSentTo' => '

The list of destination segments if the service insertion action is send-via.

', ], ], 'WhenSentToSegmentsList' => [ 'base' => NULL, 'refs' => [ 'WhenSentTo$WhenSentToSegmentsList' => '

The list of destination segments when the service insertion action is send-to.

', ], ], 'WithEdgeOverridesList' => [ 'base' => NULL, 'refs' => [ 'Via$WithEdgeOverrides' => '

Describes any edge overrides. An edge override is a specific edge to be used for traffic.

', ], ], ],]; diff --git a/src/data/s3/2006-03-01/api-2.json b/src/data/s3/2006-03-01/api-2.json index cdcce18939..b072264c21 100644 --- a/src/data/s3/2006-03-01/api-2.json +++ b/src/data/s3/2006-03-01/api-2.json @@ -1870,6 +1870,11 @@ "location":"header", "locationName":"x-amz-expected-bucket-owner" }, + "IfMatch":{ + "shape":"IfMatch", + "location":"header", + "locationName":"If-Match" + }, "IfNoneMatch":{ "shape":"IfNoneMatch", "location":"header", @@ -7711,6 +7716,11 @@ "location":"header", "locationName":"Expires" }, + "IfMatch":{ + "shape":"IfMatch", + "location":"header", + "locationName":"If-Match" + }, "IfNoneMatch":{ "shape":"IfNoneMatch", "location":"header", diff --git a/src/data/s3/2006-03-01/api-2.json.php b/src/data/s3/2006-03-01/api-2.json.php index 5238f1272c..b002e65ea3 100644 --- a/src/data/s3/2006-03-01/api-2.json.php +++ b/src/data/s3/2006-03-01/api-2.json.php @@ -1,3 +1,3 @@ '2.0', 'metadata' => [ 'apiVersion' => '2006-03-01', 'checksumFormat' => 'md5', 'endpointPrefix' => 's3', 'globalEndpoint' => 's3.amazonaws.com', 'protocol' => 'rest-xml', 'protocols' => [ 'rest-xml', ], 'serviceAbbreviation' => 'Amazon S3', 'serviceFullName' => 'Amazon Simple Storage Service', 'serviceId' => 'S3', 'signatureVersion' => 's3', 'uid' => 's3-2006-03-01', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'AbortMultipartUpload' => [ 'name' => 'AbortMultipartUpload', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}/{Key+}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'AbortMultipartUploadRequest', ], 'output' => [ 'shape' => 'AbortMultipartUploadOutput', ], 'errors' => [ [ 'shape' => 'NoSuchUpload', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html', ], 'CompleteMultipartUpload' => [ 'name' => 'CompleteMultipartUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'CompleteMultipartUploadRequest', ], 'output' => [ 'shape' => 'CompleteMultipartUploadOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html', ], 'CopyObject' => [ 'name' => 'CopyObject', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'CopyObjectRequest', ], 'output' => [ 'shape' => 'CopyObjectOutput', ], 'errors' => [ [ 'shape' => 'ObjectNotInActiveTierError', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html', 'alias' => 'PutObjectCopy', 'staticContextParams' => [ 'DisableS3ExpressSessionAuth' => [ 'value' => true, ], ], ], 'CreateBucket' => [ 'name' => 'CreateBucket', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}', ], 'input' => [ 'shape' => 'CreateBucketRequest', ], 'output' => [ 'shape' => 'CreateBucketOutput', ], 'errors' => [ [ 'shape' => 'BucketAlreadyExists', ], [ 'shape' => 'BucketAlreadyOwnedByYou', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html', 'alias' => 'PutBucket', 'staticContextParams' => [ 'DisableAccessPoints' => [ 'value' => true, ], 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'CreateMultipartUpload' => [ 'name' => 'CreateMultipartUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/{Bucket}/{Key+}?uploads', ], 'input' => [ 'shape' => 'CreateMultipartUploadRequest', ], 'output' => [ 'shape' => 'CreateMultipartUploadOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html', 'alias' => 'InitiateMultipartUpload', ], 'CreateSession' => [ 'name' => 'CreateSession', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?session', ], 'input' => [ 'shape' => 'CreateSessionRequest', ], 'output' => [ 'shape' => 'CreateSessionOutput', ], 'errors' => [ [ 'shape' => 'NoSuchBucket', ], ], 'staticContextParams' => [ 'DisableS3ExpressSessionAuth' => [ 'value' => true, ], ], ], 'DeleteBucket' => [ 'name' => 'DeleteBucket', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETE.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketAnalyticsConfiguration' => [ 'name' => 'DeleteBucketAnalyticsConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?analytics', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketAnalyticsConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketCors' => [ 'name' => 'DeleteBucketCors', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?cors', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketCorsRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketEncryption' => [ 'name' => 'DeleteBucketEncryption', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?encryption', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketEncryptionRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketIntelligentTieringConfiguration' => [ 'name' => 'DeleteBucketIntelligentTieringConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?intelligent-tiering', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketIntelligentTieringConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketInventoryConfiguration' => [ 'name' => 'DeleteBucketInventoryConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?inventory', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketInventoryConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketLifecycle' => [ 'name' => 'DeleteBucketLifecycle', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?lifecycle', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketLifecycleRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketMetricsConfiguration' => [ 'name' => 'DeleteBucketMetricsConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?metrics', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketMetricsConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketOwnershipControls' => [ 'name' => 'DeleteBucketOwnershipControls', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?ownershipControls', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketOwnershipControlsRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketPolicy' => [ 'name' => 'DeleteBucketPolicy', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?policy', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketPolicyRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketReplication' => [ 'name' => 'DeleteBucketReplication', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?replication', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketReplicationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketTagging' => [ 'name' => 'DeleteBucketTagging', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?tagging', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketTaggingRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEtagging.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketWebsite' => [ 'name' => 'DeleteBucketWebsite', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?website', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketWebsiteRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteObject' => [ 'name' => 'DeleteObject', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}/{Key+}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteObjectRequest', ], 'output' => [ 'shape' => 'DeleteObjectOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html', ], 'DeleteObjectTagging' => [ 'name' => 'DeleteObjectTagging', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}/{Key+}?tagging', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteObjectTaggingRequest', ], 'output' => [ 'shape' => 'DeleteObjectTaggingOutput', ], ], 'DeleteObjects' => [ 'name' => 'DeleteObjects', 'http' => [ 'method' => 'POST', 'requestUri' => '/{Bucket}?delete', ], 'input' => [ 'shape' => 'DeleteObjectsRequest', ], 'output' => [ 'shape' => 'DeleteObjectsOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html', 'alias' => 'DeleteMultipleObjects', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], ], 'DeletePublicAccessBlock' => [ 'name' => 'DeletePublicAccessBlock', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?publicAccessBlock', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeletePublicAccessBlockRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketAccelerateConfiguration' => [ 'name' => 'GetBucketAccelerateConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?accelerate', ], 'input' => [ 'shape' => 'GetBucketAccelerateConfigurationRequest', ], 'output' => [ 'shape' => 'GetBucketAccelerateConfigurationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketAcl' => [ 'name' => 'GetBucketAcl', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?acl', ], 'input' => [ 'shape' => 'GetBucketAclRequest', ], 'output' => [ 'shape' => 'GetBucketAclOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketAnalyticsConfiguration' => [ 'name' => 'GetBucketAnalyticsConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?analytics', ], 'input' => [ 'shape' => 'GetBucketAnalyticsConfigurationRequest', ], 'output' => [ 'shape' => 'GetBucketAnalyticsConfigurationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketCors' => [ 'name' => 'GetBucketCors', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?cors', ], 'input' => [ 'shape' => 'GetBucketCorsRequest', ], 'output' => [ 'shape' => 'GetBucketCorsOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketEncryption' => [ 'name' => 'GetBucketEncryption', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?encryption', ], 'input' => [ 'shape' => 'GetBucketEncryptionRequest', ], 'output' => [ 'shape' => 'GetBucketEncryptionOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketIntelligentTieringConfiguration' => [ 'name' => 'GetBucketIntelligentTieringConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?intelligent-tiering', ], 'input' => [ 'shape' => 'GetBucketIntelligentTieringConfigurationRequest', ], 'output' => [ 'shape' => 'GetBucketIntelligentTieringConfigurationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketInventoryConfiguration' => [ 'name' => 'GetBucketInventoryConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?inventory', ], 'input' => [ 'shape' => 'GetBucketInventoryConfigurationRequest', ], 'output' => [ 'shape' => 'GetBucketInventoryConfigurationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketLifecycle' => [ 'name' => 'GetBucketLifecycle', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?lifecycle', ], 'input' => [ 'shape' => 'GetBucketLifecycleRequest', ], 'output' => [ 'shape' => 'GetBucketLifecycleOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html', 'deprecated' => true, 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketLifecycleConfiguration' => [ 'name' => 'GetBucketLifecycleConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?lifecycle', ], 'input' => [ 'shape' => 'GetBucketLifecycleConfigurationRequest', ], 'output' => [ 'shape' => 'GetBucketLifecycleConfigurationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketLocation' => [ 'name' => 'GetBucketLocation', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?location', ], 'input' => [ 'shape' => 'GetBucketLocationRequest', ], 'output' => [ 'shape' => 'GetBucketLocationOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketLogging' => [ 'name' => 'GetBucketLogging', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?logging', ], 'input' => [ 'shape' => 'GetBucketLoggingRequest', ], 'output' => [ 'shape' => 'GetBucketLoggingOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketMetricsConfiguration' => [ 'name' => 'GetBucketMetricsConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?metrics', ], 'input' => [ 'shape' => 'GetBucketMetricsConfigurationRequest', ], 'output' => [ 'shape' => 'GetBucketMetricsConfigurationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketNotification' => [ 'name' => 'GetBucketNotification', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?notification', ], 'input' => [ 'shape' => 'GetBucketNotificationConfigurationRequest', ], 'output' => [ 'shape' => 'NotificationConfigurationDeprecated', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETnotification.html', 'deprecated' => true, 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketNotificationConfiguration' => [ 'name' => 'GetBucketNotificationConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?notification', ], 'input' => [ 'shape' => 'GetBucketNotificationConfigurationRequest', ], 'output' => [ 'shape' => 'NotificationConfiguration', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketOwnershipControls' => [ 'name' => 'GetBucketOwnershipControls', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?ownershipControls', ], 'input' => [ 'shape' => 'GetBucketOwnershipControlsRequest', ], 'output' => [ 'shape' => 'GetBucketOwnershipControlsOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketPolicy' => [ 'name' => 'GetBucketPolicy', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?policy', ], 'input' => [ 'shape' => 'GetBucketPolicyRequest', ], 'output' => [ 'shape' => 'GetBucketPolicyOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketPolicyStatus' => [ 'name' => 'GetBucketPolicyStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?policyStatus', ], 'input' => [ 'shape' => 'GetBucketPolicyStatusRequest', ], 'output' => [ 'shape' => 'GetBucketPolicyStatusOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketReplication' => [ 'name' => 'GetBucketReplication', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?replication', ], 'input' => [ 'shape' => 'GetBucketReplicationRequest', ], 'output' => [ 'shape' => 'GetBucketReplicationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketRequestPayment' => [ 'name' => 'GetBucketRequestPayment', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?requestPayment', ], 'input' => [ 'shape' => 'GetBucketRequestPaymentRequest', ], 'output' => [ 'shape' => 'GetBucketRequestPaymentOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketTagging' => [ 'name' => 'GetBucketTagging', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?tagging', ], 'input' => [ 'shape' => 'GetBucketTaggingRequest', ], 'output' => [ 'shape' => 'GetBucketTaggingOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETtagging.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketVersioning' => [ 'name' => 'GetBucketVersioning', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?versioning', ], 'input' => [ 'shape' => 'GetBucketVersioningRequest', ], 'output' => [ 'shape' => 'GetBucketVersioningOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketWebsite' => [ 'name' => 'GetBucketWebsite', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?website', ], 'input' => [ 'shape' => 'GetBucketWebsiteRequest', ], 'output' => [ 'shape' => 'GetBucketWebsiteOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetObject' => [ 'name' => 'GetObject', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'GetObjectRequest', ], 'output' => [ 'shape' => 'GetObjectOutput', ], 'errors' => [ [ 'shape' => 'NoSuchKey', ], [ 'shape' => 'InvalidObjectState', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html', 'httpChecksum' => [ 'requestValidationModeMember' => 'ChecksumMode', 'responseAlgorithms' => [ 'CRC32', 'CRC32C', 'SHA256', 'SHA1', ], ], ], 'GetObjectAcl' => [ 'name' => 'GetObjectAcl', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}?acl', ], 'input' => [ 'shape' => 'GetObjectAclRequest', ], 'output' => [ 'shape' => 'GetObjectAclOutput', ], 'errors' => [ [ 'shape' => 'NoSuchKey', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html', ], 'GetObjectAttributes' => [ 'name' => 'GetObjectAttributes', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}?attributes', ], 'input' => [ 'shape' => 'GetObjectAttributesRequest', ], 'output' => [ 'shape' => 'GetObjectAttributesOutput', ], 'errors' => [ [ 'shape' => 'NoSuchKey', ], ], ], 'GetObjectLegalHold' => [ 'name' => 'GetObjectLegalHold', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}?legal-hold', ], 'input' => [ 'shape' => 'GetObjectLegalHoldRequest', ], 'output' => [ 'shape' => 'GetObjectLegalHoldOutput', ], ], 'GetObjectLockConfiguration' => [ 'name' => 'GetObjectLockConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?object-lock', ], 'input' => [ 'shape' => 'GetObjectLockConfigurationRequest', ], 'output' => [ 'shape' => 'GetObjectLockConfigurationOutput', ], ], 'GetObjectRetention' => [ 'name' => 'GetObjectRetention', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}?retention', ], 'input' => [ 'shape' => 'GetObjectRetentionRequest', ], 'output' => [ 'shape' => 'GetObjectRetentionOutput', ], ], 'GetObjectTagging' => [ 'name' => 'GetObjectTagging', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}?tagging', ], 'input' => [ 'shape' => 'GetObjectTaggingRequest', ], 'output' => [ 'shape' => 'GetObjectTaggingOutput', ], ], 'GetObjectTorrent' => [ 'name' => 'GetObjectTorrent', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}?torrent', ], 'input' => [ 'shape' => 'GetObjectTorrentRequest', ], 'output' => [ 'shape' => 'GetObjectTorrentOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html', ], 'GetPublicAccessBlock' => [ 'name' => 'GetPublicAccessBlock', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?publicAccessBlock', ], 'input' => [ 'shape' => 'GetPublicAccessBlockRequest', ], 'output' => [ 'shape' => 'GetPublicAccessBlockOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'HeadBucket' => [ 'name' => 'HeadBucket', 'http' => [ 'method' => 'HEAD', 'requestUri' => '/{Bucket}', ], 'input' => [ 'shape' => 'HeadBucketRequest', ], 'output' => [ 'shape' => 'HeadBucketOutput', ], 'errors' => [ [ 'shape' => 'NoSuchBucket', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketHEAD.html', ], 'HeadObject' => [ 'name' => 'HeadObject', 'http' => [ 'method' => 'HEAD', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'HeadObjectRequest', ], 'output' => [ 'shape' => 'HeadObjectOutput', ], 'errors' => [ [ 'shape' => 'NoSuchKey', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html', ], 'ListBucketAnalyticsConfigurations' => [ 'name' => 'ListBucketAnalyticsConfigurations', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?analytics', ], 'input' => [ 'shape' => 'ListBucketAnalyticsConfigurationsRequest', ], 'output' => [ 'shape' => 'ListBucketAnalyticsConfigurationsOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'ListBucketIntelligentTieringConfigurations' => [ 'name' => 'ListBucketIntelligentTieringConfigurations', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?intelligent-tiering', ], 'input' => [ 'shape' => 'ListBucketIntelligentTieringConfigurationsRequest', ], 'output' => [ 'shape' => 'ListBucketIntelligentTieringConfigurationsOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'ListBucketInventoryConfigurations' => [ 'name' => 'ListBucketInventoryConfigurations', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?inventory', ], 'input' => [ 'shape' => 'ListBucketInventoryConfigurationsRequest', ], 'output' => [ 'shape' => 'ListBucketInventoryConfigurationsOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'ListBucketMetricsConfigurations' => [ 'name' => 'ListBucketMetricsConfigurations', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?metrics', ], 'input' => [ 'shape' => 'ListBucketMetricsConfigurationsRequest', ], 'output' => [ 'shape' => 'ListBucketMetricsConfigurationsOutput', ], ], 'ListBuckets' => [ 'name' => 'ListBuckets', 'http' => [ 'method' => 'GET', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListBucketsRequest', ], 'output' => [ 'shape' => 'ListBucketsOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html', 'alias' => 'GetService', ], 'ListDirectoryBuckets' => [ 'name' => 'ListDirectoryBuckets', 'http' => [ 'method' => 'GET', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDirectoryBucketsRequest', ], 'output' => [ 'shape' => 'ListDirectoryBucketsOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'ListMultipartUploads' => [ 'name' => 'ListMultipartUploads', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?uploads', ], 'input' => [ 'shape' => 'ListMultipartUploadsRequest', ], 'output' => [ 'shape' => 'ListMultipartUploadsOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html', ], 'ListObjectVersions' => [ 'name' => 'ListObjectVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?versions', ], 'input' => [ 'shape' => 'ListObjectVersionsRequest', ], 'output' => [ 'shape' => 'ListObjectVersionsOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html', 'alias' => 'GetBucketObjectVersions', ], 'ListObjects' => [ 'name' => 'ListObjects', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}', ], 'input' => [ 'shape' => 'ListObjectsRequest', ], 'output' => [ 'shape' => 'ListObjectsOutput', ], 'errors' => [ [ 'shape' => 'NoSuchBucket', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html', 'alias' => 'GetBucket', ], 'ListObjectsV2' => [ 'name' => 'ListObjectsV2', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?list-type=2', ], 'input' => [ 'shape' => 'ListObjectsV2Request', ], 'output' => [ 'shape' => 'ListObjectsV2Output', ], 'errors' => [ [ 'shape' => 'NoSuchBucket', ], ], ], 'ListParts' => [ 'name' => 'ListParts', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'ListPartsRequest', ], 'output' => [ 'shape' => 'ListPartsOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html', ], 'PutBucketAccelerateConfiguration' => [ 'name' => 'PutBucketAccelerateConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?accelerate', ], 'input' => [ 'shape' => 'PutBucketAccelerateConfigurationRequest', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => false, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketAcl' => [ 'name' => 'PutBucketAcl', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?acl', ], 'input' => [ 'shape' => 'PutBucketAclRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketAnalyticsConfiguration' => [ 'name' => 'PutBucketAnalyticsConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?analytics', ], 'input' => [ 'shape' => 'PutBucketAnalyticsConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketCors' => [ 'name' => 'PutBucketCors', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?cors', ], 'input' => [ 'shape' => 'PutBucketCorsRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketEncryption' => [ 'name' => 'PutBucketEncryption', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?encryption', ], 'input' => [ 'shape' => 'PutBucketEncryptionRequest', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketIntelligentTieringConfiguration' => [ 'name' => 'PutBucketIntelligentTieringConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?intelligent-tiering', ], 'input' => [ 'shape' => 'PutBucketIntelligentTieringConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketInventoryConfiguration' => [ 'name' => 'PutBucketInventoryConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?inventory', ], 'input' => [ 'shape' => 'PutBucketInventoryConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketLifecycle' => [ 'name' => 'PutBucketLifecycle', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?lifecycle', ], 'input' => [ 'shape' => 'PutBucketLifecycleRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html', 'deprecated' => true, 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketLifecycleConfiguration' => [ 'name' => 'PutBucketLifecycleConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?lifecycle', ], 'input' => [ 'shape' => 'PutBucketLifecycleConfigurationRequest', ], 'output' => [ 'shape' => 'PutBucketLifecycleConfigurationOutput', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketLogging' => [ 'name' => 'PutBucketLogging', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?logging', ], 'input' => [ 'shape' => 'PutBucketLoggingRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketMetricsConfiguration' => [ 'name' => 'PutBucketMetricsConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?metrics', ], 'input' => [ 'shape' => 'PutBucketMetricsConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketNotification' => [ 'name' => 'PutBucketNotification', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?notification', ], 'input' => [ 'shape' => 'PutBucketNotificationRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTnotification.html', 'deprecated' => true, 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketNotificationConfiguration' => [ 'name' => 'PutBucketNotificationConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?notification', ], 'input' => [ 'shape' => 'PutBucketNotificationConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketOwnershipControls' => [ 'name' => 'PutBucketOwnershipControls', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?ownershipControls', ], 'input' => [ 'shape' => 'PutBucketOwnershipControlsRequest', ], 'httpChecksum' => [ 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketPolicy' => [ 'name' => 'PutBucketPolicy', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?policy', ], 'input' => [ 'shape' => 'PutBucketPolicyRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketReplication' => [ 'name' => 'PutBucketReplication', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?replication', ], 'input' => [ 'shape' => 'PutBucketReplicationRequest', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketRequestPayment' => [ 'name' => 'PutBucketRequestPayment', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?requestPayment', ], 'input' => [ 'shape' => 'PutBucketRequestPaymentRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketTagging' => [ 'name' => 'PutBucketTagging', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?tagging', ], 'input' => [ 'shape' => 'PutBucketTaggingRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTtagging.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketVersioning' => [ 'name' => 'PutBucketVersioning', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?versioning', ], 'input' => [ 'shape' => 'PutBucketVersioningRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketWebsite' => [ 'name' => 'PutBucketWebsite', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?website', ], 'input' => [ 'shape' => 'PutBucketWebsiteRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutObject' => [ 'name' => 'PutObject', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'PutObjectRequest', ], 'output' => [ 'shape' => 'PutObjectOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequest', ], [ 'shape' => 'InvalidWriteOffset', ], [ 'shape' => 'TooManyParts', ], [ 'shape' => 'EncryptionTypeMismatch', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => false, ], ], 'PutObjectAcl' => [ 'name' => 'PutObjectAcl', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}?acl', ], 'input' => [ 'shape' => 'PutObjectAclRequest', ], 'output' => [ 'shape' => 'PutObjectAclOutput', ], 'errors' => [ [ 'shape' => 'NoSuchKey', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], ], 'PutObjectLegalHold' => [ 'name' => 'PutObjectLegalHold', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}?legal-hold', ], 'input' => [ 'shape' => 'PutObjectLegalHoldRequest', ], 'output' => [ 'shape' => 'PutObjectLegalHoldOutput', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], ], 'PutObjectLockConfiguration' => [ 'name' => 'PutObjectLockConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?object-lock', ], 'input' => [ 'shape' => 'PutObjectLockConfigurationRequest', ], 'output' => [ 'shape' => 'PutObjectLockConfigurationOutput', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], ], 'PutObjectRetention' => [ 'name' => 'PutObjectRetention', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}?retention', ], 'input' => [ 'shape' => 'PutObjectRetentionRequest', ], 'output' => [ 'shape' => 'PutObjectRetentionOutput', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], ], 'PutObjectTagging' => [ 'name' => 'PutObjectTagging', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}?tagging', ], 'input' => [ 'shape' => 'PutObjectTaggingRequest', ], 'output' => [ 'shape' => 'PutObjectTaggingOutput', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], ], 'PutPublicAccessBlock' => [ 'name' => 'PutPublicAccessBlock', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?publicAccessBlock', ], 'input' => [ 'shape' => 'PutPublicAccessBlockRequest', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'RestoreObject' => [ 'name' => 'RestoreObject', 'http' => [ 'method' => 'POST', 'requestUri' => '/{Bucket}/{Key+}?restore', ], 'input' => [ 'shape' => 'RestoreObjectRequest', ], 'output' => [ 'shape' => 'RestoreObjectOutput', ], 'errors' => [ [ 'shape' => 'ObjectAlreadyInActiveTierError', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectRestore.html', 'alias' => 'PostObjectRestore', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => false, ], ], 'SelectObjectContent' => [ 'name' => 'SelectObjectContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/{Bucket}/{Key+}?select&select-type=2', ], 'input' => [ 'shape' => 'SelectObjectContentRequest', 'locationName' => 'SelectObjectContentRequest', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'output' => [ 'shape' => 'SelectObjectContentOutput', ], ], 'UploadPart' => [ 'name' => 'UploadPart', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'UploadPartRequest', ], 'output' => [ 'shape' => 'UploadPartOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => false, ], ], 'UploadPartCopy' => [ 'name' => 'UploadPartCopy', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'UploadPartCopyRequest', ], 'output' => [ 'shape' => 'UploadPartCopyOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html', 'staticContextParams' => [ 'DisableS3ExpressSessionAuth' => [ 'value' => true, ], ], ], 'WriteGetObjectResponse' => [ 'name' => 'WriteGetObjectResponse', 'http' => [ 'method' => 'POST', 'requestUri' => '/WriteGetObjectResponse', ], 'input' => [ 'shape' => 'WriteGetObjectResponseRequest', ], 'authtype' => 'v4-unsigned-body', 'endpoint' => [ 'hostPrefix' => '{RequestRoute}.', ], 'staticContextParams' => [ 'UseObjectLambdaEndpoint' => [ 'value' => true, ], ], 'unsignedPayload' => true, ], ], 'shapes' => [ 'AbortDate' => [ 'type' => 'timestamp', ], 'AbortIncompleteMultipartUpload' => [ 'type' => 'structure', 'members' => [ 'DaysAfterInitiation' => [ 'shape' => 'DaysAfterInitiation', ], ], ], 'AbortMultipartUploadOutput' => [ 'type' => 'structure', 'members' => [ 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'AbortMultipartUploadRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'UploadId', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'UploadId' => [ 'shape' => 'MultipartUploadId', 'location' => 'querystring', 'locationName' => 'uploadId', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'IfMatchInitiatedTime' => [ 'shape' => 'IfMatchInitiatedTime', 'location' => 'header', 'locationName' => 'x-amz-if-match-initiated-time', ], ], ], 'AbortRuleId' => [ 'type' => 'string', ], 'AccelerateConfiguration' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'BucketAccelerateStatus', ], ], ], 'AcceptRanges' => [ 'type' => 'string', ], 'AccessControlPolicy' => [ 'type' => 'structure', 'members' => [ 'Grants' => [ 'shape' => 'Grants', 'locationName' => 'AccessControlList', ], 'Owner' => [ 'shape' => 'Owner', ], ], ], 'AccessControlTranslation' => [ 'type' => 'structure', 'required' => [ 'Owner', ], 'members' => [ 'Owner' => [ 'shape' => 'OwnerOverride', ], ], ], 'AccessKeyIdValue' => [ 'type' => 'string', ], 'AccessPointAlias' => [ 'type' => 'boolean', 'box' => true, ], 'AccessPointArn' => [ 'type' => 'string', ], 'AccountId' => [ 'type' => 'string', ], 'AllowQuotedRecordDelimiter' => [ 'type' => 'boolean', 'box' => true, ], 'AllowedHeader' => [ 'type' => 'string', ], 'AllowedHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'AllowedHeader', ], 'flattened' => true, ], 'AllowedMethod' => [ 'type' => 'string', ], 'AllowedMethods' => [ 'type' => 'list', 'member' => [ 'shape' => 'AllowedMethod', ], 'flattened' => true, ], 'AllowedOrigin' => [ 'type' => 'string', ], 'AllowedOrigins' => [ 'type' => 'list', 'member' => [ 'shape' => 'AllowedOrigin', ], 'flattened' => true, ], 'AnalyticsAndOperator' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tags' => [ 'shape' => 'TagSet', 'flattened' => true, 'locationName' => 'Tag', ], ], ], 'AnalyticsConfiguration' => [ 'type' => 'structure', 'required' => [ 'Id', 'StorageClassAnalysis', ], 'members' => [ 'Id' => [ 'shape' => 'AnalyticsId', ], 'Filter' => [ 'shape' => 'AnalyticsFilter', ], 'StorageClassAnalysis' => [ 'shape' => 'StorageClassAnalysis', ], ], ], 'AnalyticsConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnalyticsConfiguration', ], 'flattened' => true, ], 'AnalyticsExportDestination' => [ 'type' => 'structure', 'required' => [ 'S3BucketDestination', ], 'members' => [ 'S3BucketDestination' => [ 'shape' => 'AnalyticsS3BucketDestination', ], ], ], 'AnalyticsFilter' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tag' => [ 'shape' => 'Tag', ], 'And' => [ 'shape' => 'AnalyticsAndOperator', ], ], ], 'AnalyticsId' => [ 'type' => 'string', ], 'AnalyticsS3BucketDestination' => [ 'type' => 'structure', 'required' => [ 'Format', 'Bucket', ], 'members' => [ 'Format' => [ 'shape' => 'AnalyticsS3ExportFileFormat', ], 'BucketAccountId' => [ 'shape' => 'AccountId', ], 'Bucket' => [ 'shape' => 'BucketName', ], 'Prefix' => [ 'shape' => 'Prefix', ], ], ], 'AnalyticsS3ExportFileFormat' => [ 'type' => 'string', 'enum' => [ 'CSV', ], ], 'ArchiveStatus' => [ 'type' => 'string', 'enum' => [ 'ARCHIVE_ACCESS', 'DEEP_ARCHIVE_ACCESS', ], ], 'Body' => [ 'type' => 'blob', ], 'Bucket' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'BucketName', ], 'CreationDate' => [ 'shape' => 'CreationDate', ], 'BucketRegion' => [ 'shape' => 'BucketRegion', ], ], ], 'BucketAccelerateStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Suspended', ], ], 'BucketAlreadyExists' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'BucketAlreadyOwnedByYou' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'BucketCannedACL' => [ 'type' => 'string', 'enum' => [ 'private', 'public-read', 'public-read-write', 'authenticated-read', ], ], 'BucketInfo' => [ 'type' => 'structure', 'members' => [ 'DataRedundancy' => [ 'shape' => 'DataRedundancy', ], 'Type' => [ 'shape' => 'BucketType', ], ], ], 'BucketKeyEnabled' => [ 'type' => 'boolean', 'box' => true, ], 'BucketLifecycleConfiguration' => [ 'type' => 'structure', 'required' => [ 'Rules', ], 'members' => [ 'Rules' => [ 'shape' => 'LifecycleRules', 'locationName' => 'Rule', ], ], ], 'BucketLocationConstraint' => [ 'type' => 'string', 'enum' => [ 'af-south-1', 'ap-east-1', 'ap-northeast-1', 'ap-northeast-2', 'ap-northeast-3', 'ap-south-1', 'ap-south-2', 'ap-southeast-1', 'ap-southeast-2', 'ap-southeast-3', 'ca-central-1', 'cn-north-1', 'cn-northwest-1', 'EU', 'eu-central-1', 'eu-north-1', 'eu-south-1', 'eu-south-2', 'eu-west-1', 'eu-west-2', 'eu-west-3', 'me-south-1', 'sa-east-1', 'us-east-2', 'us-gov-east-1', 'us-gov-west-1', 'us-west-1', 'us-west-2', ], ], 'BucketLocationName' => [ 'type' => 'string', ], 'BucketLoggingStatus' => [ 'type' => 'structure', 'members' => [ 'LoggingEnabled' => [ 'shape' => 'LoggingEnabled', ], ], ], 'BucketLogsPermission' => [ 'type' => 'string', 'enum' => [ 'FULL_CONTROL', 'READ', 'WRITE', ], ], 'BucketName' => [ 'type' => 'string', ], 'BucketRegion' => [ 'type' => 'string', ], 'BucketType' => [ 'type' => 'string', 'enum' => [ 'Directory', ], ], 'BucketVersioningStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Suspended', ], ], 'Buckets' => [ 'type' => 'list', 'member' => [ 'shape' => 'Bucket', 'locationName' => 'Bucket', ], ], 'BypassGovernanceRetention' => [ 'type' => 'boolean', 'box' => true, ], 'BytesProcessed' => [ 'type' => 'long', 'box' => true, ], 'BytesReturned' => [ 'type' => 'long', 'box' => true, ], 'BytesScanned' => [ 'type' => 'long', 'box' => true, ], 'CORSConfiguration' => [ 'type' => 'structure', 'required' => [ 'CORSRules', ], 'members' => [ 'CORSRules' => [ 'shape' => 'CORSRules', 'locationName' => 'CORSRule', ], ], ], 'CORSRule' => [ 'type' => 'structure', 'required' => [ 'AllowedMethods', 'AllowedOrigins', ], 'members' => [ 'ID' => [ 'shape' => 'ID', ], 'AllowedHeaders' => [ 'shape' => 'AllowedHeaders', 'locationName' => 'AllowedHeader', ], 'AllowedMethods' => [ 'shape' => 'AllowedMethods', 'locationName' => 'AllowedMethod', ], 'AllowedOrigins' => [ 'shape' => 'AllowedOrigins', 'locationName' => 'AllowedOrigin', ], 'ExposeHeaders' => [ 'shape' => 'ExposeHeaders', 'locationName' => 'ExposeHeader', ], 'MaxAgeSeconds' => [ 'shape' => 'MaxAgeSeconds', ], ], ], 'CORSRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'CORSRule', ], 'flattened' => true, ], 'CSVInput' => [ 'type' => 'structure', 'members' => [ 'FileHeaderInfo' => [ 'shape' => 'FileHeaderInfo', ], 'Comments' => [ 'shape' => 'Comments', ], 'QuoteEscapeCharacter' => [ 'shape' => 'QuoteEscapeCharacter', ], 'RecordDelimiter' => [ 'shape' => 'RecordDelimiter', ], 'FieldDelimiter' => [ 'shape' => 'FieldDelimiter', ], 'QuoteCharacter' => [ 'shape' => 'QuoteCharacter', ], 'AllowQuotedRecordDelimiter' => [ 'shape' => 'AllowQuotedRecordDelimiter', ], ], ], 'CSVOutput' => [ 'type' => 'structure', 'members' => [ 'QuoteFields' => [ 'shape' => 'QuoteFields', ], 'QuoteEscapeCharacter' => [ 'shape' => 'QuoteEscapeCharacter', ], 'RecordDelimiter' => [ 'shape' => 'RecordDelimiter', ], 'FieldDelimiter' => [ 'shape' => 'FieldDelimiter', ], 'QuoteCharacter' => [ 'shape' => 'QuoteCharacter', ], ], ], 'CacheControl' => [ 'type' => 'string', ], 'Checksum' => [ 'type' => 'structure', 'members' => [ 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], ], ], 'ChecksumAlgorithm' => [ 'type' => 'string', 'enum' => [ 'CRC32', 'CRC32C', 'SHA1', 'SHA256', ], ], 'ChecksumAlgorithmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChecksumAlgorithm', ], 'flattened' => true, ], 'ChecksumCRC32' => [ 'type' => 'string', ], 'ChecksumCRC32C' => [ 'type' => 'string', ], 'ChecksumMode' => [ 'type' => 'string', 'enum' => [ 'ENABLED', ], ], 'ChecksumSHA1' => [ 'type' => 'string', ], 'ChecksumSHA256' => [ 'type' => 'string', ], 'CloudFunction' => [ 'type' => 'string', ], 'CloudFunctionConfiguration' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'NotificationId', ], 'Event' => [ 'shape' => 'Event', 'deprecated' => true, ], 'Events' => [ 'shape' => 'EventList', 'locationName' => 'Event', ], 'CloudFunction' => [ 'shape' => 'CloudFunction', ], 'InvocationRole' => [ 'shape' => 'CloudFunctionInvocationRole', ], ], ], 'CloudFunctionInvocationRole' => [ 'type' => 'string', ], 'Code' => [ 'type' => 'string', ], 'Comments' => [ 'type' => 'string', ], 'CommonPrefix' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], ], ], 'CommonPrefixList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CommonPrefix', ], 'flattened' => true, ], 'CompleteMultipartUploadOutput' => [ 'type' => 'structure', 'members' => [ 'Location' => [ 'shape' => 'Location', ], 'Bucket' => [ 'shape' => 'BucketName', ], 'Key' => [ 'shape' => 'ObjectKey', ], 'Expiration' => [ 'shape' => 'Expiration', 'location' => 'header', 'locationName' => 'x-amz-expiration', ], 'ETag' => [ 'shape' => 'ETag', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'CompleteMultipartUploadRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'UploadId', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'MultipartUpload' => [ 'shape' => 'CompletedMultipartUpload', 'locationName' => 'CompleteMultipartUpload', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'UploadId' => [ 'shape' => 'MultipartUploadId', 'location' => 'querystring', 'locationName' => 'uploadId', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'IfNoneMatch' => [ 'shape' => 'IfNoneMatch', 'location' => 'header', 'locationName' => 'If-None-Match', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], ], 'payload' => 'MultipartUpload', ], 'CompletedMultipartUpload' => [ 'type' => 'structure', 'members' => [ 'Parts' => [ 'shape' => 'CompletedPartList', 'locationName' => 'Part', ], ], ], 'CompletedPart' => [ 'type' => 'structure', 'members' => [ 'ETag' => [ 'shape' => 'ETag', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], 'PartNumber' => [ 'shape' => 'PartNumber', ], ], ], 'CompletedPartList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompletedPart', ], 'flattened' => true, ], 'CompressionType' => [ 'type' => 'string', 'enum' => [ 'NONE', 'GZIP', 'BZIP2', ], ], 'Condition' => [ 'type' => 'structure', 'members' => [ 'HttpErrorCodeReturnedEquals' => [ 'shape' => 'HttpErrorCodeReturnedEquals', ], 'KeyPrefixEquals' => [ 'shape' => 'KeyPrefixEquals', ], ], ], 'ConfirmRemoveSelfBucketAccess' => [ 'type' => 'boolean', 'box' => true, ], 'ContentDisposition' => [ 'type' => 'string', ], 'ContentEncoding' => [ 'type' => 'string', ], 'ContentLanguage' => [ 'type' => 'string', ], 'ContentLength' => [ 'type' => 'long', ], 'ContentMD5' => [ 'type' => 'string', ], 'ContentRange' => [ 'type' => 'string', ], 'ContentType' => [ 'type' => 'string', ], 'ContinuationEvent' => [ 'type' => 'structure', 'members' => [], 'event' => true, ], 'CopyObjectOutput' => [ 'type' => 'structure', 'members' => [ 'CopyObjectResult' => [ 'shape' => 'CopyObjectResult', ], 'Expiration' => [ 'shape' => 'Expiration', 'location' => 'header', 'locationName' => 'x-amz-expiration', ], 'CopySourceVersionId' => [ 'shape' => 'CopySourceVersionId', 'location' => 'header', 'locationName' => 'x-amz-copy-source-version-id', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], 'payload' => 'CopyObjectResult', ], 'CopyObjectRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'CopySource', 'Key', ], 'members' => [ 'ACL' => [ 'shape' => 'ObjectCannedACL', 'location' => 'header', 'locationName' => 'x-amz-acl', ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'CacheControl' => [ 'shape' => 'CacheControl', 'location' => 'header', 'locationName' => 'Cache-Control', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-checksum-algorithm', ], 'ContentDisposition' => [ 'shape' => 'ContentDisposition', 'location' => 'header', 'locationName' => 'Content-Disposition', ], 'ContentEncoding' => [ 'shape' => 'ContentEncoding', 'location' => 'header', 'locationName' => 'Content-Encoding', ], 'ContentLanguage' => [ 'shape' => 'ContentLanguage', 'location' => 'header', 'locationName' => 'Content-Language', ], 'ContentType' => [ 'shape' => 'ContentType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'CopySource' => [ 'shape' => 'CopySource', 'contextParam' => [ 'name' => 'CopySource', ], 'location' => 'header', 'locationName' => 'x-amz-copy-source', ], 'CopySourceIfMatch' => [ 'shape' => 'CopySourceIfMatch', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-match', ], 'CopySourceIfModifiedSince' => [ 'shape' => 'CopySourceIfModifiedSince', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-modified-since', ], 'CopySourceIfNoneMatch' => [ 'shape' => 'CopySourceIfNoneMatch', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-none-match', ], 'CopySourceIfUnmodifiedSince' => [ 'shape' => 'CopySourceIfUnmodifiedSince', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-unmodified-since', ], 'Expires' => [ 'shape' => 'Expires', 'location' => 'header', 'locationName' => 'Expires', ], 'GrantFullControl' => [ 'shape' => 'GrantFullControl', 'location' => 'header', 'locationName' => 'x-amz-grant-full-control', ], 'GrantRead' => [ 'shape' => 'GrantRead', 'location' => 'header', 'locationName' => 'x-amz-grant-read', ], 'GrantReadACP' => [ 'shape' => 'GrantReadACP', 'location' => 'header', 'locationName' => 'x-amz-grant-read-acp', ], 'GrantWriteACP' => [ 'shape' => 'GrantWriteACP', 'location' => 'header', 'locationName' => 'x-amz-grant-write-acp', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'Metadata' => [ 'shape' => 'Metadata', 'location' => 'headers', 'locationName' => 'x-amz-meta-', ], 'MetadataDirective' => [ 'shape' => 'MetadataDirective', 'location' => 'header', 'locationName' => 'x-amz-metadata-directive', ], 'TaggingDirective' => [ 'shape' => 'TaggingDirective', 'location' => 'header', 'locationName' => 'x-amz-tagging-directive', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'StorageClass' => [ 'shape' => 'StorageClass', 'location' => 'header', 'locationName' => 'x-amz-storage-class', ], 'WebsiteRedirectLocation' => [ 'shape' => 'WebsiteRedirectLocation', 'location' => 'header', 'locationName' => 'x-amz-website-redirect-location', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'CopySourceSSECustomerAlgorithm' => [ 'shape' => 'CopySourceSSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-copy-source-server-side-encryption-customer-algorithm', ], 'CopySourceSSECustomerKey' => [ 'shape' => 'CopySourceSSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-copy-source-server-side-encryption-customer-key', ], 'CopySourceSSECustomerKeyMD5' => [ 'shape' => 'CopySourceSSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-copy-source-server-side-encryption-customer-key-MD5', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'Tagging' => [ 'shape' => 'TaggingHeader', 'location' => 'header', 'locationName' => 'x-amz-tagging', ], 'ObjectLockMode' => [ 'shape' => 'ObjectLockMode', 'location' => 'header', 'locationName' => 'x-amz-object-lock-mode', ], 'ObjectLockRetainUntilDate' => [ 'shape' => 'ObjectLockRetainUntilDate', 'location' => 'header', 'locationName' => 'x-amz-object-lock-retain-until-date', ], 'ObjectLockLegalHoldStatus' => [ 'shape' => 'ObjectLockLegalHoldStatus', 'location' => 'header', 'locationName' => 'x-amz-object-lock-legal-hold', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ExpectedSourceBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-source-expected-bucket-owner', ], ], ], 'CopyObjectResult' => [ 'type' => 'structure', 'members' => [ 'ETag' => [ 'shape' => 'ETag', ], 'LastModified' => [ 'shape' => 'LastModified', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], ], ], 'CopyPartResult' => [ 'type' => 'structure', 'members' => [ 'ETag' => [ 'shape' => 'ETag', ], 'LastModified' => [ 'shape' => 'LastModified', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], ], ], 'CopySource' => [ 'type' => 'string', 'pattern' => '\\/.+\\/.+', ], 'CopySourceIfMatch' => [ 'type' => 'string', ], 'CopySourceIfModifiedSince' => [ 'type' => 'timestamp', ], 'CopySourceIfNoneMatch' => [ 'type' => 'string', ], 'CopySourceIfUnmodifiedSince' => [ 'type' => 'timestamp', ], 'CopySourceRange' => [ 'type' => 'string', ], 'CopySourceSSECustomerAlgorithm' => [ 'type' => 'string', ], 'CopySourceSSECustomerKey' => [ 'type' => 'string', 'sensitive' => true, ], 'CopySourceSSECustomerKeyMD5' => [ 'type' => 'string', ], 'CopySourceVersionId' => [ 'type' => 'string', ], 'CreateBucketConfiguration' => [ 'type' => 'structure', 'members' => [ 'LocationConstraint' => [ 'shape' => 'BucketLocationConstraint', ], 'Location' => [ 'shape' => 'LocationInfo', ], 'Bucket' => [ 'shape' => 'BucketInfo', ], ], ], 'CreateBucketOutput' => [ 'type' => 'structure', 'members' => [ 'Location' => [ 'shape' => 'Location', 'location' => 'header', 'locationName' => 'Location', ], ], ], 'CreateBucketRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'ACL' => [ 'shape' => 'BucketCannedACL', 'location' => 'header', 'locationName' => 'x-amz-acl', ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'CreateBucketConfiguration' => [ 'shape' => 'CreateBucketConfiguration', 'locationName' => 'CreateBucketConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'GrantFullControl' => [ 'shape' => 'GrantFullControl', 'location' => 'header', 'locationName' => 'x-amz-grant-full-control', ], 'GrantRead' => [ 'shape' => 'GrantRead', 'location' => 'header', 'locationName' => 'x-amz-grant-read', ], 'GrantReadACP' => [ 'shape' => 'GrantReadACP', 'location' => 'header', 'locationName' => 'x-amz-grant-read-acp', ], 'GrantWrite' => [ 'shape' => 'GrantWrite', 'location' => 'header', 'locationName' => 'x-amz-grant-write', ], 'GrantWriteACP' => [ 'shape' => 'GrantWriteACP', 'location' => 'header', 'locationName' => 'x-amz-grant-write-acp', ], 'ObjectLockEnabledForBucket' => [ 'shape' => 'ObjectLockEnabledForBucket', 'location' => 'header', 'locationName' => 'x-amz-bucket-object-lock-enabled', ], 'ObjectOwnership' => [ 'shape' => 'ObjectOwnership', 'location' => 'header', 'locationName' => 'x-amz-object-ownership', ], ], 'payload' => 'CreateBucketConfiguration', ], 'CreateMultipartUploadOutput' => [ 'type' => 'structure', 'members' => [ 'AbortDate' => [ 'shape' => 'AbortDate', 'location' => 'header', 'locationName' => 'x-amz-abort-date', ], 'AbortRuleId' => [ 'shape' => 'AbortRuleId', 'location' => 'header', 'locationName' => 'x-amz-abort-rule-id', ], 'Bucket' => [ 'shape' => 'BucketName', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', ], 'UploadId' => [ 'shape' => 'MultipartUploadId', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-checksum-algorithm', ], ], ], 'CreateMultipartUploadRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'ACL' => [ 'shape' => 'ObjectCannedACL', 'location' => 'header', 'locationName' => 'x-amz-acl', ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'CacheControl' => [ 'shape' => 'CacheControl', 'location' => 'header', 'locationName' => 'Cache-Control', ], 'ContentDisposition' => [ 'shape' => 'ContentDisposition', 'location' => 'header', 'locationName' => 'Content-Disposition', ], 'ContentEncoding' => [ 'shape' => 'ContentEncoding', 'location' => 'header', 'locationName' => 'Content-Encoding', ], 'ContentLanguage' => [ 'shape' => 'ContentLanguage', 'location' => 'header', 'locationName' => 'Content-Language', ], 'ContentType' => [ 'shape' => 'ContentType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'Expires' => [ 'shape' => 'Expires', 'location' => 'header', 'locationName' => 'Expires', ], 'GrantFullControl' => [ 'shape' => 'GrantFullControl', 'location' => 'header', 'locationName' => 'x-amz-grant-full-control', ], 'GrantRead' => [ 'shape' => 'GrantRead', 'location' => 'header', 'locationName' => 'x-amz-grant-read', ], 'GrantReadACP' => [ 'shape' => 'GrantReadACP', 'location' => 'header', 'locationName' => 'x-amz-grant-read-acp', ], 'GrantWriteACP' => [ 'shape' => 'GrantWriteACP', 'location' => 'header', 'locationName' => 'x-amz-grant-write-acp', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'Metadata' => [ 'shape' => 'Metadata', 'location' => 'headers', 'locationName' => 'x-amz-meta-', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'StorageClass' => [ 'shape' => 'StorageClass', 'location' => 'header', 'locationName' => 'x-amz-storage-class', ], 'WebsiteRedirectLocation' => [ 'shape' => 'WebsiteRedirectLocation', 'location' => 'header', 'locationName' => 'x-amz-website-redirect-location', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'Tagging' => [ 'shape' => 'TaggingHeader', 'location' => 'header', 'locationName' => 'x-amz-tagging', ], 'ObjectLockMode' => [ 'shape' => 'ObjectLockMode', 'location' => 'header', 'locationName' => 'x-amz-object-lock-mode', ], 'ObjectLockRetainUntilDate' => [ 'shape' => 'ObjectLockRetainUntilDate', 'location' => 'header', 'locationName' => 'x-amz-object-lock-retain-until-date', ], 'ObjectLockLegalHoldStatus' => [ 'shape' => 'ObjectLockLegalHoldStatus', 'location' => 'header', 'locationName' => 'x-amz-object-lock-legal-hold', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-checksum-algorithm', ], ], ], 'CreateSessionOutput' => [ 'type' => 'structure', 'required' => [ 'Credentials', ], 'members' => [ 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'Credentials' => [ 'shape' => 'SessionCredentials', 'locationName' => 'Credentials', ], ], ], 'CreateSessionRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'SessionMode' => [ 'shape' => 'SessionMode', 'location' => 'header', 'locationName' => 'x-amz-create-session-mode', ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], ], ], 'CreationDate' => [ 'type' => 'timestamp', ], 'DataRedundancy' => [ 'type' => 'string', 'enum' => [ 'SingleAvailabilityZone', ], ], 'Date' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'Days' => [ 'type' => 'integer', 'box' => true, ], 'DaysAfterInitiation' => [ 'type' => 'integer', 'box' => true, ], 'DefaultRetention' => [ 'type' => 'structure', 'members' => [ 'Mode' => [ 'shape' => 'ObjectLockRetentionMode', ], 'Days' => [ 'shape' => 'Days', ], 'Years' => [ 'shape' => 'Years', ], ], ], 'Delete' => [ 'type' => 'structure', 'required' => [ 'Objects', ], 'members' => [ 'Objects' => [ 'shape' => 'ObjectIdentifierList', 'locationName' => 'Object', ], 'Quiet' => [ 'shape' => 'Quiet', ], ], ], 'DeleteBucketAnalyticsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'AnalyticsId', 'location' => 'querystring', 'locationName' => 'id', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketCorsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketEncryptionRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketIntelligentTieringConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'IntelligentTieringId', 'location' => 'querystring', 'locationName' => 'id', ], ], ], 'DeleteBucketInventoryConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'InventoryId', 'location' => 'querystring', 'locationName' => 'id', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketLifecycleRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketMetricsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'MetricsId', 'location' => 'querystring', 'locationName' => 'id', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketOwnershipControlsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketReplicationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketTaggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketWebsiteRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteMarker' => [ 'type' => 'boolean', ], 'DeleteMarkerEntry' => [ 'type' => 'structure', 'members' => [ 'Owner' => [ 'shape' => 'Owner', ], 'Key' => [ 'shape' => 'ObjectKey', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', ], 'IsLatest' => [ 'shape' => 'IsLatest', ], 'LastModified' => [ 'shape' => 'LastModified', ], ], ], 'DeleteMarkerReplication' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'DeleteMarkerReplicationStatus', ], ], ], 'DeleteMarkerReplicationStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'DeleteMarkerVersionId' => [ 'type' => 'string', ], 'DeleteMarkers' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeleteMarkerEntry', ], 'flattened' => true, ], 'DeleteObjectOutput' => [ 'type' => 'structure', 'members' => [ 'DeleteMarker' => [ 'shape' => 'DeleteMarker', 'location' => 'header', 'locationName' => 'x-amz-delete-marker', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'DeleteObjectRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'MFA' => [ 'shape' => 'MFA', 'location' => 'header', 'locationName' => 'x-amz-mfa', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'BypassGovernanceRetention' => [ 'shape' => 'BypassGovernanceRetention', 'location' => 'header', 'locationName' => 'x-amz-bypass-governance-retention', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'IfMatch' => [ 'shape' => 'IfMatch', 'location' => 'header', 'locationName' => 'If-Match', ], 'IfMatchLastModifiedTime' => [ 'shape' => 'IfMatchLastModifiedTime', 'location' => 'header', 'locationName' => 'x-amz-if-match-last-modified-time', ], 'IfMatchSize' => [ 'shape' => 'IfMatchSize', 'location' => 'header', 'locationName' => 'x-amz-if-match-size', ], ], ], 'DeleteObjectTaggingOutput' => [ 'type' => 'structure', 'members' => [ 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], ], ], 'DeleteObjectTaggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteObjectsOutput' => [ 'type' => 'structure', 'members' => [ 'Deleted' => [ 'shape' => 'DeletedObjects', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'Errors' => [ 'shape' => 'Errors', 'locationName' => 'Error', ], ], ], 'DeleteObjectsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Delete', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Delete' => [ 'shape' => 'Delete', 'locationName' => 'Delete', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'MFA' => [ 'shape' => 'MFA', 'location' => 'header', 'locationName' => 'x-amz-mfa', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'BypassGovernanceRetention' => [ 'shape' => 'BypassGovernanceRetention', 'location' => 'header', 'locationName' => 'x-amz-bypass-governance-retention', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], ], 'payload' => 'Delete', ], 'DeletePublicAccessBlockRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeletedObject' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ObjectKey', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', ], 'DeleteMarker' => [ 'shape' => 'DeleteMarker', ], 'DeleteMarkerVersionId' => [ 'shape' => 'DeleteMarkerVersionId', ], ], ], 'DeletedObjects' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeletedObject', ], 'flattened' => true, ], 'Delimiter' => [ 'type' => 'string', ], 'Description' => [ 'type' => 'string', ], 'Destination' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', ], 'Account' => [ 'shape' => 'AccountId', ], 'StorageClass' => [ 'shape' => 'StorageClass', ], 'AccessControlTranslation' => [ 'shape' => 'AccessControlTranslation', ], 'EncryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], 'ReplicationTime' => [ 'shape' => 'ReplicationTime', ], 'Metrics' => [ 'shape' => 'Metrics', ], ], ], 'DirectoryBucketToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'DisplayName' => [ 'type' => 'string', ], 'ETag' => [ 'type' => 'string', ], 'EmailAddress' => [ 'type' => 'string', ], 'EnableRequestProgress' => [ 'type' => 'boolean', 'box' => true, ], 'EncodingType' => [ 'type' => 'string', 'enum' => [ 'url', ], ], 'Encryption' => [ 'type' => 'structure', 'required' => [ 'EncryptionType', ], 'members' => [ 'EncryptionType' => [ 'shape' => 'ServerSideEncryption', ], 'KMSKeyId' => [ 'shape' => 'SSEKMSKeyId', ], 'KMSContext' => [ 'shape' => 'KMSContext', ], ], ], 'EncryptionConfiguration' => [ 'type' => 'structure', 'members' => [ 'ReplicaKmsKeyID' => [ 'shape' => 'ReplicaKmsKeyID', ], ], ], 'EncryptionTypeMismatch' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'End' => [ 'type' => 'long', 'box' => true, ], 'EndEvent' => [ 'type' => 'structure', 'members' => [], 'event' => true, ], 'Error' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ObjectKey', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', ], 'Code' => [ 'shape' => 'Code', ], 'Message' => [ 'shape' => 'Message', ], ], ], 'ErrorCode' => [ 'type' => 'string', ], 'ErrorDocument' => [ 'type' => 'structure', 'required' => [ 'Key', ], 'members' => [ 'Key' => [ 'shape' => 'ObjectKey', ], ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'Errors' => [ 'type' => 'list', 'member' => [ 'shape' => 'Error', ], 'flattened' => true, ], 'Event' => [ 'type' => 'string', 'enum' => [ 's3:ReducedRedundancyLostObject', 's3:ObjectCreated:*', 's3:ObjectCreated:Put', 's3:ObjectCreated:Post', 's3:ObjectCreated:Copy', 's3:ObjectCreated:CompleteMultipartUpload', 's3:ObjectRemoved:*', 's3:ObjectRemoved:Delete', 's3:ObjectRemoved:DeleteMarkerCreated', 's3:ObjectRestore:*', 's3:ObjectRestore:Post', 's3:ObjectRestore:Completed', 's3:Replication:*', 's3:Replication:OperationFailedReplication', 's3:Replication:OperationNotTracked', 's3:Replication:OperationMissedThreshold', 's3:Replication:OperationReplicatedAfterThreshold', 's3:ObjectRestore:Delete', 's3:LifecycleTransition', 's3:IntelligentTiering', 's3:ObjectAcl:Put', 's3:LifecycleExpiration:*', 's3:LifecycleExpiration:Delete', 's3:LifecycleExpiration:DeleteMarkerCreated', 's3:ObjectTagging:*', 's3:ObjectTagging:Put', 's3:ObjectTagging:Delete', ], ], 'EventBridgeConfiguration' => [ 'type' => 'structure', 'members' => [], ], 'EventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Event', ], 'flattened' => true, ], 'ExistingObjectReplication' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'ExistingObjectReplicationStatus', ], ], ], 'ExistingObjectReplicationStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Expiration' => [ 'type' => 'string', ], 'ExpirationStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ExpiredObjectDeleteMarker' => [ 'type' => 'boolean', 'box' => true, ], 'Expires' => [ 'type' => 'timestamp', ], 'ExposeHeader' => [ 'type' => 'string', ], 'ExposeHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExposeHeader', ], 'flattened' => true, ], 'Expression' => [ 'type' => 'string', ], 'ExpressionType' => [ 'type' => 'string', 'enum' => [ 'SQL', ], ], 'FetchOwner' => [ 'type' => 'boolean', 'box' => true, ], 'FieldDelimiter' => [ 'type' => 'string', ], 'FileHeaderInfo' => [ 'type' => 'string', 'enum' => [ 'USE', 'IGNORE', 'NONE', ], ], 'FilterRule' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'FilterRuleName', ], 'Value' => [ 'shape' => 'FilterRuleValue', ], ], ], 'FilterRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterRule', ], 'flattened' => true, ], 'FilterRuleName' => [ 'type' => 'string', 'enum' => [ 'prefix', 'suffix', ], ], 'FilterRuleValue' => [ 'type' => 'string', ], 'GetBucketAccelerateConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'BucketAccelerateStatus', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'GetBucketAccelerateConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], ], ], 'GetBucketAclOutput' => [ 'type' => 'structure', 'members' => [ 'Owner' => [ 'shape' => 'Owner', ], 'Grants' => [ 'shape' => 'Grants', 'locationName' => 'AccessControlList', ], ], ], 'GetBucketAclRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketAnalyticsConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'AnalyticsConfiguration' => [ 'shape' => 'AnalyticsConfiguration', ], ], 'payload' => 'AnalyticsConfiguration', ], 'GetBucketAnalyticsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'AnalyticsId', 'location' => 'querystring', 'locationName' => 'id', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketCorsOutput' => [ 'type' => 'structure', 'members' => [ 'CORSRules' => [ 'shape' => 'CORSRules', 'locationName' => 'CORSRule', ], ], ], 'GetBucketCorsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketEncryptionOutput' => [ 'type' => 'structure', 'members' => [ 'ServerSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', ], ], 'payload' => 'ServerSideEncryptionConfiguration', ], 'GetBucketEncryptionRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketIntelligentTieringConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'IntelligentTieringConfiguration' => [ 'shape' => 'IntelligentTieringConfiguration', ], ], 'payload' => 'IntelligentTieringConfiguration', ], 'GetBucketIntelligentTieringConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'IntelligentTieringId', 'location' => 'querystring', 'locationName' => 'id', ], ], ], 'GetBucketInventoryConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'InventoryConfiguration' => [ 'shape' => 'InventoryConfiguration', ], ], 'payload' => 'InventoryConfiguration', ], 'GetBucketInventoryConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'InventoryId', 'location' => 'querystring', 'locationName' => 'id', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketLifecycleConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'Rules' => [ 'shape' => 'LifecycleRules', 'locationName' => 'Rule', ], 'TransitionDefaultMinimumObjectSize' => [ 'shape' => 'TransitionDefaultMinimumObjectSize', 'location' => 'header', 'locationName' => 'x-amz-transition-default-minimum-object-size', ], ], ], 'GetBucketLifecycleConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketLifecycleOutput' => [ 'type' => 'structure', 'members' => [ 'Rules' => [ 'shape' => 'Rules', 'locationName' => 'Rule', ], ], ], 'GetBucketLifecycleRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketLocationOutput' => [ 'type' => 'structure', 'members' => [ 'LocationConstraint' => [ 'shape' => 'BucketLocationConstraint', ], ], ], 'GetBucketLocationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketLoggingOutput' => [ 'type' => 'structure', 'members' => [ 'LoggingEnabled' => [ 'shape' => 'LoggingEnabled', ], ], ], 'GetBucketLoggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketMetricsConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'MetricsConfiguration' => [ 'shape' => 'MetricsConfiguration', ], ], 'payload' => 'MetricsConfiguration', ], 'GetBucketMetricsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'MetricsId', 'location' => 'querystring', 'locationName' => 'id', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketNotificationConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketOwnershipControlsOutput' => [ 'type' => 'structure', 'members' => [ 'OwnershipControls' => [ 'shape' => 'OwnershipControls', ], ], 'payload' => 'OwnershipControls', ], 'GetBucketOwnershipControlsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketPolicyOutput' => [ 'type' => 'structure', 'members' => [ 'Policy' => [ 'shape' => 'Policy', ], ], 'payload' => 'Policy', ], 'GetBucketPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketPolicyStatusOutput' => [ 'type' => 'structure', 'members' => [ 'PolicyStatus' => [ 'shape' => 'PolicyStatus', ], ], 'payload' => 'PolicyStatus', ], 'GetBucketPolicyStatusRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketReplicationOutput' => [ 'type' => 'structure', 'members' => [ 'ReplicationConfiguration' => [ 'shape' => 'ReplicationConfiguration', ], ], 'payload' => 'ReplicationConfiguration', ], 'GetBucketReplicationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketRequestPaymentOutput' => [ 'type' => 'structure', 'members' => [ 'Payer' => [ 'shape' => 'Payer', ], ], ], 'GetBucketRequestPaymentRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketTaggingOutput' => [ 'type' => 'structure', 'required' => [ 'TagSet', ], 'members' => [ 'TagSet' => [ 'shape' => 'TagSet', ], ], ], 'GetBucketTaggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketVersioningOutput' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'BucketVersioningStatus', ], 'MFADelete' => [ 'shape' => 'MFADeleteStatus', 'locationName' => 'MfaDelete', ], ], ], 'GetBucketVersioningRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketWebsiteOutput' => [ 'type' => 'structure', 'members' => [ 'RedirectAllRequestsTo' => [ 'shape' => 'RedirectAllRequestsTo', ], 'IndexDocument' => [ 'shape' => 'IndexDocument', ], 'ErrorDocument' => [ 'shape' => 'ErrorDocument', ], 'RoutingRules' => [ 'shape' => 'RoutingRules', ], ], ], 'GetBucketWebsiteRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetObjectAclOutput' => [ 'type' => 'structure', 'members' => [ 'Owner' => [ 'shape' => 'Owner', ], 'Grants' => [ 'shape' => 'Grants', 'locationName' => 'AccessControlList', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'GetObjectAclRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetObjectAttributesOutput' => [ 'type' => 'structure', 'members' => [ 'DeleteMarker' => [ 'shape' => 'DeleteMarker', 'location' => 'header', 'locationName' => 'x-amz-delete-marker', ], 'LastModified' => [ 'shape' => 'LastModified', 'location' => 'header', 'locationName' => 'Last-Modified', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'ETag' => [ 'shape' => 'ETag', ], 'Checksum' => [ 'shape' => 'Checksum', ], 'ObjectParts' => [ 'shape' => 'GetObjectAttributesParts', ], 'StorageClass' => [ 'shape' => 'StorageClass', ], 'ObjectSize' => [ 'shape' => 'ObjectSize', ], ], ], 'GetObjectAttributesParts' => [ 'type' => 'structure', 'members' => [ 'TotalPartsCount' => [ 'shape' => 'PartsCount', 'locationName' => 'PartsCount', ], 'PartNumberMarker' => [ 'shape' => 'PartNumberMarker', ], 'NextPartNumberMarker' => [ 'shape' => 'NextPartNumberMarker', ], 'MaxParts' => [ 'shape' => 'MaxParts', ], 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'Parts' => [ 'shape' => 'PartsList', 'locationName' => 'Part', ], ], ], 'GetObjectAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'ObjectAttributes', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'MaxParts' => [ 'shape' => 'MaxParts', 'location' => 'header', 'locationName' => 'x-amz-max-parts', ], 'PartNumberMarker' => [ 'shape' => 'PartNumberMarker', 'location' => 'header', 'locationName' => 'x-amz-part-number-marker', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ObjectAttributes' => [ 'shape' => 'ObjectAttributesList', 'location' => 'header', 'locationName' => 'x-amz-object-attributes', ], ], ], 'GetObjectLegalHoldOutput' => [ 'type' => 'structure', 'members' => [ 'LegalHold' => [ 'shape' => 'ObjectLockLegalHold', 'locationName' => 'LegalHold', ], ], 'payload' => 'LegalHold', ], 'GetObjectLegalHoldRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetObjectLockConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'ObjectLockConfiguration' => [ 'shape' => 'ObjectLockConfiguration', ], ], 'payload' => 'ObjectLockConfiguration', ], 'GetObjectLockConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetObjectOutput' => [ 'type' => 'structure', 'members' => [ 'Body' => [ 'shape' => 'Body', 'streaming' => true, ], 'DeleteMarker' => [ 'shape' => 'DeleteMarker', 'location' => 'header', 'locationName' => 'x-amz-delete-marker', ], 'AcceptRanges' => [ 'shape' => 'AcceptRanges', 'location' => 'header', 'locationName' => 'accept-ranges', ], 'Expiration' => [ 'shape' => 'Expiration', 'location' => 'header', 'locationName' => 'x-amz-expiration', ], 'Restore' => [ 'shape' => 'Restore', 'location' => 'header', 'locationName' => 'x-amz-restore', ], 'LastModified' => [ 'shape' => 'LastModified', 'location' => 'header', 'locationName' => 'Last-Modified', ], 'ContentLength' => [ 'shape' => 'ContentLength', 'location' => 'header', 'locationName' => 'Content-Length', ], 'ETag' => [ 'shape' => 'ETag', 'location' => 'header', 'locationName' => 'ETag', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'MissingMeta' => [ 'shape' => 'MissingMeta', 'location' => 'header', 'locationName' => 'x-amz-missing-meta', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'CacheControl' => [ 'shape' => 'CacheControl', 'location' => 'header', 'locationName' => 'Cache-Control', ], 'ContentDisposition' => [ 'shape' => 'ContentDisposition', 'location' => 'header', 'locationName' => 'Content-Disposition', ], 'ContentEncoding' => [ 'shape' => 'ContentEncoding', 'location' => 'header', 'locationName' => 'Content-Encoding', ], 'ContentLanguage' => [ 'shape' => 'ContentLanguage', 'location' => 'header', 'locationName' => 'Content-Language', ], 'ContentRange' => [ 'shape' => 'ContentRange', 'location' => 'header', 'locationName' => 'Content-Range', ], 'ContentType' => [ 'shape' => 'ContentType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'Expires' => [ 'shape' => 'Expires', 'location' => 'header', 'locationName' => 'Expires', ], 'WebsiteRedirectLocation' => [ 'shape' => 'WebsiteRedirectLocation', 'location' => 'header', 'locationName' => 'x-amz-website-redirect-location', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'Metadata' => [ 'shape' => 'Metadata', 'location' => 'headers', 'locationName' => 'x-amz-meta-', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'StorageClass' => [ 'shape' => 'StorageClass', 'location' => 'header', 'locationName' => 'x-amz-storage-class', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'ReplicationStatus' => [ 'shape' => 'ReplicationStatus', 'location' => 'header', 'locationName' => 'x-amz-replication-status', ], 'PartsCount' => [ 'shape' => 'PartsCount', 'location' => 'header', 'locationName' => 'x-amz-mp-parts-count', ], 'TagCount' => [ 'shape' => 'TagCount', 'location' => 'header', 'locationName' => 'x-amz-tagging-count', ], 'ObjectLockMode' => [ 'shape' => 'ObjectLockMode', 'location' => 'header', 'locationName' => 'x-amz-object-lock-mode', ], 'ObjectLockRetainUntilDate' => [ 'shape' => 'ObjectLockRetainUntilDate', 'location' => 'header', 'locationName' => 'x-amz-object-lock-retain-until-date', ], 'ObjectLockLegalHoldStatus' => [ 'shape' => 'ObjectLockLegalHoldStatus', 'location' => 'header', 'locationName' => 'x-amz-object-lock-legal-hold', ], ], 'payload' => 'Body', ], 'GetObjectRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'IfMatch' => [ 'shape' => 'IfMatch', 'location' => 'header', 'locationName' => 'If-Match', ], 'IfModifiedSince' => [ 'shape' => 'IfModifiedSince', 'location' => 'header', 'locationName' => 'If-Modified-Since', ], 'IfNoneMatch' => [ 'shape' => 'IfNoneMatch', 'location' => 'header', 'locationName' => 'If-None-Match', ], 'IfUnmodifiedSince' => [ 'shape' => 'IfUnmodifiedSince', 'location' => 'header', 'locationName' => 'If-Unmodified-Since', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'Range' => [ 'shape' => 'Range', 'location' => 'header', 'locationName' => 'Range', ], 'ResponseCacheControl' => [ 'shape' => 'ResponseCacheControl', 'location' => 'querystring', 'locationName' => 'response-cache-control', ], 'ResponseContentDisposition' => [ 'shape' => 'ResponseContentDisposition', 'location' => 'querystring', 'locationName' => 'response-content-disposition', ], 'ResponseContentEncoding' => [ 'shape' => 'ResponseContentEncoding', 'location' => 'querystring', 'locationName' => 'response-content-encoding', ], 'ResponseContentLanguage' => [ 'shape' => 'ResponseContentLanguage', 'location' => 'querystring', 'locationName' => 'response-content-language', ], 'ResponseContentType' => [ 'shape' => 'ResponseContentType', 'location' => 'querystring', 'locationName' => 'response-content-type', ], 'ResponseExpires' => [ 'shape' => 'ResponseExpires', 'location' => 'querystring', 'locationName' => 'response-expires', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'PartNumber' => [ 'shape' => 'PartNumber', 'location' => 'querystring', 'locationName' => 'partNumber', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ChecksumMode' => [ 'shape' => 'ChecksumMode', 'location' => 'header', 'locationName' => 'x-amz-checksum-mode', ], ], ], 'GetObjectResponseStatusCode' => [ 'type' => 'integer', 'box' => true, ], 'GetObjectRetentionOutput' => [ 'type' => 'structure', 'members' => [ 'Retention' => [ 'shape' => 'ObjectLockRetention', 'locationName' => 'Retention', ], ], 'payload' => 'Retention', ], 'GetObjectRetentionRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetObjectTaggingOutput' => [ 'type' => 'structure', 'required' => [ 'TagSet', ], 'members' => [ 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'TagSet' => [ 'shape' => 'TagSet', ], ], ], 'GetObjectTaggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], ], ], 'GetObjectTorrentOutput' => [ 'type' => 'structure', 'members' => [ 'Body' => [ 'shape' => 'Body', 'streaming' => true, ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], 'payload' => 'Body', ], 'GetObjectTorrentRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetPublicAccessBlockOutput' => [ 'type' => 'structure', 'members' => [ 'PublicAccessBlockConfiguration' => [ 'shape' => 'PublicAccessBlockConfiguration', ], ], 'payload' => 'PublicAccessBlockConfiguration', ], 'GetPublicAccessBlockRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GlacierJobParameters' => [ 'type' => 'structure', 'required' => [ 'Tier', ], 'members' => [ 'Tier' => [ 'shape' => 'Tier', ], ], ], 'Grant' => [ 'type' => 'structure', 'members' => [ 'Grantee' => [ 'shape' => 'Grantee', ], 'Permission' => [ 'shape' => 'Permission', ], ], ], 'GrantFullControl' => [ 'type' => 'string', ], 'GrantRead' => [ 'type' => 'string', ], 'GrantReadACP' => [ 'type' => 'string', ], 'GrantWrite' => [ 'type' => 'string', ], 'GrantWriteACP' => [ 'type' => 'string', ], 'Grantee' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'DisplayName' => [ 'shape' => 'DisplayName', ], 'EmailAddress' => [ 'shape' => 'EmailAddress', ], 'ID' => [ 'shape' => 'ID', ], 'Type' => [ 'shape' => 'Type', 'locationName' => 'xsi:type', 'xmlAttribute' => true, ], 'URI' => [ 'shape' => 'URI', ], ], 'xmlNamespace' => [ 'prefix' => 'xsi', 'uri' => 'http://www.w3.org/2001/XMLSchema-instance', ], ], 'Grants' => [ 'type' => 'list', 'member' => [ 'shape' => 'Grant', 'locationName' => 'Grant', ], ], 'HeadBucketOutput' => [ 'type' => 'structure', 'members' => [ 'BucketLocationType' => [ 'shape' => 'LocationType', 'location' => 'header', 'locationName' => 'x-amz-bucket-location-type', ], 'BucketLocationName' => [ 'shape' => 'BucketLocationName', 'location' => 'header', 'locationName' => 'x-amz-bucket-location-name', ], 'BucketRegion' => [ 'shape' => 'Region', 'location' => 'header', 'locationName' => 'x-amz-bucket-region', ], 'AccessPointAlias' => [ 'shape' => 'AccessPointAlias', 'location' => 'header', 'locationName' => 'x-amz-access-point-alias', ], ], ], 'HeadBucketRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'HeadObjectOutput' => [ 'type' => 'structure', 'members' => [ 'DeleteMarker' => [ 'shape' => 'DeleteMarker', 'location' => 'header', 'locationName' => 'x-amz-delete-marker', ], 'AcceptRanges' => [ 'shape' => 'AcceptRanges', 'location' => 'header', 'locationName' => 'accept-ranges', ], 'Expiration' => [ 'shape' => 'Expiration', 'location' => 'header', 'locationName' => 'x-amz-expiration', ], 'Restore' => [ 'shape' => 'Restore', 'location' => 'header', 'locationName' => 'x-amz-restore', ], 'ArchiveStatus' => [ 'shape' => 'ArchiveStatus', 'location' => 'header', 'locationName' => 'x-amz-archive-status', ], 'LastModified' => [ 'shape' => 'LastModified', 'location' => 'header', 'locationName' => 'Last-Modified', ], 'ContentLength' => [ 'shape' => 'ContentLength', 'location' => 'header', 'locationName' => 'Content-Length', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'ETag' => [ 'shape' => 'ETag', 'location' => 'header', 'locationName' => 'ETag', ], 'MissingMeta' => [ 'shape' => 'MissingMeta', 'location' => 'header', 'locationName' => 'x-amz-missing-meta', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'CacheControl' => [ 'shape' => 'CacheControl', 'location' => 'header', 'locationName' => 'Cache-Control', ], 'ContentDisposition' => [ 'shape' => 'ContentDisposition', 'location' => 'header', 'locationName' => 'Content-Disposition', ], 'ContentEncoding' => [ 'shape' => 'ContentEncoding', 'location' => 'header', 'locationName' => 'Content-Encoding', ], 'ContentLanguage' => [ 'shape' => 'ContentLanguage', 'location' => 'header', 'locationName' => 'Content-Language', ], 'ContentType' => [ 'shape' => 'ContentType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'Expires' => [ 'shape' => 'Expires', 'location' => 'header', 'locationName' => 'Expires', ], 'WebsiteRedirectLocation' => [ 'shape' => 'WebsiteRedirectLocation', 'location' => 'header', 'locationName' => 'x-amz-website-redirect-location', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'Metadata' => [ 'shape' => 'Metadata', 'location' => 'headers', 'locationName' => 'x-amz-meta-', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'StorageClass' => [ 'shape' => 'StorageClass', 'location' => 'header', 'locationName' => 'x-amz-storage-class', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'ReplicationStatus' => [ 'shape' => 'ReplicationStatus', 'location' => 'header', 'locationName' => 'x-amz-replication-status', ], 'PartsCount' => [ 'shape' => 'PartsCount', 'location' => 'header', 'locationName' => 'x-amz-mp-parts-count', ], 'ObjectLockMode' => [ 'shape' => 'ObjectLockMode', 'location' => 'header', 'locationName' => 'x-amz-object-lock-mode', ], 'ObjectLockRetainUntilDate' => [ 'shape' => 'ObjectLockRetainUntilDate', 'location' => 'header', 'locationName' => 'x-amz-object-lock-retain-until-date', ], 'ObjectLockLegalHoldStatus' => [ 'shape' => 'ObjectLockLegalHoldStatus', 'location' => 'header', 'locationName' => 'x-amz-object-lock-legal-hold', ], ], ], 'HeadObjectRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'IfMatch' => [ 'shape' => 'IfMatch', 'location' => 'header', 'locationName' => 'If-Match', ], 'IfModifiedSince' => [ 'shape' => 'IfModifiedSince', 'location' => 'header', 'locationName' => 'If-Modified-Since', ], 'IfNoneMatch' => [ 'shape' => 'IfNoneMatch', 'location' => 'header', 'locationName' => 'If-None-Match', ], 'IfUnmodifiedSince' => [ 'shape' => 'IfUnmodifiedSince', 'location' => 'header', 'locationName' => 'If-Unmodified-Since', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'Range' => [ 'shape' => 'Range', 'location' => 'header', 'locationName' => 'Range', ], 'ResponseCacheControl' => [ 'shape' => 'ResponseCacheControl', 'location' => 'querystring', 'locationName' => 'response-cache-control', ], 'ResponseContentDisposition' => [ 'shape' => 'ResponseContentDisposition', 'location' => 'querystring', 'locationName' => 'response-content-disposition', ], 'ResponseContentEncoding' => [ 'shape' => 'ResponseContentEncoding', 'location' => 'querystring', 'locationName' => 'response-content-encoding', ], 'ResponseContentLanguage' => [ 'shape' => 'ResponseContentLanguage', 'location' => 'querystring', 'locationName' => 'response-content-language', ], 'ResponseContentType' => [ 'shape' => 'ResponseContentType', 'location' => 'querystring', 'locationName' => 'response-content-type', ], 'ResponseExpires' => [ 'shape' => 'ResponseExpires', 'location' => 'querystring', 'locationName' => 'response-expires', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'PartNumber' => [ 'shape' => 'PartNumber', 'location' => 'querystring', 'locationName' => 'partNumber', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ChecksumMode' => [ 'shape' => 'ChecksumMode', 'location' => 'header', 'locationName' => 'x-amz-checksum-mode', ], ], ], 'HostName' => [ 'type' => 'string', ], 'HttpErrorCodeReturnedEquals' => [ 'type' => 'string', ], 'HttpRedirectCode' => [ 'type' => 'string', ], 'ID' => [ 'type' => 'string', ], 'IfMatch' => [ 'type' => 'string', ], 'IfMatchInitiatedTime' => [ 'type' => 'timestamp', 'timestampFormat' => 'rfc822', ], 'IfMatchLastModifiedTime' => [ 'type' => 'timestamp', 'timestampFormat' => 'rfc822', ], 'IfMatchSize' => [ 'type' => 'long', 'box' => true, ], 'IfModifiedSince' => [ 'type' => 'timestamp', ], 'IfNoneMatch' => [ 'type' => 'string', ], 'IfUnmodifiedSince' => [ 'type' => 'timestamp', ], 'IndexDocument' => [ 'type' => 'structure', 'required' => [ 'Suffix', ], 'members' => [ 'Suffix' => [ 'shape' => 'Suffix', ], ], ], 'Initiated' => [ 'type' => 'timestamp', ], 'Initiator' => [ 'type' => 'structure', 'members' => [ 'ID' => [ 'shape' => 'ID', ], 'DisplayName' => [ 'shape' => 'DisplayName', ], ], ], 'InputSerialization' => [ 'type' => 'structure', 'members' => [ 'CSV' => [ 'shape' => 'CSVInput', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'JSON' => [ 'shape' => 'JSONInput', ], 'Parquet' => [ 'shape' => 'ParquetInput', ], ], ], 'IntelligentTieringAccessTier' => [ 'type' => 'string', 'enum' => [ 'ARCHIVE_ACCESS', 'DEEP_ARCHIVE_ACCESS', ], ], 'IntelligentTieringAndOperator' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tags' => [ 'shape' => 'TagSet', 'flattened' => true, 'locationName' => 'Tag', ], ], ], 'IntelligentTieringConfiguration' => [ 'type' => 'structure', 'required' => [ 'Id', 'Status', 'Tierings', ], 'members' => [ 'Id' => [ 'shape' => 'IntelligentTieringId', ], 'Filter' => [ 'shape' => 'IntelligentTieringFilter', ], 'Status' => [ 'shape' => 'IntelligentTieringStatus', ], 'Tierings' => [ 'shape' => 'TieringList', 'locationName' => 'Tiering', ], ], ], 'IntelligentTieringConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntelligentTieringConfiguration', ], 'flattened' => true, ], 'IntelligentTieringDays' => [ 'type' => 'integer', 'box' => true, ], 'IntelligentTieringFilter' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tag' => [ 'shape' => 'Tag', ], 'And' => [ 'shape' => 'IntelligentTieringAndOperator', ], ], ], 'IntelligentTieringId' => [ 'type' => 'string', ], 'IntelligentTieringStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'InvalidObjectState' => [ 'type' => 'structure', 'members' => [ 'StorageClass' => [ 'shape' => 'StorageClass', ], 'AccessTier' => [ 'shape' => 'IntelligentTieringAccessTier', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'InvalidRequest' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidWriteOffset' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InventoryConfiguration' => [ 'type' => 'structure', 'required' => [ 'Destination', 'IsEnabled', 'Id', 'IncludedObjectVersions', 'Schedule', ], 'members' => [ 'Destination' => [ 'shape' => 'InventoryDestination', ], 'IsEnabled' => [ 'shape' => 'IsEnabled', ], 'Filter' => [ 'shape' => 'InventoryFilter', ], 'Id' => [ 'shape' => 'InventoryId', ], 'IncludedObjectVersions' => [ 'shape' => 'InventoryIncludedObjectVersions', ], 'OptionalFields' => [ 'shape' => 'InventoryOptionalFields', ], 'Schedule' => [ 'shape' => 'InventorySchedule', ], ], ], 'InventoryConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InventoryConfiguration', ], 'flattened' => true, ], 'InventoryDestination' => [ 'type' => 'structure', 'required' => [ 'S3BucketDestination', ], 'members' => [ 'S3BucketDestination' => [ 'shape' => 'InventoryS3BucketDestination', ], ], ], 'InventoryEncryption' => [ 'type' => 'structure', 'members' => [ 'SSES3' => [ 'shape' => 'SSES3', 'locationName' => 'SSE-S3', ], 'SSEKMS' => [ 'shape' => 'SSEKMS', 'locationName' => 'SSE-KMS', ], ], ], 'InventoryFilter' => [ 'type' => 'structure', 'required' => [ 'Prefix', ], 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], ], ], 'InventoryFormat' => [ 'type' => 'string', 'enum' => [ 'CSV', 'ORC', 'Parquet', ], ], 'InventoryFrequency' => [ 'type' => 'string', 'enum' => [ 'Daily', 'Weekly', ], ], 'InventoryId' => [ 'type' => 'string', ], 'InventoryIncludedObjectVersions' => [ 'type' => 'string', 'enum' => [ 'All', 'Current', ], ], 'InventoryOptionalField' => [ 'type' => 'string', 'enum' => [ 'Size', 'LastModifiedDate', 'StorageClass', 'ETag', 'IsMultipartUploaded', 'ReplicationStatus', 'EncryptionStatus', 'ObjectLockRetainUntilDate', 'ObjectLockMode', 'ObjectLockLegalHoldStatus', 'IntelligentTieringAccessTier', 'BucketKeyStatus', 'ChecksumAlgorithm', 'ObjectAccessControlList', 'ObjectOwner', ], ], 'InventoryOptionalFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'InventoryOptionalField', 'locationName' => 'Field', ], ], 'InventoryS3BucketDestination' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Format', ], 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'Bucket' => [ 'shape' => 'BucketName', ], 'Format' => [ 'shape' => 'InventoryFormat', ], 'Prefix' => [ 'shape' => 'Prefix', ], 'Encryption' => [ 'shape' => 'InventoryEncryption', ], ], ], 'InventorySchedule' => [ 'type' => 'structure', 'required' => [ 'Frequency', ], 'members' => [ 'Frequency' => [ 'shape' => 'InventoryFrequency', ], ], ], 'IsEnabled' => [ 'type' => 'boolean', 'box' => true, ], 'IsLatest' => [ 'type' => 'boolean', 'box' => true, ], 'IsPublic' => [ 'type' => 'boolean', 'box' => true, ], 'IsRestoreInProgress' => [ 'type' => 'boolean', 'box' => true, ], 'IsTruncated' => [ 'type' => 'boolean', 'box' => true, ], 'JSONInput' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'JSONType', ], ], ], 'JSONOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDelimiter' => [ 'shape' => 'RecordDelimiter', ], ], ], 'JSONType' => [ 'type' => 'string', 'enum' => [ 'DOCUMENT', 'LINES', ], ], 'KMSContext' => [ 'type' => 'string', ], 'KeyCount' => [ 'type' => 'integer', ], 'KeyMarker' => [ 'type' => 'string', ], 'KeyPrefixEquals' => [ 'type' => 'string', ], 'LambdaFunctionArn' => [ 'type' => 'string', ], 'LambdaFunctionConfiguration' => [ 'type' => 'structure', 'required' => [ 'LambdaFunctionArn', 'Events', ], 'members' => [ 'Id' => [ 'shape' => 'NotificationId', ], 'LambdaFunctionArn' => [ 'shape' => 'LambdaFunctionArn', 'locationName' => 'CloudFunction', ], 'Events' => [ 'shape' => 'EventList', 'locationName' => 'Event', ], 'Filter' => [ 'shape' => 'NotificationConfigurationFilter', ], ], ], 'LambdaFunctionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LambdaFunctionConfiguration', ], 'flattened' => true, ], 'LastModified' => [ 'type' => 'timestamp', ], 'LastModifiedTime' => [ 'type' => 'timestamp', 'timestampFormat' => 'rfc822', ], 'LifecycleConfiguration' => [ 'type' => 'structure', 'required' => [ 'Rules', ], 'members' => [ 'Rules' => [ 'shape' => 'Rules', 'locationName' => 'Rule', ], ], ], 'LifecycleExpiration' => [ 'type' => 'structure', 'members' => [ 'Date' => [ 'shape' => 'Date', ], 'Days' => [ 'shape' => 'Days', ], 'ExpiredObjectDeleteMarker' => [ 'shape' => 'ExpiredObjectDeleteMarker', ], ], ], 'LifecycleRule' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Expiration' => [ 'shape' => 'LifecycleExpiration', ], 'ID' => [ 'shape' => 'ID', ], 'Prefix' => [ 'shape' => 'Prefix', 'deprecated' => true, ], 'Filter' => [ 'shape' => 'LifecycleRuleFilter', ], 'Status' => [ 'shape' => 'ExpirationStatus', ], 'Transitions' => [ 'shape' => 'TransitionList', 'locationName' => 'Transition', ], 'NoncurrentVersionTransitions' => [ 'shape' => 'NoncurrentVersionTransitionList', 'locationName' => 'NoncurrentVersionTransition', ], 'NoncurrentVersionExpiration' => [ 'shape' => 'NoncurrentVersionExpiration', ], 'AbortIncompleteMultipartUpload' => [ 'shape' => 'AbortIncompleteMultipartUpload', ], ], ], 'LifecycleRuleAndOperator' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tags' => [ 'shape' => 'TagSet', 'flattened' => true, 'locationName' => 'Tag', ], 'ObjectSizeGreaterThan' => [ 'shape' => 'ObjectSizeGreaterThanBytes', ], 'ObjectSizeLessThan' => [ 'shape' => 'ObjectSizeLessThanBytes', ], ], ], 'LifecycleRuleFilter' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tag' => [ 'shape' => 'Tag', ], 'ObjectSizeGreaterThan' => [ 'shape' => 'ObjectSizeGreaterThanBytes', ], 'ObjectSizeLessThan' => [ 'shape' => 'ObjectSizeLessThanBytes', ], 'And' => [ 'shape' => 'LifecycleRuleAndOperator', ], ], ], 'LifecycleRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'LifecycleRule', ], 'flattened' => true, ], 'ListBucketAnalyticsConfigurationsOutput' => [ 'type' => 'structure', 'members' => [ 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'ContinuationToken' => [ 'shape' => 'Token', ], 'NextContinuationToken' => [ 'shape' => 'NextToken', ], 'AnalyticsConfigurationList' => [ 'shape' => 'AnalyticsConfigurationList', 'locationName' => 'AnalyticsConfiguration', ], ], ], 'ListBucketAnalyticsConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContinuationToken' => [ 'shape' => 'Token', 'location' => 'querystring', 'locationName' => 'continuation-token', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'ListBucketIntelligentTieringConfigurationsOutput' => [ 'type' => 'structure', 'members' => [ 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'ContinuationToken' => [ 'shape' => 'Token', ], 'NextContinuationToken' => [ 'shape' => 'NextToken', ], 'IntelligentTieringConfigurationList' => [ 'shape' => 'IntelligentTieringConfigurationList', 'locationName' => 'IntelligentTieringConfiguration', ], ], ], 'ListBucketIntelligentTieringConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContinuationToken' => [ 'shape' => 'Token', 'location' => 'querystring', 'locationName' => 'continuation-token', ], ], ], 'ListBucketInventoryConfigurationsOutput' => [ 'type' => 'structure', 'members' => [ 'ContinuationToken' => [ 'shape' => 'Token', ], 'InventoryConfigurationList' => [ 'shape' => 'InventoryConfigurationList', 'locationName' => 'InventoryConfiguration', ], 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'NextContinuationToken' => [ 'shape' => 'NextToken', ], ], ], 'ListBucketInventoryConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContinuationToken' => [ 'shape' => 'Token', 'location' => 'querystring', 'locationName' => 'continuation-token', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'ListBucketMetricsConfigurationsOutput' => [ 'type' => 'structure', 'members' => [ 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'ContinuationToken' => [ 'shape' => 'Token', ], 'NextContinuationToken' => [ 'shape' => 'NextToken', ], 'MetricsConfigurationList' => [ 'shape' => 'MetricsConfigurationList', 'locationName' => 'MetricsConfiguration', ], ], ], 'ListBucketMetricsConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContinuationToken' => [ 'shape' => 'Token', 'location' => 'querystring', 'locationName' => 'continuation-token', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'ListBucketsOutput' => [ 'type' => 'structure', 'members' => [ 'Buckets' => [ 'shape' => 'Buckets', ], 'Owner' => [ 'shape' => 'Owner', ], 'ContinuationToken' => [ 'shape' => 'NextToken', ], 'Prefix' => [ 'shape' => 'Prefix', ], ], ], 'ListBucketsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxBuckets' => [ 'shape' => 'MaxBuckets', 'location' => 'querystring', 'locationName' => 'max-buckets', ], 'ContinuationToken' => [ 'shape' => 'Token', 'location' => 'querystring', 'locationName' => 'continuation-token', ], 'Prefix' => [ 'shape' => 'Prefix', 'location' => 'querystring', 'locationName' => 'prefix', ], 'BucketRegion' => [ 'shape' => 'BucketRegion', 'location' => 'querystring', 'locationName' => 'bucket-region', ], ], ], 'ListDirectoryBucketsOutput' => [ 'type' => 'structure', 'members' => [ 'Buckets' => [ 'shape' => 'Buckets', ], 'ContinuationToken' => [ 'shape' => 'DirectoryBucketToken', ], ], ], 'ListDirectoryBucketsRequest' => [ 'type' => 'structure', 'members' => [ 'ContinuationToken' => [ 'shape' => 'DirectoryBucketToken', 'location' => 'querystring', 'locationName' => 'continuation-token', ], 'MaxDirectoryBuckets' => [ 'shape' => 'MaxDirectoryBuckets', 'location' => 'querystring', 'locationName' => 'max-directory-buckets', ], ], ], 'ListMultipartUploadsOutput' => [ 'type' => 'structure', 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', ], 'KeyMarker' => [ 'shape' => 'KeyMarker', ], 'UploadIdMarker' => [ 'shape' => 'UploadIdMarker', ], 'NextKeyMarker' => [ 'shape' => 'NextKeyMarker', ], 'Prefix' => [ 'shape' => 'Prefix', ], 'Delimiter' => [ 'shape' => 'Delimiter', ], 'NextUploadIdMarker' => [ 'shape' => 'NextUploadIdMarker', ], 'MaxUploads' => [ 'shape' => 'MaxUploads', ], 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'Uploads' => [ 'shape' => 'MultipartUploadList', 'locationName' => 'Upload', ], 'CommonPrefixes' => [ 'shape' => 'CommonPrefixList', ], 'EncodingType' => [ 'shape' => 'EncodingType', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'ListMultipartUploadsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Delimiter' => [ 'shape' => 'Delimiter', 'location' => 'querystring', 'locationName' => 'delimiter', ], 'EncodingType' => [ 'shape' => 'EncodingType', 'location' => 'querystring', 'locationName' => 'encoding-type', ], 'KeyMarker' => [ 'shape' => 'KeyMarker', 'location' => 'querystring', 'locationName' => 'key-marker', ], 'MaxUploads' => [ 'shape' => 'MaxUploads', 'location' => 'querystring', 'locationName' => 'max-uploads', ], 'Prefix' => [ 'shape' => 'Prefix', 'contextParam' => [ 'name' => 'Prefix', ], 'location' => 'querystring', 'locationName' => 'prefix', ], 'UploadIdMarker' => [ 'shape' => 'UploadIdMarker', 'location' => 'querystring', 'locationName' => 'upload-id-marker', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], ], ], 'ListObjectVersionsOutput' => [ 'type' => 'structure', 'members' => [ 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'KeyMarker' => [ 'shape' => 'KeyMarker', ], 'VersionIdMarker' => [ 'shape' => 'VersionIdMarker', ], 'NextKeyMarker' => [ 'shape' => 'NextKeyMarker', ], 'NextVersionIdMarker' => [ 'shape' => 'NextVersionIdMarker', ], 'Versions' => [ 'shape' => 'ObjectVersionList', 'locationName' => 'Version', ], 'DeleteMarkers' => [ 'shape' => 'DeleteMarkers', 'locationName' => 'DeleteMarker', ], 'Name' => [ 'shape' => 'BucketName', ], 'Prefix' => [ 'shape' => 'Prefix', ], 'Delimiter' => [ 'shape' => 'Delimiter', ], 'MaxKeys' => [ 'shape' => 'MaxKeys', ], 'CommonPrefixes' => [ 'shape' => 'CommonPrefixList', ], 'EncodingType' => [ 'shape' => 'EncodingType', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'ListObjectVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Delimiter' => [ 'shape' => 'Delimiter', 'location' => 'querystring', 'locationName' => 'delimiter', ], 'EncodingType' => [ 'shape' => 'EncodingType', 'location' => 'querystring', 'locationName' => 'encoding-type', ], 'KeyMarker' => [ 'shape' => 'KeyMarker', 'location' => 'querystring', 'locationName' => 'key-marker', ], 'MaxKeys' => [ 'shape' => 'MaxKeys', 'location' => 'querystring', 'locationName' => 'max-keys', ], 'Prefix' => [ 'shape' => 'Prefix', 'contextParam' => [ 'name' => 'Prefix', ], 'location' => 'querystring', 'locationName' => 'prefix', ], 'VersionIdMarker' => [ 'shape' => 'VersionIdMarker', 'location' => 'querystring', 'locationName' => 'version-id-marker', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'OptionalObjectAttributes' => [ 'shape' => 'OptionalObjectAttributesList', 'location' => 'header', 'locationName' => 'x-amz-optional-object-attributes', ], ], ], 'ListObjectsOutput' => [ 'type' => 'structure', 'members' => [ 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'Marker' => [ 'shape' => 'Marker', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Contents' => [ 'shape' => 'ObjectList', ], 'Name' => [ 'shape' => 'BucketName', ], 'Prefix' => [ 'shape' => 'Prefix', ], 'Delimiter' => [ 'shape' => 'Delimiter', ], 'MaxKeys' => [ 'shape' => 'MaxKeys', ], 'CommonPrefixes' => [ 'shape' => 'CommonPrefixList', ], 'EncodingType' => [ 'shape' => 'EncodingType', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'ListObjectsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Delimiter' => [ 'shape' => 'Delimiter', 'location' => 'querystring', 'locationName' => 'delimiter', ], 'EncodingType' => [ 'shape' => 'EncodingType', 'location' => 'querystring', 'locationName' => 'encoding-type', ], 'Marker' => [ 'shape' => 'Marker', 'location' => 'querystring', 'locationName' => 'marker', ], 'MaxKeys' => [ 'shape' => 'MaxKeys', 'location' => 'querystring', 'locationName' => 'max-keys', ], 'Prefix' => [ 'shape' => 'Prefix', 'contextParam' => [ 'name' => 'Prefix', ], 'location' => 'querystring', 'locationName' => 'prefix', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'OptionalObjectAttributes' => [ 'shape' => 'OptionalObjectAttributesList', 'location' => 'header', 'locationName' => 'x-amz-optional-object-attributes', ], ], ], 'ListObjectsV2Output' => [ 'type' => 'structure', 'members' => [ 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'Contents' => [ 'shape' => 'ObjectList', ], 'Name' => [ 'shape' => 'BucketName', ], 'Prefix' => [ 'shape' => 'Prefix', ], 'Delimiter' => [ 'shape' => 'Delimiter', ], 'MaxKeys' => [ 'shape' => 'MaxKeys', ], 'CommonPrefixes' => [ 'shape' => 'CommonPrefixList', ], 'EncodingType' => [ 'shape' => 'EncodingType', ], 'KeyCount' => [ 'shape' => 'KeyCount', ], 'ContinuationToken' => [ 'shape' => 'Token', ], 'NextContinuationToken' => [ 'shape' => 'NextToken', ], 'StartAfter' => [ 'shape' => 'StartAfter', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'ListObjectsV2Request' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Delimiter' => [ 'shape' => 'Delimiter', 'location' => 'querystring', 'locationName' => 'delimiter', ], 'EncodingType' => [ 'shape' => 'EncodingType', 'location' => 'querystring', 'locationName' => 'encoding-type', ], 'MaxKeys' => [ 'shape' => 'MaxKeys', 'location' => 'querystring', 'locationName' => 'max-keys', ], 'Prefix' => [ 'shape' => 'Prefix', 'contextParam' => [ 'name' => 'Prefix', ], 'location' => 'querystring', 'locationName' => 'prefix', ], 'ContinuationToken' => [ 'shape' => 'Token', 'location' => 'querystring', 'locationName' => 'continuation-token', ], 'FetchOwner' => [ 'shape' => 'FetchOwner', 'location' => 'querystring', 'locationName' => 'fetch-owner', ], 'StartAfter' => [ 'shape' => 'StartAfter', 'location' => 'querystring', 'locationName' => 'start-after', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'OptionalObjectAttributes' => [ 'shape' => 'OptionalObjectAttributesList', 'location' => 'header', 'locationName' => 'x-amz-optional-object-attributes', ], ], ], 'ListPartsOutput' => [ 'type' => 'structure', 'members' => [ 'AbortDate' => [ 'shape' => 'AbortDate', 'location' => 'header', 'locationName' => 'x-amz-abort-date', ], 'AbortRuleId' => [ 'shape' => 'AbortRuleId', 'location' => 'header', 'locationName' => 'x-amz-abort-rule-id', ], 'Bucket' => [ 'shape' => 'BucketName', ], 'Key' => [ 'shape' => 'ObjectKey', ], 'UploadId' => [ 'shape' => 'MultipartUploadId', ], 'PartNumberMarker' => [ 'shape' => 'PartNumberMarker', ], 'NextPartNumberMarker' => [ 'shape' => 'NextPartNumberMarker', ], 'MaxParts' => [ 'shape' => 'MaxParts', ], 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'Parts' => [ 'shape' => 'Parts', 'locationName' => 'Part', ], 'Initiator' => [ 'shape' => 'Initiator', ], 'Owner' => [ 'shape' => 'Owner', ], 'StorageClass' => [ 'shape' => 'StorageClass', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', ], ], ], 'ListPartsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'UploadId', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'MaxParts' => [ 'shape' => 'MaxParts', 'location' => 'querystring', 'locationName' => 'max-parts', ], 'PartNumberMarker' => [ 'shape' => 'PartNumberMarker', 'location' => 'querystring', 'locationName' => 'part-number-marker', ], 'UploadId' => [ 'shape' => 'MultipartUploadId', 'location' => 'querystring', 'locationName' => 'uploadId', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], ], ], 'Location' => [ 'type' => 'string', ], 'LocationInfo' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'LocationType', ], 'Name' => [ 'shape' => 'LocationNameAsString', ], ], ], 'LocationNameAsString' => [ 'type' => 'string', ], 'LocationPrefix' => [ 'type' => 'string', ], 'LocationType' => [ 'type' => 'string', 'enum' => [ 'AvailabilityZone', ], ], 'LoggingEnabled' => [ 'type' => 'structure', 'required' => [ 'TargetBucket', 'TargetPrefix', ], 'members' => [ 'TargetBucket' => [ 'shape' => 'TargetBucket', ], 'TargetGrants' => [ 'shape' => 'TargetGrants', ], 'TargetPrefix' => [ 'shape' => 'TargetPrefix', ], 'TargetObjectKeyFormat' => [ 'shape' => 'TargetObjectKeyFormat', ], ], ], 'MFA' => [ 'type' => 'string', ], 'MFADelete' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'MFADeleteStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Marker' => [ 'type' => 'string', ], 'MaxAgeSeconds' => [ 'type' => 'integer', 'box' => true, ], 'MaxBuckets' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'MaxDirectoryBuckets' => [ 'type' => 'integer', 'box' => true, 'max' => 1000, 'min' => 0, ], 'MaxKeys' => [ 'type' => 'integer', ], 'MaxParts' => [ 'type' => 'integer', ], 'MaxUploads' => [ 'type' => 'integer', ], 'Message' => [ 'type' => 'string', ], 'Metadata' => [ 'type' => 'map', 'key' => [ 'shape' => 'MetadataKey', ], 'value' => [ 'shape' => 'MetadataValue', ], ], 'MetadataDirective' => [ 'type' => 'string', 'enum' => [ 'COPY', 'REPLACE', ], ], 'MetadataEntry' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'MetadataKey', ], 'Value' => [ 'shape' => 'MetadataValue', ], ], ], 'MetadataKey' => [ 'type' => 'string', ], 'MetadataValue' => [ 'type' => 'string', ], 'Metrics' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'MetricsStatus', ], 'EventThreshold' => [ 'shape' => 'ReplicationTimeValue', ], ], ], 'MetricsAndOperator' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tags' => [ 'shape' => 'TagSet', 'flattened' => true, 'locationName' => 'Tag', ], 'AccessPointArn' => [ 'shape' => 'AccessPointArn', ], ], ], 'MetricsConfiguration' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'MetricsId', ], 'Filter' => [ 'shape' => 'MetricsFilter', ], ], ], 'MetricsConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricsConfiguration', ], 'flattened' => true, ], 'MetricsFilter' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tag' => [ 'shape' => 'Tag', ], 'AccessPointArn' => [ 'shape' => 'AccessPointArn', ], 'And' => [ 'shape' => 'MetricsAndOperator', ], ], ], 'MetricsId' => [ 'type' => 'string', ], 'MetricsStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Minutes' => [ 'type' => 'integer', 'box' => true, ], 'MissingMeta' => [ 'type' => 'integer', ], 'MultipartUpload' => [ 'type' => 'structure', 'members' => [ 'UploadId' => [ 'shape' => 'MultipartUploadId', ], 'Key' => [ 'shape' => 'ObjectKey', ], 'Initiated' => [ 'shape' => 'Initiated', ], 'StorageClass' => [ 'shape' => 'StorageClass', ], 'Owner' => [ 'shape' => 'Owner', ], 'Initiator' => [ 'shape' => 'Initiator', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', ], ], ], 'MultipartUploadId' => [ 'type' => 'string', ], 'MultipartUploadList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MultipartUpload', ], 'flattened' => true, ], 'NextKeyMarker' => [ 'type' => 'string', ], 'NextMarker' => [ 'type' => 'string', ], 'NextPartNumberMarker' => [ 'type' => 'integer', 'box' => true, ], 'NextToken' => [ 'type' => 'string', ], 'NextUploadIdMarker' => [ 'type' => 'string', ], 'NextVersionIdMarker' => [ 'type' => 'string', ], 'NoSuchBucket' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'NoSuchKey' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'NoSuchUpload' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'NoncurrentVersionExpiration' => [ 'type' => 'structure', 'members' => [ 'NoncurrentDays' => [ 'shape' => 'Days', ], 'NewerNoncurrentVersions' => [ 'shape' => 'VersionCount', ], ], ], 'NoncurrentVersionTransition' => [ 'type' => 'structure', 'members' => [ 'NoncurrentDays' => [ 'shape' => 'Days', ], 'StorageClass' => [ 'shape' => 'TransitionStorageClass', ], 'NewerNoncurrentVersions' => [ 'shape' => 'VersionCount', ], ], ], 'NoncurrentVersionTransitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NoncurrentVersionTransition', ], 'flattened' => true, ], 'NotificationConfiguration' => [ 'type' => 'structure', 'members' => [ 'TopicConfigurations' => [ 'shape' => 'TopicConfigurationList', 'locationName' => 'TopicConfiguration', ], 'QueueConfigurations' => [ 'shape' => 'QueueConfigurationList', 'locationName' => 'QueueConfiguration', ], 'LambdaFunctionConfigurations' => [ 'shape' => 'LambdaFunctionConfigurationList', 'locationName' => 'CloudFunctionConfiguration', ], 'EventBridgeConfiguration' => [ 'shape' => 'EventBridgeConfiguration', ], ], ], 'NotificationConfigurationDeprecated' => [ 'type' => 'structure', 'members' => [ 'TopicConfiguration' => [ 'shape' => 'TopicConfigurationDeprecated', ], 'QueueConfiguration' => [ 'shape' => 'QueueConfigurationDeprecated', ], 'CloudFunctionConfiguration' => [ 'shape' => 'CloudFunctionConfiguration', ], ], ], 'NotificationConfigurationFilter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'S3KeyFilter', 'locationName' => 'S3Key', ], ], ], 'NotificationId' => [ 'type' => 'string', ], 'Object' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ObjectKey', ], 'LastModified' => [ 'shape' => 'LastModified', ], 'ETag' => [ 'shape' => 'ETag', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithmList', ], 'Size' => [ 'shape' => 'Size', ], 'StorageClass' => [ 'shape' => 'ObjectStorageClass', ], 'Owner' => [ 'shape' => 'Owner', ], 'RestoreStatus' => [ 'shape' => 'RestoreStatus', ], ], ], 'ObjectAlreadyInActiveTierError' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'ObjectAttributes' => [ 'type' => 'string', 'enum' => [ 'ETag', 'Checksum', 'ObjectParts', 'StorageClass', 'ObjectSize', ], ], 'ObjectAttributesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ObjectAttributes', ], ], 'ObjectCannedACL' => [ 'type' => 'string', 'enum' => [ 'private', 'public-read', 'public-read-write', 'authenticated-read', 'aws-exec-read', 'bucket-owner-read', 'bucket-owner-full-control', ], ], 'ObjectIdentifier' => [ 'type' => 'structure', 'required' => [ 'Key', ], 'members' => [ 'Key' => [ 'shape' => 'ObjectKey', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', ], 'ETag' => [ 'shape' => 'ETag', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Size' => [ 'shape' => 'Size', ], ], ], 'ObjectIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ObjectIdentifier', ], 'flattened' => true, ], 'ObjectKey' => [ 'type' => 'string', 'min' => 1, ], 'ObjectList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Object', ], 'flattened' => true, ], 'ObjectLockConfiguration' => [ 'type' => 'structure', 'members' => [ 'ObjectLockEnabled' => [ 'shape' => 'ObjectLockEnabled', ], 'Rule' => [ 'shape' => 'ObjectLockRule', ], ], ], 'ObjectLockEnabled' => [ 'type' => 'string', 'enum' => [ 'Enabled', ], ], 'ObjectLockEnabledForBucket' => [ 'type' => 'boolean', 'box' => true, ], 'ObjectLockLegalHold' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'ObjectLockLegalHoldStatus', ], ], ], 'ObjectLockLegalHoldStatus' => [ 'type' => 'string', 'enum' => [ 'ON', 'OFF', ], ], 'ObjectLockMode' => [ 'type' => 'string', 'enum' => [ 'GOVERNANCE', 'COMPLIANCE', ], ], 'ObjectLockRetainUntilDate' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'ObjectLockRetention' => [ 'type' => 'structure', 'members' => [ 'Mode' => [ 'shape' => 'ObjectLockRetentionMode', ], 'RetainUntilDate' => [ 'shape' => 'Date', ], ], ], 'ObjectLockRetentionMode' => [ 'type' => 'string', 'enum' => [ 'GOVERNANCE', 'COMPLIANCE', ], ], 'ObjectLockRule' => [ 'type' => 'structure', 'members' => [ 'DefaultRetention' => [ 'shape' => 'DefaultRetention', ], ], ], 'ObjectLockToken' => [ 'type' => 'string', ], 'ObjectNotInActiveTierError' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'ObjectOwnership' => [ 'type' => 'string', 'enum' => [ 'BucketOwnerPreferred', 'ObjectWriter', 'BucketOwnerEnforced', ], ], 'ObjectPart' => [ 'type' => 'structure', 'members' => [ 'PartNumber' => [ 'shape' => 'PartNumber', ], 'Size' => [ 'shape' => 'Size', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], ], ], 'ObjectSize' => [ 'type' => 'long', 'box' => true, ], 'ObjectSizeGreaterThanBytes' => [ 'type' => 'long', 'box' => true, ], 'ObjectSizeLessThanBytes' => [ 'type' => 'long', 'box' => true, ], 'ObjectStorageClass' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'REDUCED_REDUNDANCY', 'GLACIER', 'STANDARD_IA', 'ONEZONE_IA', 'INTELLIGENT_TIERING', 'DEEP_ARCHIVE', 'OUTPOSTS', 'GLACIER_IR', 'SNOW', 'EXPRESS_ONEZONE', ], ], 'ObjectVersion' => [ 'type' => 'structure', 'members' => [ 'ETag' => [ 'shape' => 'ETag', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithmList', ], 'Size' => [ 'shape' => 'Size', ], 'StorageClass' => [ 'shape' => 'ObjectVersionStorageClass', ], 'Key' => [ 'shape' => 'ObjectKey', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', ], 'IsLatest' => [ 'shape' => 'IsLatest', ], 'LastModified' => [ 'shape' => 'LastModified', ], 'Owner' => [ 'shape' => 'Owner', ], 'RestoreStatus' => [ 'shape' => 'RestoreStatus', ], ], ], 'ObjectVersionId' => [ 'type' => 'string', ], 'ObjectVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ObjectVersion', ], 'flattened' => true, ], 'ObjectVersionStorageClass' => [ 'type' => 'string', 'enum' => [ 'STANDARD', ], ], 'OptionalObjectAttributes' => [ 'type' => 'string', 'enum' => [ 'RestoreStatus', ], ], 'OptionalObjectAttributesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionalObjectAttributes', ], ], 'OutputLocation' => [ 'type' => 'structure', 'members' => [ 'S3' => [ 'shape' => 'S3Location', ], ], ], 'OutputSerialization' => [ 'type' => 'structure', 'members' => [ 'CSV' => [ 'shape' => 'CSVOutput', ], 'JSON' => [ 'shape' => 'JSONOutput', ], ], ], 'Owner' => [ 'type' => 'structure', 'members' => [ 'DisplayName' => [ 'shape' => 'DisplayName', ], 'ID' => [ 'shape' => 'ID', ], ], ], 'OwnerOverride' => [ 'type' => 'string', 'enum' => [ 'Destination', ], ], 'OwnershipControls' => [ 'type' => 'structure', 'required' => [ 'Rules', ], 'members' => [ 'Rules' => [ 'shape' => 'OwnershipControlsRules', 'locationName' => 'Rule', ], ], ], 'OwnershipControlsRule' => [ 'type' => 'structure', 'required' => [ 'ObjectOwnership', ], 'members' => [ 'ObjectOwnership' => [ 'shape' => 'ObjectOwnership', ], ], ], 'OwnershipControlsRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'OwnershipControlsRule', ], 'flattened' => true, ], 'ParquetInput' => [ 'type' => 'structure', 'members' => [], ], 'Part' => [ 'type' => 'structure', 'members' => [ 'PartNumber' => [ 'shape' => 'PartNumber', ], 'LastModified' => [ 'shape' => 'LastModified', ], 'ETag' => [ 'shape' => 'ETag', ], 'Size' => [ 'shape' => 'Size', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], ], ], 'PartNumber' => [ 'type' => 'integer', ], 'PartNumberMarker' => [ 'type' => 'integer', ], 'PartitionDateSource' => [ 'type' => 'string', 'enum' => [ 'EventTime', 'DeliveryTime', ], ], 'PartitionedPrefix' => [ 'type' => 'structure', 'members' => [ 'PartitionDateSource' => [ 'shape' => 'PartitionDateSource', ], ], 'locationName' => 'PartitionedPrefix', ], 'Parts' => [ 'type' => 'list', 'member' => [ 'shape' => 'Part', ], 'flattened' => true, ], 'PartsCount' => [ 'type' => 'integer', 'box' => true, ], 'PartsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ObjectPart', ], 'flattened' => true, ], 'Payer' => [ 'type' => 'string', 'enum' => [ 'Requester', 'BucketOwner', ], ], 'Permission' => [ 'type' => 'string', 'enum' => [ 'FULL_CONTROL', 'WRITE', 'WRITE_ACP', 'READ', 'READ_ACP', ], ], 'Policy' => [ 'type' => 'string', ], 'PolicyStatus' => [ 'type' => 'structure', 'members' => [ 'IsPublic' => [ 'shape' => 'IsPublic', 'locationName' => 'IsPublic', ], ], ], 'Prefix' => [ 'type' => 'string', ], 'Priority' => [ 'type' => 'integer', 'box' => true, ], 'Progress' => [ 'type' => 'structure', 'members' => [ 'BytesScanned' => [ 'shape' => 'BytesScanned', ], 'BytesProcessed' => [ 'shape' => 'BytesProcessed', ], 'BytesReturned' => [ 'shape' => 'BytesReturned', ], ], ], 'ProgressEvent' => [ 'type' => 'structure', 'members' => [ 'Details' => [ 'shape' => 'Progress', 'eventpayload' => true, ], ], 'event' => true, ], 'Protocol' => [ 'type' => 'string', 'enum' => [ 'http', 'https', ], ], 'PublicAccessBlockConfiguration' => [ 'type' => 'structure', 'members' => [ 'BlockPublicAcls' => [ 'shape' => 'Setting', 'locationName' => 'BlockPublicAcls', ], 'IgnorePublicAcls' => [ 'shape' => 'Setting', 'locationName' => 'IgnorePublicAcls', ], 'BlockPublicPolicy' => [ 'shape' => 'Setting', 'locationName' => 'BlockPublicPolicy', ], 'RestrictPublicBuckets' => [ 'shape' => 'Setting', 'locationName' => 'RestrictPublicBuckets', ], ], ], 'PutBucketAccelerateConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'AccelerateConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'AccelerateConfiguration' => [ 'shape' => 'AccelerateConfiguration', 'locationName' => 'AccelerateConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], ], 'payload' => 'AccelerateConfiguration', ], 'PutBucketAclRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'ACL' => [ 'shape' => 'BucketCannedACL', 'location' => 'header', 'locationName' => 'x-amz-acl', ], 'AccessControlPolicy' => [ 'shape' => 'AccessControlPolicy', 'locationName' => 'AccessControlPolicy', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'GrantFullControl' => [ 'shape' => 'GrantFullControl', 'location' => 'header', 'locationName' => 'x-amz-grant-full-control', ], 'GrantRead' => [ 'shape' => 'GrantRead', 'location' => 'header', 'locationName' => 'x-amz-grant-read', ], 'GrantReadACP' => [ 'shape' => 'GrantReadACP', 'location' => 'header', 'locationName' => 'x-amz-grant-read-acp', ], 'GrantWrite' => [ 'shape' => 'GrantWrite', 'location' => 'header', 'locationName' => 'x-amz-grant-write', ], 'GrantWriteACP' => [ 'shape' => 'GrantWriteACP', 'location' => 'header', 'locationName' => 'x-amz-grant-write-acp', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'AccessControlPolicy', ], 'PutBucketAnalyticsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', 'AnalyticsConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'AnalyticsId', 'location' => 'querystring', 'locationName' => 'id', ], 'AnalyticsConfiguration' => [ 'shape' => 'AnalyticsConfiguration', 'locationName' => 'AnalyticsConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'AnalyticsConfiguration', ], 'PutBucketCorsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'CORSConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'CORSConfiguration' => [ 'shape' => 'CORSConfiguration', 'locationName' => 'CORSConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'CORSConfiguration', ], 'PutBucketEncryptionRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'ServerSideEncryptionConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ServerSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', 'locationName' => 'ServerSideEncryptionConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'ServerSideEncryptionConfiguration', ], 'PutBucketIntelligentTieringConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', 'IntelligentTieringConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'IntelligentTieringId', 'location' => 'querystring', 'locationName' => 'id', ], 'IntelligentTieringConfiguration' => [ 'shape' => 'IntelligentTieringConfiguration', 'locationName' => 'IntelligentTieringConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], ], 'payload' => 'IntelligentTieringConfiguration', ], 'PutBucketInventoryConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', 'InventoryConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'InventoryId', 'location' => 'querystring', 'locationName' => 'id', ], 'InventoryConfiguration' => [ 'shape' => 'InventoryConfiguration', 'locationName' => 'InventoryConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'InventoryConfiguration', ], 'PutBucketLifecycleConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'TransitionDefaultMinimumObjectSize' => [ 'shape' => 'TransitionDefaultMinimumObjectSize', 'location' => 'header', 'locationName' => 'x-amz-transition-default-minimum-object-size', ], ], ], 'PutBucketLifecycleConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'LifecycleConfiguration' => [ 'shape' => 'BucketLifecycleConfiguration', 'locationName' => 'LifecycleConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'TransitionDefaultMinimumObjectSize' => [ 'shape' => 'TransitionDefaultMinimumObjectSize', 'location' => 'header', 'locationName' => 'x-amz-transition-default-minimum-object-size', ], ], 'payload' => 'LifecycleConfiguration', ], 'PutBucketLifecycleRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'LifecycleConfiguration' => [ 'shape' => 'LifecycleConfiguration', 'locationName' => 'LifecycleConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'LifecycleConfiguration', ], 'PutBucketLoggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'BucketLoggingStatus', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'BucketLoggingStatus' => [ 'shape' => 'BucketLoggingStatus', 'locationName' => 'BucketLoggingStatus', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'BucketLoggingStatus', ], 'PutBucketMetricsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', 'MetricsConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'MetricsId', 'location' => 'querystring', 'locationName' => 'id', ], 'MetricsConfiguration' => [ 'shape' => 'MetricsConfiguration', 'locationName' => 'MetricsConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'MetricsConfiguration', ], 'PutBucketNotificationConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'NotificationConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', 'locationName' => 'NotificationConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'SkipDestinationValidation' => [ 'shape' => 'SkipValidation', 'location' => 'header', 'locationName' => 'x-amz-skip-destination-validation', ], ], 'payload' => 'NotificationConfiguration', ], 'PutBucketNotificationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'NotificationConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfigurationDeprecated', 'locationName' => 'NotificationConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'NotificationConfiguration', ], 'PutBucketOwnershipControlsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'OwnershipControls', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'OwnershipControls' => [ 'shape' => 'OwnershipControls', 'locationName' => 'OwnershipControls', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], ], 'payload' => 'OwnershipControls', ], 'PutBucketPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Policy', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ConfirmRemoveSelfBucketAccess' => [ 'shape' => 'ConfirmRemoveSelfBucketAccess', 'location' => 'header', 'locationName' => 'x-amz-confirm-remove-self-bucket-access', ], 'Policy' => [ 'shape' => 'Policy', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'Policy', ], 'PutBucketReplicationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'ReplicationConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ReplicationConfiguration' => [ 'shape' => 'ReplicationConfiguration', 'locationName' => 'ReplicationConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'Token' => [ 'shape' => 'ObjectLockToken', 'location' => 'header', 'locationName' => 'x-amz-bucket-object-lock-token', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'ReplicationConfiguration', ], 'PutBucketRequestPaymentRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'RequestPaymentConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'RequestPaymentConfiguration' => [ 'shape' => 'RequestPaymentConfiguration', 'locationName' => 'RequestPaymentConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'RequestPaymentConfiguration', ], 'PutBucketTaggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Tagging', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'Tagging' => [ 'shape' => 'Tagging', 'locationName' => 'Tagging', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'Tagging', ], 'PutBucketVersioningRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'VersioningConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'MFA' => [ 'shape' => 'MFA', 'location' => 'header', 'locationName' => 'x-amz-mfa', ], 'VersioningConfiguration' => [ 'shape' => 'VersioningConfiguration', 'locationName' => 'VersioningConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'VersioningConfiguration', ], 'PutBucketWebsiteRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'WebsiteConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'WebsiteConfiguration' => [ 'shape' => 'WebsiteConfiguration', 'locationName' => 'WebsiteConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'WebsiteConfiguration', ], 'PutObjectAclOutput' => [ 'type' => 'structure', 'members' => [ 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'PutObjectAclRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'ACL' => [ 'shape' => 'ObjectCannedACL', 'location' => 'header', 'locationName' => 'x-amz-acl', ], 'AccessControlPolicy' => [ 'shape' => 'AccessControlPolicy', 'locationName' => 'AccessControlPolicy', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'GrantFullControl' => [ 'shape' => 'GrantFullControl', 'location' => 'header', 'locationName' => 'x-amz-grant-full-control', ], 'GrantRead' => [ 'shape' => 'GrantRead', 'location' => 'header', 'locationName' => 'x-amz-grant-read', ], 'GrantReadACP' => [ 'shape' => 'GrantReadACP', 'location' => 'header', 'locationName' => 'x-amz-grant-read-acp', ], 'GrantWrite' => [ 'shape' => 'GrantWrite', 'location' => 'header', 'locationName' => 'x-amz-grant-write', ], 'GrantWriteACP' => [ 'shape' => 'GrantWriteACP', 'location' => 'header', 'locationName' => 'x-amz-grant-write-acp', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'AccessControlPolicy', ], 'PutObjectLegalHoldOutput' => [ 'type' => 'structure', 'members' => [ 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'PutObjectLegalHoldRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'LegalHold' => [ 'shape' => 'ObjectLockLegalHold', 'locationName' => 'LegalHold', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'LegalHold', ], 'PutObjectLockConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'PutObjectLockConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ObjectLockConfiguration' => [ 'shape' => 'ObjectLockConfiguration', 'locationName' => 'ObjectLockConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'Token' => [ 'shape' => 'ObjectLockToken', 'location' => 'header', 'locationName' => 'x-amz-bucket-object-lock-token', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'ObjectLockConfiguration', ], 'PutObjectOutput' => [ 'type' => 'structure', 'members' => [ 'Expiration' => [ 'shape' => 'Expiration', 'location' => 'header', 'locationName' => 'x-amz-expiration', ], 'ETag' => [ 'shape' => 'ETag', 'location' => 'header', 'locationName' => 'ETag', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'Size' => [ 'shape' => 'Size', 'location' => 'header', 'locationName' => 'x-amz-object-size', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'PutObjectRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'ACL' => [ 'shape' => 'ObjectCannedACL', 'location' => 'header', 'locationName' => 'x-amz-acl', ], 'Body' => [ 'shape' => 'Body', 'streaming' => true, ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'CacheControl' => [ 'shape' => 'CacheControl', 'location' => 'header', 'locationName' => 'Cache-Control', ], 'ContentDisposition' => [ 'shape' => 'ContentDisposition', 'location' => 'header', 'locationName' => 'Content-Disposition', ], 'ContentEncoding' => [ 'shape' => 'ContentEncoding', 'location' => 'header', 'locationName' => 'Content-Encoding', ], 'ContentLanguage' => [ 'shape' => 'ContentLanguage', 'location' => 'header', 'locationName' => 'Content-Language', ], 'ContentLength' => [ 'shape' => 'ContentLength', 'location' => 'header', 'locationName' => 'Content-Length', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ContentType' => [ 'shape' => 'ContentType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'Expires' => [ 'shape' => 'Expires', 'location' => 'header', 'locationName' => 'Expires', ], 'IfNoneMatch' => [ 'shape' => 'IfNoneMatch', 'location' => 'header', 'locationName' => 'If-None-Match', ], 'GrantFullControl' => [ 'shape' => 'GrantFullControl', 'location' => 'header', 'locationName' => 'x-amz-grant-full-control', ], 'GrantRead' => [ 'shape' => 'GrantRead', 'location' => 'header', 'locationName' => 'x-amz-grant-read', ], 'GrantReadACP' => [ 'shape' => 'GrantReadACP', 'location' => 'header', 'locationName' => 'x-amz-grant-read-acp', ], 'GrantWriteACP' => [ 'shape' => 'GrantWriteACP', 'location' => 'header', 'locationName' => 'x-amz-grant-write-acp', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'WriteOffsetBytes' => [ 'shape' => 'WriteOffsetBytes', 'location' => 'header', 'locationName' => 'x-amz-write-offset-bytes', ], 'Metadata' => [ 'shape' => 'Metadata', 'location' => 'headers', 'locationName' => 'x-amz-meta-', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'StorageClass' => [ 'shape' => 'StorageClass', 'location' => 'header', 'locationName' => 'x-amz-storage-class', ], 'WebsiteRedirectLocation' => [ 'shape' => 'WebsiteRedirectLocation', 'location' => 'header', 'locationName' => 'x-amz-website-redirect-location', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'Tagging' => [ 'shape' => 'TaggingHeader', 'location' => 'header', 'locationName' => 'x-amz-tagging', ], 'ObjectLockMode' => [ 'shape' => 'ObjectLockMode', 'location' => 'header', 'locationName' => 'x-amz-object-lock-mode', ], 'ObjectLockRetainUntilDate' => [ 'shape' => 'ObjectLockRetainUntilDate', 'location' => 'header', 'locationName' => 'x-amz-object-lock-retain-until-date', ], 'ObjectLockLegalHoldStatus' => [ 'shape' => 'ObjectLockLegalHoldStatus', 'location' => 'header', 'locationName' => 'x-amz-object-lock-legal-hold', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'Body', ], 'PutObjectRetentionOutput' => [ 'type' => 'structure', 'members' => [ 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'PutObjectRetentionRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'Retention' => [ 'shape' => 'ObjectLockRetention', 'locationName' => 'Retention', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'BypassGovernanceRetention' => [ 'shape' => 'BypassGovernanceRetention', 'location' => 'header', 'locationName' => 'x-amz-bypass-governance-retention', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'Retention', ], 'PutObjectTaggingOutput' => [ 'type' => 'structure', 'members' => [ 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], ], ], 'PutObjectTaggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'Tagging', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'Tagging' => [ 'shape' => 'Tagging', 'locationName' => 'Tagging', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], ], 'payload' => 'Tagging', ], 'PutPublicAccessBlockRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'PublicAccessBlockConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'PublicAccessBlockConfiguration' => [ 'shape' => 'PublicAccessBlockConfiguration', 'locationName' => 'PublicAccessBlockConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'PublicAccessBlockConfiguration', ], 'QueueArn' => [ 'type' => 'string', ], 'QueueConfiguration' => [ 'type' => 'structure', 'required' => [ 'QueueArn', 'Events', ], 'members' => [ 'Id' => [ 'shape' => 'NotificationId', ], 'QueueArn' => [ 'shape' => 'QueueArn', 'locationName' => 'Queue', ], 'Events' => [ 'shape' => 'EventList', 'locationName' => 'Event', ], 'Filter' => [ 'shape' => 'NotificationConfigurationFilter', ], ], ], 'QueueConfigurationDeprecated' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'NotificationId', ], 'Event' => [ 'shape' => 'Event', 'deprecated' => true, ], 'Events' => [ 'shape' => 'EventList', 'locationName' => 'Event', ], 'Queue' => [ 'shape' => 'QueueArn', ], ], ], 'QueueConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueConfiguration', ], 'flattened' => true, ], 'Quiet' => [ 'type' => 'boolean', 'box' => true, ], 'QuoteCharacter' => [ 'type' => 'string', ], 'QuoteEscapeCharacter' => [ 'type' => 'string', ], 'QuoteFields' => [ 'type' => 'string', 'enum' => [ 'ALWAYS', 'ASNEEDED', ], ], 'Range' => [ 'type' => 'string', ], 'RecordDelimiter' => [ 'type' => 'string', ], 'RecordsEvent' => [ 'type' => 'structure', 'members' => [ 'Payload' => [ 'shape' => 'Body', 'eventpayload' => true, ], ], 'event' => true, ], 'Redirect' => [ 'type' => 'structure', 'members' => [ 'HostName' => [ 'shape' => 'HostName', ], 'HttpRedirectCode' => [ 'shape' => 'HttpRedirectCode', ], 'Protocol' => [ 'shape' => 'Protocol', ], 'ReplaceKeyPrefixWith' => [ 'shape' => 'ReplaceKeyPrefixWith', ], 'ReplaceKeyWith' => [ 'shape' => 'ReplaceKeyWith', ], ], ], 'RedirectAllRequestsTo' => [ 'type' => 'structure', 'required' => [ 'HostName', ], 'members' => [ 'HostName' => [ 'shape' => 'HostName', ], 'Protocol' => [ 'shape' => 'Protocol', ], ], ], 'Region' => [ 'type' => 'string', 'max' => 20, 'min' => 0, ], 'ReplaceKeyPrefixWith' => [ 'type' => 'string', ], 'ReplaceKeyWith' => [ 'type' => 'string', ], 'ReplicaKmsKeyID' => [ 'type' => 'string', ], 'ReplicaModifications' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'ReplicaModificationsStatus', ], ], ], 'ReplicaModificationsStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ReplicationConfiguration' => [ 'type' => 'structure', 'required' => [ 'Role', 'Rules', ], 'members' => [ 'Role' => [ 'shape' => 'Role', ], 'Rules' => [ 'shape' => 'ReplicationRules', 'locationName' => 'Rule', ], ], ], 'ReplicationRule' => [ 'type' => 'structure', 'required' => [ 'Status', 'Destination', ], 'members' => [ 'ID' => [ 'shape' => 'ID', ], 'Priority' => [ 'shape' => 'Priority', ], 'Prefix' => [ 'shape' => 'Prefix', 'deprecated' => true, ], 'Filter' => [ 'shape' => 'ReplicationRuleFilter', ], 'Status' => [ 'shape' => 'ReplicationRuleStatus', ], 'SourceSelectionCriteria' => [ 'shape' => 'SourceSelectionCriteria', ], 'ExistingObjectReplication' => [ 'shape' => 'ExistingObjectReplication', ], 'Destination' => [ 'shape' => 'Destination', ], 'DeleteMarkerReplication' => [ 'shape' => 'DeleteMarkerReplication', ], ], ], 'ReplicationRuleAndOperator' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tags' => [ 'shape' => 'TagSet', 'flattened' => true, 'locationName' => 'Tag', ], ], ], 'ReplicationRuleFilter' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tag' => [ 'shape' => 'Tag', ], 'And' => [ 'shape' => 'ReplicationRuleAndOperator', ], ], ], 'ReplicationRuleStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ReplicationRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReplicationRule', ], 'flattened' => true, ], 'ReplicationStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETE', 'PENDING', 'FAILED', 'REPLICA', 'COMPLETED', ], ], 'ReplicationTime' => [ 'type' => 'structure', 'required' => [ 'Status', 'Time', ], 'members' => [ 'Status' => [ 'shape' => 'ReplicationTimeStatus', ], 'Time' => [ 'shape' => 'ReplicationTimeValue', ], ], ], 'ReplicationTimeStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ReplicationTimeValue' => [ 'type' => 'structure', 'members' => [ 'Minutes' => [ 'shape' => 'Minutes', ], ], ], 'RequestCharged' => [ 'type' => 'string', 'enum' => [ 'requester', ], ], 'RequestPayer' => [ 'type' => 'string', 'enum' => [ 'requester', ], ], 'RequestPaymentConfiguration' => [ 'type' => 'structure', 'required' => [ 'Payer', ], 'members' => [ 'Payer' => [ 'shape' => 'Payer', ], ], ], 'RequestProgress' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'EnableRequestProgress', ], ], ], 'RequestRoute' => [ 'type' => 'string', ], 'RequestToken' => [ 'type' => 'string', ], 'ResponseCacheControl' => [ 'type' => 'string', ], 'ResponseContentDisposition' => [ 'type' => 'string', ], 'ResponseContentEncoding' => [ 'type' => 'string', ], 'ResponseContentLanguage' => [ 'type' => 'string', ], 'ResponseContentType' => [ 'type' => 'string', ], 'ResponseExpires' => [ 'type' => 'timestamp', 'timestampFormat' => 'rfc822', ], 'Restore' => [ 'type' => 'string', ], 'RestoreExpiryDate' => [ 'type' => 'timestamp', ], 'RestoreObjectOutput' => [ 'type' => 'structure', 'members' => [ 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'RestoreOutputPath' => [ 'shape' => 'RestoreOutputPath', 'location' => 'header', 'locationName' => 'x-amz-restore-output-path', ], ], ], 'RestoreObjectRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'RestoreRequest' => [ 'shape' => 'RestoreRequest', 'locationName' => 'RestoreRequest', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'RestoreRequest', ], 'RestoreOutputPath' => [ 'type' => 'string', ], 'RestoreRequest' => [ 'type' => 'structure', 'members' => [ 'Days' => [ 'shape' => 'Days', ], 'GlacierJobParameters' => [ 'shape' => 'GlacierJobParameters', ], 'Type' => [ 'shape' => 'RestoreRequestType', ], 'Tier' => [ 'shape' => 'Tier', ], 'Description' => [ 'shape' => 'Description', ], 'SelectParameters' => [ 'shape' => 'SelectParameters', ], 'OutputLocation' => [ 'shape' => 'OutputLocation', ], ], ], 'RestoreRequestType' => [ 'type' => 'string', 'enum' => [ 'SELECT', ], ], 'RestoreStatus' => [ 'type' => 'structure', 'members' => [ 'IsRestoreInProgress' => [ 'shape' => 'IsRestoreInProgress', ], 'RestoreExpiryDate' => [ 'shape' => 'RestoreExpiryDate', ], ], ], 'Role' => [ 'type' => 'string', ], 'RoutingRule' => [ 'type' => 'structure', 'required' => [ 'Redirect', ], 'members' => [ 'Condition' => [ 'shape' => 'Condition', ], 'Redirect' => [ 'shape' => 'Redirect', ], ], ], 'RoutingRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingRule', 'locationName' => 'RoutingRule', ], ], 'Rule' => [ 'type' => 'structure', 'required' => [ 'Prefix', 'Status', ], 'members' => [ 'Expiration' => [ 'shape' => 'LifecycleExpiration', ], 'ID' => [ 'shape' => 'ID', ], 'Prefix' => [ 'shape' => 'Prefix', ], 'Status' => [ 'shape' => 'ExpirationStatus', ], 'Transition' => [ 'shape' => 'Transition', ], 'NoncurrentVersionTransition' => [ 'shape' => 'NoncurrentVersionTransition', ], 'NoncurrentVersionExpiration' => [ 'shape' => 'NoncurrentVersionExpiration', ], 'AbortIncompleteMultipartUpload' => [ 'shape' => 'AbortIncompleteMultipartUpload', ], ], ], 'Rules' => [ 'type' => 'list', 'member' => [ 'shape' => 'Rule', ], 'flattened' => true, ], 'S3KeyFilter' => [ 'type' => 'structure', 'members' => [ 'FilterRules' => [ 'shape' => 'FilterRuleList', 'locationName' => 'FilterRule', ], ], ], 'S3Location' => [ 'type' => 'structure', 'required' => [ 'BucketName', 'Prefix', ], 'members' => [ 'BucketName' => [ 'shape' => 'BucketName', ], 'Prefix' => [ 'shape' => 'LocationPrefix', ], 'Encryption' => [ 'shape' => 'Encryption', ], 'CannedACL' => [ 'shape' => 'ObjectCannedACL', ], 'AccessControlList' => [ 'shape' => 'Grants', ], 'Tagging' => [ 'shape' => 'Tagging', ], 'UserMetadata' => [ 'shape' => 'UserMetadata', ], 'StorageClass' => [ 'shape' => 'StorageClass', ], ], ], 'SSECustomerAlgorithm' => [ 'type' => 'string', ], 'SSECustomerKey' => [ 'type' => 'string', 'sensitive' => true, ], 'SSECustomerKeyMD5' => [ 'type' => 'string', ], 'SSEKMS' => [ 'type' => 'structure', 'required' => [ 'KeyId', ], 'members' => [ 'KeyId' => [ 'shape' => 'SSEKMSKeyId', ], ], 'locationName' => 'SSE-KMS', ], 'SSEKMSEncryptionContext' => [ 'type' => 'string', 'sensitive' => true, ], 'SSEKMSKeyId' => [ 'type' => 'string', 'sensitive' => true, ], 'SSES3' => [ 'type' => 'structure', 'members' => [], 'locationName' => 'SSE-S3', ], 'ScanRange' => [ 'type' => 'structure', 'members' => [ 'Start' => [ 'shape' => 'Start', ], 'End' => [ 'shape' => 'End', ], ], ], 'SelectObjectContentEventStream' => [ 'type' => 'structure', 'members' => [ 'Records' => [ 'shape' => 'RecordsEvent', ], 'Stats' => [ 'shape' => 'StatsEvent', ], 'Progress' => [ 'shape' => 'ProgressEvent', ], 'Cont' => [ 'shape' => 'ContinuationEvent', ], 'End' => [ 'shape' => 'EndEvent', ], ], 'eventstream' => true, ], 'SelectObjectContentOutput' => [ 'type' => 'structure', 'members' => [ 'Payload' => [ 'shape' => 'SelectObjectContentEventStream', ], ], 'payload' => 'Payload', ], 'SelectObjectContentRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'Expression', 'ExpressionType', 'InputSerialization', 'OutputSerialization', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'Expression' => [ 'shape' => 'Expression', ], 'ExpressionType' => [ 'shape' => 'ExpressionType', ], 'RequestProgress' => [ 'shape' => 'RequestProgress', ], 'InputSerialization' => [ 'shape' => 'InputSerialization', ], 'OutputSerialization' => [ 'shape' => 'OutputSerialization', ], 'ScanRange' => [ 'shape' => 'ScanRange', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'SelectParameters' => [ 'type' => 'structure', 'required' => [ 'InputSerialization', 'ExpressionType', 'Expression', 'OutputSerialization', ], 'members' => [ 'InputSerialization' => [ 'shape' => 'InputSerialization', ], 'ExpressionType' => [ 'shape' => 'ExpressionType', ], 'Expression' => [ 'shape' => 'Expression', ], 'OutputSerialization' => [ 'shape' => 'OutputSerialization', ], ], ], 'ServerSideEncryption' => [ 'type' => 'string', 'enum' => [ 'AES256', 'aws:kms', 'aws:kms:dsse', ], ], 'ServerSideEncryptionByDefault' => [ 'type' => 'structure', 'required' => [ 'SSEAlgorithm', ], 'members' => [ 'SSEAlgorithm' => [ 'shape' => 'ServerSideEncryption', ], 'KMSMasterKeyID' => [ 'shape' => 'SSEKMSKeyId', ], ], ], 'ServerSideEncryptionConfiguration' => [ 'type' => 'structure', 'required' => [ 'Rules', ], 'members' => [ 'Rules' => [ 'shape' => 'ServerSideEncryptionRules', 'locationName' => 'Rule', ], ], ], 'ServerSideEncryptionRule' => [ 'type' => 'structure', 'members' => [ 'ApplyServerSideEncryptionByDefault' => [ 'shape' => 'ServerSideEncryptionByDefault', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', ], ], ], 'ServerSideEncryptionRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServerSideEncryptionRule', ], 'flattened' => true, ], 'SessionCredentialValue' => [ 'type' => 'string', 'sensitive' => true, ], 'SessionCredentials' => [ 'type' => 'structure', 'required' => [ 'AccessKeyId', 'SecretAccessKey', 'SessionToken', 'Expiration', ], 'members' => [ 'AccessKeyId' => [ 'shape' => 'AccessKeyIdValue', 'locationName' => 'AccessKeyId', ], 'SecretAccessKey' => [ 'shape' => 'SessionCredentialValue', 'locationName' => 'SecretAccessKey', ], 'SessionToken' => [ 'shape' => 'SessionCredentialValue', 'locationName' => 'SessionToken', ], 'Expiration' => [ 'shape' => 'SessionExpiration', 'locationName' => 'Expiration', ], ], ], 'SessionExpiration' => [ 'type' => 'timestamp', ], 'SessionMode' => [ 'type' => 'string', 'enum' => [ 'ReadOnly', 'ReadWrite', ], ], 'Setting' => [ 'type' => 'boolean', 'box' => true, ], 'SimplePrefix' => [ 'type' => 'structure', 'members' => [], 'locationName' => 'SimplePrefix', ], 'Size' => [ 'type' => 'long', 'box' => true, ], 'SkipValidation' => [ 'type' => 'boolean', 'box' => true, ], 'SourceSelectionCriteria' => [ 'type' => 'structure', 'members' => [ 'SseKmsEncryptedObjects' => [ 'shape' => 'SseKmsEncryptedObjects', ], 'ReplicaModifications' => [ 'shape' => 'ReplicaModifications', ], ], ], 'SseKmsEncryptedObjects' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'SseKmsEncryptedObjectsStatus', ], ], ], 'SseKmsEncryptedObjectsStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Start' => [ 'type' => 'long', 'box' => true, ], 'StartAfter' => [ 'type' => 'string', ], 'Stats' => [ 'type' => 'structure', 'members' => [ 'BytesScanned' => [ 'shape' => 'BytesScanned', ], 'BytesProcessed' => [ 'shape' => 'BytesProcessed', ], 'BytesReturned' => [ 'shape' => 'BytesReturned', ], ], ], 'StatsEvent' => [ 'type' => 'structure', 'members' => [ 'Details' => [ 'shape' => 'Stats', 'eventpayload' => true, ], ], 'event' => true, ], 'StorageClass' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'REDUCED_REDUNDANCY', 'STANDARD_IA', 'ONEZONE_IA', 'INTELLIGENT_TIERING', 'GLACIER', 'DEEP_ARCHIVE', 'OUTPOSTS', 'GLACIER_IR', 'SNOW', 'EXPRESS_ONEZONE', ], ], 'StorageClassAnalysis' => [ 'type' => 'structure', 'members' => [ 'DataExport' => [ 'shape' => 'StorageClassAnalysisDataExport', ], ], ], 'StorageClassAnalysisDataExport' => [ 'type' => 'structure', 'required' => [ 'OutputSchemaVersion', 'Destination', ], 'members' => [ 'OutputSchemaVersion' => [ 'shape' => 'StorageClassAnalysisSchemaVersion', ], 'Destination' => [ 'shape' => 'AnalyticsExportDestination', ], ], ], 'StorageClassAnalysisSchemaVersion' => [ 'type' => 'string', 'enum' => [ 'V_1', ], ], 'Suffix' => [ 'type' => 'string', ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'ObjectKey', ], 'Value' => [ 'shape' => 'Value', ], ], ], 'TagCount' => [ 'type' => 'integer', 'box' => true, ], 'TagSet' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', 'locationName' => 'Tag', ], ], 'Tagging' => [ 'type' => 'structure', 'required' => [ 'TagSet', ], 'members' => [ 'TagSet' => [ 'shape' => 'TagSet', ], ], ], 'TaggingDirective' => [ 'type' => 'string', 'enum' => [ 'COPY', 'REPLACE', ], ], 'TaggingHeader' => [ 'type' => 'string', ], 'TargetBucket' => [ 'type' => 'string', ], 'TargetGrant' => [ 'type' => 'structure', 'members' => [ 'Grantee' => [ 'shape' => 'Grantee', ], 'Permission' => [ 'shape' => 'BucketLogsPermission', ], ], ], 'TargetGrants' => [ 'type' => 'list', 'member' => [ 'shape' => 'TargetGrant', 'locationName' => 'Grant', ], ], 'TargetObjectKeyFormat' => [ 'type' => 'structure', 'members' => [ 'SimplePrefix' => [ 'shape' => 'SimplePrefix', 'locationName' => 'SimplePrefix', ], 'PartitionedPrefix' => [ 'shape' => 'PartitionedPrefix', 'locationName' => 'PartitionedPrefix', ], ], ], 'TargetPrefix' => [ 'type' => 'string', ], 'Tier' => [ 'type' => 'string', 'enum' => [ 'Standard', 'Bulk', 'Expedited', ], ], 'Tiering' => [ 'type' => 'structure', 'required' => [ 'Days', 'AccessTier', ], 'members' => [ 'Days' => [ 'shape' => 'IntelligentTieringDays', ], 'AccessTier' => [ 'shape' => 'IntelligentTieringAccessTier', ], ], ], 'TieringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tiering', ], 'flattened' => true, ], 'Token' => [ 'type' => 'string', ], 'TooManyParts' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'TopicArn' => [ 'type' => 'string', ], 'TopicConfiguration' => [ 'type' => 'structure', 'required' => [ 'TopicArn', 'Events', ], 'members' => [ 'Id' => [ 'shape' => 'NotificationId', ], 'TopicArn' => [ 'shape' => 'TopicArn', 'locationName' => 'Topic', ], 'Events' => [ 'shape' => 'EventList', 'locationName' => 'Event', ], 'Filter' => [ 'shape' => 'NotificationConfigurationFilter', ], ], ], 'TopicConfigurationDeprecated' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'NotificationId', ], 'Events' => [ 'shape' => 'EventList', 'locationName' => 'Event', ], 'Event' => [ 'shape' => 'Event', 'deprecated' => true, ], 'Topic' => [ 'shape' => 'TopicArn', ], ], ], 'TopicConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicConfiguration', ], 'flattened' => true, ], 'Transition' => [ 'type' => 'structure', 'members' => [ 'Date' => [ 'shape' => 'Date', ], 'Days' => [ 'shape' => 'Days', ], 'StorageClass' => [ 'shape' => 'TransitionStorageClass', ], ], ], 'TransitionDefaultMinimumObjectSize' => [ 'type' => 'string', 'enum' => [ 'varies_by_storage_class', 'all_storage_classes_128K', ], ], 'TransitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Transition', ], 'flattened' => true, ], 'TransitionStorageClass' => [ 'type' => 'string', 'enum' => [ 'GLACIER', 'STANDARD_IA', 'ONEZONE_IA', 'INTELLIGENT_TIERING', 'DEEP_ARCHIVE', 'GLACIER_IR', ], ], 'Type' => [ 'type' => 'string', 'enum' => [ 'CanonicalUser', 'AmazonCustomerByEmail', 'Group', ], ], 'URI' => [ 'type' => 'string', ], 'UploadIdMarker' => [ 'type' => 'string', ], 'UploadPartCopyOutput' => [ 'type' => 'structure', 'members' => [ 'CopySourceVersionId' => [ 'shape' => 'CopySourceVersionId', 'location' => 'header', 'locationName' => 'x-amz-copy-source-version-id', ], 'CopyPartResult' => [ 'shape' => 'CopyPartResult', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], 'payload' => 'CopyPartResult', ], 'UploadPartCopyRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'CopySource', 'Key', 'PartNumber', 'UploadId', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'CopySource' => [ 'shape' => 'CopySource', 'location' => 'header', 'locationName' => 'x-amz-copy-source', ], 'CopySourceIfMatch' => [ 'shape' => 'CopySourceIfMatch', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-match', ], 'CopySourceIfModifiedSince' => [ 'shape' => 'CopySourceIfModifiedSince', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-modified-since', ], 'CopySourceIfNoneMatch' => [ 'shape' => 'CopySourceIfNoneMatch', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-none-match', ], 'CopySourceIfUnmodifiedSince' => [ 'shape' => 'CopySourceIfUnmodifiedSince', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-unmodified-since', ], 'CopySourceRange' => [ 'shape' => 'CopySourceRange', 'location' => 'header', 'locationName' => 'x-amz-copy-source-range', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'PartNumber' => [ 'shape' => 'PartNumber', 'location' => 'querystring', 'locationName' => 'partNumber', ], 'UploadId' => [ 'shape' => 'MultipartUploadId', 'location' => 'querystring', 'locationName' => 'uploadId', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'CopySourceSSECustomerAlgorithm' => [ 'shape' => 'CopySourceSSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-copy-source-server-side-encryption-customer-algorithm', ], 'CopySourceSSECustomerKey' => [ 'shape' => 'CopySourceSSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-copy-source-server-side-encryption-customer-key', ], 'CopySourceSSECustomerKeyMD5' => [ 'shape' => 'CopySourceSSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-copy-source-server-side-encryption-customer-key-MD5', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ExpectedSourceBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-source-expected-bucket-owner', ], ], ], 'UploadPartOutput' => [ 'type' => 'structure', 'members' => [ 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'ETag' => [ 'shape' => 'ETag', 'location' => 'header', 'locationName' => 'ETag', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'UploadPartRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'PartNumber', 'UploadId', ], 'members' => [ 'Body' => [ 'shape' => 'Body', 'streaming' => true, ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentLength' => [ 'shape' => 'ContentLength', 'location' => 'header', 'locationName' => 'Content-Length', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'PartNumber' => [ 'shape' => 'PartNumber', 'location' => 'querystring', 'locationName' => 'partNumber', ], 'UploadId' => [ 'shape' => 'MultipartUploadId', 'location' => 'querystring', 'locationName' => 'uploadId', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'Body', ], 'UserMetadata' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetadataEntry', 'locationName' => 'MetadataEntry', ], ], 'Value' => [ 'type' => 'string', ], 'VersionCount' => [ 'type' => 'integer', 'box' => true, ], 'VersionIdMarker' => [ 'type' => 'string', ], 'VersioningConfiguration' => [ 'type' => 'structure', 'members' => [ 'MFADelete' => [ 'shape' => 'MFADelete', 'locationName' => 'MfaDelete', ], 'Status' => [ 'shape' => 'BucketVersioningStatus', ], ], ], 'WebsiteConfiguration' => [ 'type' => 'structure', 'members' => [ 'ErrorDocument' => [ 'shape' => 'ErrorDocument', ], 'IndexDocument' => [ 'shape' => 'IndexDocument', ], 'RedirectAllRequestsTo' => [ 'shape' => 'RedirectAllRequestsTo', ], 'RoutingRules' => [ 'shape' => 'RoutingRules', ], ], ], 'WebsiteRedirectLocation' => [ 'type' => 'string', ], 'WriteGetObjectResponseRequest' => [ 'type' => 'structure', 'required' => [ 'RequestRoute', 'RequestToken', ], 'members' => [ 'RequestRoute' => [ 'shape' => 'RequestRoute', 'hostLabel' => true, 'location' => 'header', 'locationName' => 'x-amz-request-route', ], 'RequestToken' => [ 'shape' => 'RequestToken', 'location' => 'header', 'locationName' => 'x-amz-request-token', ], 'Body' => [ 'shape' => 'Body', 'streaming' => true, ], 'StatusCode' => [ 'shape' => 'GetObjectResponseStatusCode', 'location' => 'header', 'locationName' => 'x-amz-fwd-status', ], 'ErrorCode' => [ 'shape' => 'ErrorCode', 'location' => 'header', 'locationName' => 'x-amz-fwd-error-code', ], 'ErrorMessage' => [ 'shape' => 'ErrorMessage', 'location' => 'header', 'locationName' => 'x-amz-fwd-error-message', ], 'AcceptRanges' => [ 'shape' => 'AcceptRanges', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-accept-ranges', ], 'CacheControl' => [ 'shape' => 'CacheControl', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Cache-Control', ], 'ContentDisposition' => [ 'shape' => 'ContentDisposition', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Content-Disposition', ], 'ContentEncoding' => [ 'shape' => 'ContentEncoding', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Content-Encoding', ], 'ContentLanguage' => [ 'shape' => 'ContentLanguage', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Content-Language', ], 'ContentLength' => [ 'shape' => 'ContentLength', 'location' => 'header', 'locationName' => 'Content-Length', ], 'ContentRange' => [ 'shape' => 'ContentRange', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Content-Range', ], 'ContentType' => [ 'shape' => 'ContentType', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Content-Type', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-checksum-sha256', ], 'DeleteMarker' => [ 'shape' => 'DeleteMarker', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-delete-marker', ], 'ETag' => [ 'shape' => 'ETag', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-ETag', ], 'Expires' => [ 'shape' => 'Expires', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Expires', ], 'Expiration' => [ 'shape' => 'Expiration', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-expiration', ], 'LastModified' => [ 'shape' => 'LastModified', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Last-Modified', ], 'MissingMeta' => [ 'shape' => 'MissingMeta', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-missing-meta', ], 'Metadata' => [ 'shape' => 'Metadata', 'location' => 'headers', 'locationName' => 'x-amz-meta-', ], 'ObjectLockMode' => [ 'shape' => 'ObjectLockMode', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-object-lock-mode', ], 'ObjectLockLegalHoldStatus' => [ 'shape' => 'ObjectLockLegalHoldStatus', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-object-lock-legal-hold', ], 'ObjectLockRetainUntilDate' => [ 'shape' => 'ObjectLockRetainUntilDate', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-object-lock-retain-until-date', ], 'PartsCount' => [ 'shape' => 'PartsCount', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-mp-parts-count', ], 'ReplicationStatus' => [ 'shape' => 'ReplicationStatus', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-replication-status', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-request-charged', ], 'Restore' => [ 'shape' => 'Restore', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-restore', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-server-side-encryption', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-server-side-encryption-customer-algorithm', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-server-side-encryption-aws-kms-key-id', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-server-side-encryption-customer-key-MD5', ], 'StorageClass' => [ 'shape' => 'StorageClass', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-storage-class', ], 'TagCount' => [ 'shape' => 'TagCount', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-tagging-count', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-version-id', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-server-side-encryption-bucket-key-enabled', ], ], 'payload' => 'Body', ], 'WriteOffsetBytes' => [ 'type' => 'long', 'box' => true, ], 'Years' => [ 'type' => 'integer', 'box' => true, ], ], 'clientContextParams' => [ 'Accelerate' => [ 'documentation' => 'Enables this client to use S3 Transfer Acceleration endpoints.', 'type' => 'boolean', ], 'DisableMultiRegionAccessPoints' => [ 'documentation' => 'Disables this client\'s usage of Multi-Region Access Points.', 'type' => 'boolean', ], 'DisableS3ExpressSessionAuth' => [ 'documentation' => 'Disables this client\'s usage of Session Auth for S3Express buckets and reverts to using conventional SigV4 for those.', 'type' => 'boolean', ], 'ForcePathStyle' => [ 'documentation' => 'Forces this client to use path-style addressing for buckets.', 'type' => 'boolean', ], 'UseArnRegion' => [ 'documentation' => 'Enables this client to use an ARN\'s region when constructing an endpoint instead of the client\'s configured region.', 'type' => 'boolean', ], ],]; +return [ 'version' => '2.0', 'metadata' => [ 'apiVersion' => '2006-03-01', 'checksumFormat' => 'md5', 'endpointPrefix' => 's3', 'globalEndpoint' => 's3.amazonaws.com', 'protocol' => 'rest-xml', 'protocols' => [ 'rest-xml', ], 'serviceAbbreviation' => 'Amazon S3', 'serviceFullName' => 'Amazon Simple Storage Service', 'serviceId' => 'S3', 'signatureVersion' => 's3', 'uid' => 's3-2006-03-01', 'auth' => [ 'aws.auth#sigv4', ], ], 'operations' => [ 'AbortMultipartUpload' => [ 'name' => 'AbortMultipartUpload', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}/{Key+}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'AbortMultipartUploadRequest', ], 'output' => [ 'shape' => 'AbortMultipartUploadOutput', ], 'errors' => [ [ 'shape' => 'NoSuchUpload', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadAbort.html', ], 'CompleteMultipartUpload' => [ 'name' => 'CompleteMultipartUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'CompleteMultipartUploadRequest', ], 'output' => [ 'shape' => 'CompleteMultipartUploadOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadComplete.html', ], 'CopyObject' => [ 'name' => 'CopyObject', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'CopyObjectRequest', ], 'output' => [ 'shape' => 'CopyObjectOutput', ], 'errors' => [ [ 'shape' => 'ObjectNotInActiveTierError', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectCOPY.html', 'alias' => 'PutObjectCopy', 'staticContextParams' => [ 'DisableS3ExpressSessionAuth' => [ 'value' => true, ], ], ], 'CreateBucket' => [ 'name' => 'CreateBucket', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}', ], 'input' => [ 'shape' => 'CreateBucketRequest', ], 'output' => [ 'shape' => 'CreateBucketOutput', ], 'errors' => [ [ 'shape' => 'BucketAlreadyExists', ], [ 'shape' => 'BucketAlreadyOwnedByYou', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUT.html', 'alias' => 'PutBucket', 'staticContextParams' => [ 'DisableAccessPoints' => [ 'value' => true, ], 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'CreateMultipartUpload' => [ 'name' => 'CreateMultipartUpload', 'http' => [ 'method' => 'POST', 'requestUri' => '/{Bucket}/{Key+}?uploads', ], 'input' => [ 'shape' => 'CreateMultipartUploadRequest', ], 'output' => [ 'shape' => 'CreateMultipartUploadOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadInitiate.html', 'alias' => 'InitiateMultipartUpload', ], 'CreateSession' => [ 'name' => 'CreateSession', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?session', ], 'input' => [ 'shape' => 'CreateSessionRequest', ], 'output' => [ 'shape' => 'CreateSessionOutput', ], 'errors' => [ [ 'shape' => 'NoSuchBucket', ], ], 'staticContextParams' => [ 'DisableS3ExpressSessionAuth' => [ 'value' => true, ], ], ], 'DeleteBucket' => [ 'name' => 'DeleteBucket', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETE.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketAnalyticsConfiguration' => [ 'name' => 'DeleteBucketAnalyticsConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?analytics', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketAnalyticsConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketCors' => [ 'name' => 'DeleteBucketCors', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?cors', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketCorsRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEcors.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketEncryption' => [ 'name' => 'DeleteBucketEncryption', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?encryption', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketEncryptionRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketIntelligentTieringConfiguration' => [ 'name' => 'DeleteBucketIntelligentTieringConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?intelligent-tiering', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketIntelligentTieringConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketInventoryConfiguration' => [ 'name' => 'DeleteBucketInventoryConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?inventory', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketInventoryConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketLifecycle' => [ 'name' => 'DeleteBucketLifecycle', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?lifecycle', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketLifecycleRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETElifecycle.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketMetricsConfiguration' => [ 'name' => 'DeleteBucketMetricsConfiguration', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?metrics', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketMetricsConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketOwnershipControls' => [ 'name' => 'DeleteBucketOwnershipControls', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?ownershipControls', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketOwnershipControlsRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketPolicy' => [ 'name' => 'DeleteBucketPolicy', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?policy', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketPolicyRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEpolicy.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketReplication' => [ 'name' => 'DeleteBucketReplication', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?replication', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketReplicationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketTagging' => [ 'name' => 'DeleteBucketTagging', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?tagging', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketTaggingRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEtagging.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteBucketWebsite' => [ 'name' => 'DeleteBucketWebsite', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?website', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteBucketWebsiteRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketDELETEwebsite.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'DeleteObject' => [ 'name' => 'DeleteObject', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}/{Key+}', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteObjectRequest', ], 'output' => [ 'shape' => 'DeleteObjectOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectDELETE.html', ], 'DeleteObjectTagging' => [ 'name' => 'DeleteObjectTagging', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}/{Key+}?tagging', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeleteObjectTaggingRequest', ], 'output' => [ 'shape' => 'DeleteObjectTaggingOutput', ], ], 'DeleteObjects' => [ 'name' => 'DeleteObjects', 'http' => [ 'method' => 'POST', 'requestUri' => '/{Bucket}?delete', ], 'input' => [ 'shape' => 'DeleteObjectsRequest', ], 'output' => [ 'shape' => 'DeleteObjectsOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/multiobjectdeleteapi.html', 'alias' => 'DeleteMultipleObjects', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], ], 'DeletePublicAccessBlock' => [ 'name' => 'DeletePublicAccessBlock', 'http' => [ 'method' => 'DELETE', 'requestUri' => '/{Bucket}?publicAccessBlock', 'responseCode' => 204, ], 'input' => [ 'shape' => 'DeletePublicAccessBlockRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketAccelerateConfiguration' => [ 'name' => 'GetBucketAccelerateConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?accelerate', ], 'input' => [ 'shape' => 'GetBucketAccelerateConfigurationRequest', ], 'output' => [ 'shape' => 'GetBucketAccelerateConfigurationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketAcl' => [ 'name' => 'GetBucketAcl', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?acl', ], 'input' => [ 'shape' => 'GetBucketAclRequest', ], 'output' => [ 'shape' => 'GetBucketAclOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETacl.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketAnalyticsConfiguration' => [ 'name' => 'GetBucketAnalyticsConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?analytics', ], 'input' => [ 'shape' => 'GetBucketAnalyticsConfigurationRequest', ], 'output' => [ 'shape' => 'GetBucketAnalyticsConfigurationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketCors' => [ 'name' => 'GetBucketCors', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?cors', ], 'input' => [ 'shape' => 'GetBucketCorsRequest', ], 'output' => [ 'shape' => 'GetBucketCorsOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETcors.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketEncryption' => [ 'name' => 'GetBucketEncryption', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?encryption', ], 'input' => [ 'shape' => 'GetBucketEncryptionRequest', ], 'output' => [ 'shape' => 'GetBucketEncryptionOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketIntelligentTieringConfiguration' => [ 'name' => 'GetBucketIntelligentTieringConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?intelligent-tiering', ], 'input' => [ 'shape' => 'GetBucketIntelligentTieringConfigurationRequest', ], 'output' => [ 'shape' => 'GetBucketIntelligentTieringConfigurationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketInventoryConfiguration' => [ 'name' => 'GetBucketInventoryConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?inventory', ], 'input' => [ 'shape' => 'GetBucketInventoryConfigurationRequest', ], 'output' => [ 'shape' => 'GetBucketInventoryConfigurationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketLifecycle' => [ 'name' => 'GetBucketLifecycle', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?lifecycle', ], 'input' => [ 'shape' => 'GetBucketLifecycleRequest', ], 'output' => [ 'shape' => 'GetBucketLifecycleOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlifecycle.html', 'deprecated' => true, 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketLifecycleConfiguration' => [ 'name' => 'GetBucketLifecycleConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?lifecycle', ], 'input' => [ 'shape' => 'GetBucketLifecycleConfigurationRequest', ], 'output' => [ 'shape' => 'GetBucketLifecycleConfigurationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketLocation' => [ 'name' => 'GetBucketLocation', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?location', ], 'input' => [ 'shape' => 'GetBucketLocationRequest', ], 'output' => [ 'shape' => 'GetBucketLocationOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlocation.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketLogging' => [ 'name' => 'GetBucketLogging', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?logging', ], 'input' => [ 'shape' => 'GetBucketLoggingRequest', ], 'output' => [ 'shape' => 'GetBucketLoggingOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETlogging.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketMetricsConfiguration' => [ 'name' => 'GetBucketMetricsConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?metrics', ], 'input' => [ 'shape' => 'GetBucketMetricsConfigurationRequest', ], 'output' => [ 'shape' => 'GetBucketMetricsConfigurationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketNotification' => [ 'name' => 'GetBucketNotification', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?notification', ], 'input' => [ 'shape' => 'GetBucketNotificationConfigurationRequest', ], 'output' => [ 'shape' => 'NotificationConfigurationDeprecated', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETnotification.html', 'deprecated' => true, 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketNotificationConfiguration' => [ 'name' => 'GetBucketNotificationConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?notification', ], 'input' => [ 'shape' => 'GetBucketNotificationConfigurationRequest', ], 'output' => [ 'shape' => 'NotificationConfiguration', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketOwnershipControls' => [ 'name' => 'GetBucketOwnershipControls', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?ownershipControls', ], 'input' => [ 'shape' => 'GetBucketOwnershipControlsRequest', ], 'output' => [ 'shape' => 'GetBucketOwnershipControlsOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketPolicy' => [ 'name' => 'GetBucketPolicy', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?policy', ], 'input' => [ 'shape' => 'GetBucketPolicyRequest', ], 'output' => [ 'shape' => 'GetBucketPolicyOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETpolicy.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketPolicyStatus' => [ 'name' => 'GetBucketPolicyStatus', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?policyStatus', ], 'input' => [ 'shape' => 'GetBucketPolicyStatusRequest', ], 'output' => [ 'shape' => 'GetBucketPolicyStatusOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketReplication' => [ 'name' => 'GetBucketReplication', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?replication', ], 'input' => [ 'shape' => 'GetBucketReplicationRequest', ], 'output' => [ 'shape' => 'GetBucketReplicationOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketRequestPayment' => [ 'name' => 'GetBucketRequestPayment', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?requestPayment', ], 'input' => [ 'shape' => 'GetBucketRequestPaymentRequest', ], 'output' => [ 'shape' => 'GetBucketRequestPaymentOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentGET.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketTagging' => [ 'name' => 'GetBucketTagging', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?tagging', ], 'input' => [ 'shape' => 'GetBucketTaggingRequest', ], 'output' => [ 'shape' => 'GetBucketTaggingOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETtagging.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketVersioning' => [ 'name' => 'GetBucketVersioning', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?versioning', ], 'input' => [ 'shape' => 'GetBucketVersioningRequest', ], 'output' => [ 'shape' => 'GetBucketVersioningOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETversioningStatus.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetBucketWebsite' => [ 'name' => 'GetBucketWebsite', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?website', ], 'input' => [ 'shape' => 'GetBucketWebsiteRequest', ], 'output' => [ 'shape' => 'GetBucketWebsiteOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETwebsite.html', 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'GetObject' => [ 'name' => 'GetObject', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'GetObjectRequest', ], 'output' => [ 'shape' => 'GetObjectOutput', ], 'errors' => [ [ 'shape' => 'NoSuchKey', ], [ 'shape' => 'InvalidObjectState', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGET.html', 'httpChecksum' => [ 'requestValidationModeMember' => 'ChecksumMode', 'responseAlgorithms' => [ 'CRC32', 'CRC32C', 'SHA256', 'SHA1', ], ], ], 'GetObjectAcl' => [ 'name' => 'GetObjectAcl', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}?acl', ], 'input' => [ 'shape' => 'GetObjectAclRequest', ], 'output' => [ 'shape' => 'GetObjectAclOutput', ], 'errors' => [ [ 'shape' => 'NoSuchKey', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETacl.html', ], 'GetObjectAttributes' => [ 'name' => 'GetObjectAttributes', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}?attributes', ], 'input' => [ 'shape' => 'GetObjectAttributesRequest', ], 'output' => [ 'shape' => 'GetObjectAttributesOutput', ], 'errors' => [ [ 'shape' => 'NoSuchKey', ], ], ], 'GetObjectLegalHold' => [ 'name' => 'GetObjectLegalHold', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}?legal-hold', ], 'input' => [ 'shape' => 'GetObjectLegalHoldRequest', ], 'output' => [ 'shape' => 'GetObjectLegalHoldOutput', ], ], 'GetObjectLockConfiguration' => [ 'name' => 'GetObjectLockConfiguration', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?object-lock', ], 'input' => [ 'shape' => 'GetObjectLockConfigurationRequest', ], 'output' => [ 'shape' => 'GetObjectLockConfigurationOutput', ], ], 'GetObjectRetention' => [ 'name' => 'GetObjectRetention', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}?retention', ], 'input' => [ 'shape' => 'GetObjectRetentionRequest', ], 'output' => [ 'shape' => 'GetObjectRetentionOutput', ], ], 'GetObjectTagging' => [ 'name' => 'GetObjectTagging', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}?tagging', ], 'input' => [ 'shape' => 'GetObjectTaggingRequest', ], 'output' => [ 'shape' => 'GetObjectTaggingOutput', ], ], 'GetObjectTorrent' => [ 'name' => 'GetObjectTorrent', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}?torrent', ], 'input' => [ 'shape' => 'GetObjectTorrentRequest', ], 'output' => [ 'shape' => 'GetObjectTorrentOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectGETtorrent.html', ], 'GetPublicAccessBlock' => [ 'name' => 'GetPublicAccessBlock', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?publicAccessBlock', ], 'input' => [ 'shape' => 'GetPublicAccessBlockRequest', ], 'output' => [ 'shape' => 'GetPublicAccessBlockOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'HeadBucket' => [ 'name' => 'HeadBucket', 'http' => [ 'method' => 'HEAD', 'requestUri' => '/{Bucket}', ], 'input' => [ 'shape' => 'HeadBucketRequest', ], 'output' => [ 'shape' => 'HeadBucketOutput', ], 'errors' => [ [ 'shape' => 'NoSuchBucket', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketHEAD.html', ], 'HeadObject' => [ 'name' => 'HeadObject', 'http' => [ 'method' => 'HEAD', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'HeadObjectRequest', ], 'output' => [ 'shape' => 'HeadObjectOutput', ], 'errors' => [ [ 'shape' => 'NoSuchKey', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectHEAD.html', ], 'ListBucketAnalyticsConfigurations' => [ 'name' => 'ListBucketAnalyticsConfigurations', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?analytics', ], 'input' => [ 'shape' => 'ListBucketAnalyticsConfigurationsRequest', ], 'output' => [ 'shape' => 'ListBucketAnalyticsConfigurationsOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'ListBucketIntelligentTieringConfigurations' => [ 'name' => 'ListBucketIntelligentTieringConfigurations', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?intelligent-tiering', ], 'input' => [ 'shape' => 'ListBucketIntelligentTieringConfigurationsRequest', ], 'output' => [ 'shape' => 'ListBucketIntelligentTieringConfigurationsOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'ListBucketInventoryConfigurations' => [ 'name' => 'ListBucketInventoryConfigurations', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?inventory', ], 'input' => [ 'shape' => 'ListBucketInventoryConfigurationsRequest', ], 'output' => [ 'shape' => 'ListBucketInventoryConfigurationsOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'ListBucketMetricsConfigurations' => [ 'name' => 'ListBucketMetricsConfigurations', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?metrics', ], 'input' => [ 'shape' => 'ListBucketMetricsConfigurationsRequest', ], 'output' => [ 'shape' => 'ListBucketMetricsConfigurationsOutput', ], ], 'ListBuckets' => [ 'name' => 'ListBuckets', 'http' => [ 'method' => 'GET', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListBucketsRequest', ], 'output' => [ 'shape' => 'ListBucketsOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTServiceGET.html', 'alias' => 'GetService', ], 'ListDirectoryBuckets' => [ 'name' => 'ListDirectoryBuckets', 'http' => [ 'method' => 'GET', 'requestUri' => '/', ], 'input' => [ 'shape' => 'ListDirectoryBucketsRequest', ], 'output' => [ 'shape' => 'ListDirectoryBucketsOutput', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'ListMultipartUploads' => [ 'name' => 'ListMultipartUploads', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?uploads', ], 'input' => [ 'shape' => 'ListMultipartUploadsRequest', ], 'output' => [ 'shape' => 'ListMultipartUploadsOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListMPUpload.html', ], 'ListObjectVersions' => [ 'name' => 'ListObjectVersions', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?versions', ], 'input' => [ 'shape' => 'ListObjectVersionsRequest', ], 'output' => [ 'shape' => 'ListObjectVersionsOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGETVersion.html', 'alias' => 'GetBucketObjectVersions', ], 'ListObjects' => [ 'name' => 'ListObjects', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}', ], 'input' => [ 'shape' => 'ListObjectsRequest', ], 'output' => [ 'shape' => 'ListObjectsOutput', ], 'errors' => [ [ 'shape' => 'NoSuchBucket', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketGET.html', 'alias' => 'GetBucket', ], 'ListObjectsV2' => [ 'name' => 'ListObjectsV2', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}?list-type=2', ], 'input' => [ 'shape' => 'ListObjectsV2Request', ], 'output' => [ 'shape' => 'ListObjectsV2Output', ], 'errors' => [ [ 'shape' => 'NoSuchBucket', ], ], ], 'ListParts' => [ 'name' => 'ListParts', 'http' => [ 'method' => 'GET', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'ListPartsRequest', ], 'output' => [ 'shape' => 'ListPartsOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadListParts.html', ], 'PutBucketAccelerateConfiguration' => [ 'name' => 'PutBucketAccelerateConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?accelerate', ], 'input' => [ 'shape' => 'PutBucketAccelerateConfigurationRequest', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => false, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketAcl' => [ 'name' => 'PutBucketAcl', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?acl', ], 'input' => [ 'shape' => 'PutBucketAclRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTacl.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketAnalyticsConfiguration' => [ 'name' => 'PutBucketAnalyticsConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?analytics', ], 'input' => [ 'shape' => 'PutBucketAnalyticsConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketCors' => [ 'name' => 'PutBucketCors', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?cors', ], 'input' => [ 'shape' => 'PutBucketCorsRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTcors.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketEncryption' => [ 'name' => 'PutBucketEncryption', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?encryption', ], 'input' => [ 'shape' => 'PutBucketEncryptionRequest', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketIntelligentTieringConfiguration' => [ 'name' => 'PutBucketIntelligentTieringConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?intelligent-tiering', ], 'input' => [ 'shape' => 'PutBucketIntelligentTieringConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketInventoryConfiguration' => [ 'name' => 'PutBucketInventoryConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?inventory', ], 'input' => [ 'shape' => 'PutBucketInventoryConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketLifecycle' => [ 'name' => 'PutBucketLifecycle', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?lifecycle', ], 'input' => [ 'shape' => 'PutBucketLifecycleRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlifecycle.html', 'deprecated' => true, 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketLifecycleConfiguration' => [ 'name' => 'PutBucketLifecycleConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?lifecycle', ], 'input' => [ 'shape' => 'PutBucketLifecycleConfigurationRequest', ], 'output' => [ 'shape' => 'PutBucketLifecycleConfigurationOutput', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketLogging' => [ 'name' => 'PutBucketLogging', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?logging', ], 'input' => [ 'shape' => 'PutBucketLoggingRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTlogging.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketMetricsConfiguration' => [ 'name' => 'PutBucketMetricsConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?metrics', ], 'input' => [ 'shape' => 'PutBucketMetricsConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketNotification' => [ 'name' => 'PutBucketNotification', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?notification', ], 'input' => [ 'shape' => 'PutBucketNotificationRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTnotification.html', 'deprecated' => true, 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketNotificationConfiguration' => [ 'name' => 'PutBucketNotificationConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?notification', ], 'input' => [ 'shape' => 'PutBucketNotificationConfigurationRequest', ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketOwnershipControls' => [ 'name' => 'PutBucketOwnershipControls', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?ownershipControls', ], 'input' => [ 'shape' => 'PutBucketOwnershipControlsRequest', ], 'httpChecksum' => [ 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketPolicy' => [ 'name' => 'PutBucketPolicy', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?policy', ], 'input' => [ 'shape' => 'PutBucketPolicyRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTpolicy.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketReplication' => [ 'name' => 'PutBucketReplication', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?replication', ], 'input' => [ 'shape' => 'PutBucketReplicationRequest', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketRequestPayment' => [ 'name' => 'PutBucketRequestPayment', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?requestPayment', ], 'input' => [ 'shape' => 'PutBucketRequestPaymentRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTrequestPaymentPUT.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketTagging' => [ 'name' => 'PutBucketTagging', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?tagging', ], 'input' => [ 'shape' => 'PutBucketTaggingRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTtagging.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketVersioning' => [ 'name' => 'PutBucketVersioning', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?versioning', ], 'input' => [ 'shape' => 'PutBucketVersioningRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTVersioningStatus.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutBucketWebsite' => [ 'name' => 'PutBucketWebsite', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?website', ], 'input' => [ 'shape' => 'PutBucketWebsiteRequest', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTBucketPUTwebsite.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'PutObject' => [ 'name' => 'PutObject', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'PutObjectRequest', ], 'output' => [ 'shape' => 'PutObjectOutput', ], 'errors' => [ [ 'shape' => 'InvalidRequest', ], [ 'shape' => 'InvalidWriteOffset', ], [ 'shape' => 'TooManyParts', ], [ 'shape' => 'EncryptionTypeMismatch', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUT.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => false, ], ], 'PutObjectAcl' => [ 'name' => 'PutObjectAcl', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}?acl', ], 'input' => [ 'shape' => 'PutObjectAclRequest', ], 'output' => [ 'shape' => 'PutObjectAclOutput', ], 'errors' => [ [ 'shape' => 'NoSuchKey', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectPUTacl.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], ], 'PutObjectLegalHold' => [ 'name' => 'PutObjectLegalHold', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}?legal-hold', ], 'input' => [ 'shape' => 'PutObjectLegalHoldRequest', ], 'output' => [ 'shape' => 'PutObjectLegalHoldOutput', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], ], 'PutObjectLockConfiguration' => [ 'name' => 'PutObjectLockConfiguration', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?object-lock', ], 'input' => [ 'shape' => 'PutObjectLockConfigurationRequest', ], 'output' => [ 'shape' => 'PutObjectLockConfigurationOutput', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], ], 'PutObjectRetention' => [ 'name' => 'PutObjectRetention', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}?retention', ], 'input' => [ 'shape' => 'PutObjectRetentionRequest', ], 'output' => [ 'shape' => 'PutObjectRetentionOutput', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], ], 'PutObjectTagging' => [ 'name' => 'PutObjectTagging', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}?tagging', ], 'input' => [ 'shape' => 'PutObjectTaggingRequest', ], 'output' => [ 'shape' => 'PutObjectTaggingOutput', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], ], 'PutPublicAccessBlock' => [ 'name' => 'PutPublicAccessBlock', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}?publicAccessBlock', ], 'input' => [ 'shape' => 'PutPublicAccessBlockRequest', ], 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => true, ], 'staticContextParams' => [ 'UseS3ExpressControlEndpoint' => [ 'value' => true, ], ], ], 'RestoreObject' => [ 'name' => 'RestoreObject', 'http' => [ 'method' => 'POST', 'requestUri' => '/{Bucket}/{Key+}?restore', ], 'input' => [ 'shape' => 'RestoreObjectRequest', ], 'output' => [ 'shape' => 'RestoreObjectOutput', ], 'errors' => [ [ 'shape' => 'ObjectAlreadyInActiveTierError', ], ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/RESTObjectRestore.html', 'alias' => 'PostObjectRestore', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => false, ], ], 'SelectObjectContent' => [ 'name' => 'SelectObjectContent', 'http' => [ 'method' => 'POST', 'requestUri' => '/{Bucket}/{Key+}?select&select-type=2', ], 'input' => [ 'shape' => 'SelectObjectContentRequest', 'locationName' => 'SelectObjectContentRequest', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'output' => [ 'shape' => 'SelectObjectContentOutput', ], ], 'UploadPart' => [ 'name' => 'UploadPart', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'UploadPartRequest', ], 'output' => [ 'shape' => 'UploadPartOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPart.html', 'httpChecksum' => [ 'requestAlgorithmMember' => 'ChecksumAlgorithm', 'requestChecksumRequired' => false, ], ], 'UploadPartCopy' => [ 'name' => 'UploadPartCopy', 'http' => [ 'method' => 'PUT', 'requestUri' => '/{Bucket}/{Key+}', ], 'input' => [ 'shape' => 'UploadPartCopyRequest', ], 'output' => [ 'shape' => 'UploadPartCopyOutput', ], 'documentationUrl' => 'http://docs.amazonwebservices.com/AmazonS3/latest/API/mpUploadUploadPartCopy.html', 'staticContextParams' => [ 'DisableS3ExpressSessionAuth' => [ 'value' => true, ], ], ], 'WriteGetObjectResponse' => [ 'name' => 'WriteGetObjectResponse', 'http' => [ 'method' => 'POST', 'requestUri' => '/WriteGetObjectResponse', ], 'input' => [ 'shape' => 'WriteGetObjectResponseRequest', ], 'authtype' => 'v4-unsigned-body', 'endpoint' => [ 'hostPrefix' => '{RequestRoute}.', ], 'staticContextParams' => [ 'UseObjectLambdaEndpoint' => [ 'value' => true, ], ], 'unsignedPayload' => true, ], ], 'shapes' => [ 'AbortDate' => [ 'type' => 'timestamp', ], 'AbortIncompleteMultipartUpload' => [ 'type' => 'structure', 'members' => [ 'DaysAfterInitiation' => [ 'shape' => 'DaysAfterInitiation', ], ], ], 'AbortMultipartUploadOutput' => [ 'type' => 'structure', 'members' => [ 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'AbortMultipartUploadRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'UploadId', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'UploadId' => [ 'shape' => 'MultipartUploadId', 'location' => 'querystring', 'locationName' => 'uploadId', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'IfMatchInitiatedTime' => [ 'shape' => 'IfMatchInitiatedTime', 'location' => 'header', 'locationName' => 'x-amz-if-match-initiated-time', ], ], ], 'AbortRuleId' => [ 'type' => 'string', ], 'AccelerateConfiguration' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'BucketAccelerateStatus', ], ], ], 'AcceptRanges' => [ 'type' => 'string', ], 'AccessControlPolicy' => [ 'type' => 'structure', 'members' => [ 'Grants' => [ 'shape' => 'Grants', 'locationName' => 'AccessControlList', ], 'Owner' => [ 'shape' => 'Owner', ], ], ], 'AccessControlTranslation' => [ 'type' => 'structure', 'required' => [ 'Owner', ], 'members' => [ 'Owner' => [ 'shape' => 'OwnerOverride', ], ], ], 'AccessKeyIdValue' => [ 'type' => 'string', ], 'AccessPointAlias' => [ 'type' => 'boolean', 'box' => true, ], 'AccessPointArn' => [ 'type' => 'string', ], 'AccountId' => [ 'type' => 'string', ], 'AllowQuotedRecordDelimiter' => [ 'type' => 'boolean', 'box' => true, ], 'AllowedHeader' => [ 'type' => 'string', ], 'AllowedHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'AllowedHeader', ], 'flattened' => true, ], 'AllowedMethod' => [ 'type' => 'string', ], 'AllowedMethods' => [ 'type' => 'list', 'member' => [ 'shape' => 'AllowedMethod', ], 'flattened' => true, ], 'AllowedOrigin' => [ 'type' => 'string', ], 'AllowedOrigins' => [ 'type' => 'list', 'member' => [ 'shape' => 'AllowedOrigin', ], 'flattened' => true, ], 'AnalyticsAndOperator' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tags' => [ 'shape' => 'TagSet', 'flattened' => true, 'locationName' => 'Tag', ], ], ], 'AnalyticsConfiguration' => [ 'type' => 'structure', 'required' => [ 'Id', 'StorageClassAnalysis', ], 'members' => [ 'Id' => [ 'shape' => 'AnalyticsId', ], 'Filter' => [ 'shape' => 'AnalyticsFilter', ], 'StorageClassAnalysis' => [ 'shape' => 'StorageClassAnalysis', ], ], ], 'AnalyticsConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'AnalyticsConfiguration', ], 'flattened' => true, ], 'AnalyticsExportDestination' => [ 'type' => 'structure', 'required' => [ 'S3BucketDestination', ], 'members' => [ 'S3BucketDestination' => [ 'shape' => 'AnalyticsS3BucketDestination', ], ], ], 'AnalyticsFilter' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tag' => [ 'shape' => 'Tag', ], 'And' => [ 'shape' => 'AnalyticsAndOperator', ], ], ], 'AnalyticsId' => [ 'type' => 'string', ], 'AnalyticsS3BucketDestination' => [ 'type' => 'structure', 'required' => [ 'Format', 'Bucket', ], 'members' => [ 'Format' => [ 'shape' => 'AnalyticsS3ExportFileFormat', ], 'BucketAccountId' => [ 'shape' => 'AccountId', ], 'Bucket' => [ 'shape' => 'BucketName', ], 'Prefix' => [ 'shape' => 'Prefix', ], ], ], 'AnalyticsS3ExportFileFormat' => [ 'type' => 'string', 'enum' => [ 'CSV', ], ], 'ArchiveStatus' => [ 'type' => 'string', 'enum' => [ 'ARCHIVE_ACCESS', 'DEEP_ARCHIVE_ACCESS', ], ], 'Body' => [ 'type' => 'blob', ], 'Bucket' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'BucketName', ], 'CreationDate' => [ 'shape' => 'CreationDate', ], 'BucketRegion' => [ 'shape' => 'BucketRegion', ], ], ], 'BucketAccelerateStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Suspended', ], ], 'BucketAlreadyExists' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'BucketAlreadyOwnedByYou' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 409, ], 'exception' => true, ], 'BucketCannedACL' => [ 'type' => 'string', 'enum' => [ 'private', 'public-read', 'public-read-write', 'authenticated-read', ], ], 'BucketInfo' => [ 'type' => 'structure', 'members' => [ 'DataRedundancy' => [ 'shape' => 'DataRedundancy', ], 'Type' => [ 'shape' => 'BucketType', ], ], ], 'BucketKeyEnabled' => [ 'type' => 'boolean', 'box' => true, ], 'BucketLifecycleConfiguration' => [ 'type' => 'structure', 'required' => [ 'Rules', ], 'members' => [ 'Rules' => [ 'shape' => 'LifecycleRules', 'locationName' => 'Rule', ], ], ], 'BucketLocationConstraint' => [ 'type' => 'string', 'enum' => [ 'af-south-1', 'ap-east-1', 'ap-northeast-1', 'ap-northeast-2', 'ap-northeast-3', 'ap-south-1', 'ap-south-2', 'ap-southeast-1', 'ap-southeast-2', 'ap-southeast-3', 'ca-central-1', 'cn-north-1', 'cn-northwest-1', 'EU', 'eu-central-1', 'eu-north-1', 'eu-south-1', 'eu-south-2', 'eu-west-1', 'eu-west-2', 'eu-west-3', 'me-south-1', 'sa-east-1', 'us-east-2', 'us-gov-east-1', 'us-gov-west-1', 'us-west-1', 'us-west-2', ], ], 'BucketLocationName' => [ 'type' => 'string', ], 'BucketLoggingStatus' => [ 'type' => 'structure', 'members' => [ 'LoggingEnabled' => [ 'shape' => 'LoggingEnabled', ], ], ], 'BucketLogsPermission' => [ 'type' => 'string', 'enum' => [ 'FULL_CONTROL', 'READ', 'WRITE', ], ], 'BucketName' => [ 'type' => 'string', ], 'BucketRegion' => [ 'type' => 'string', ], 'BucketType' => [ 'type' => 'string', 'enum' => [ 'Directory', ], ], 'BucketVersioningStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Suspended', ], ], 'Buckets' => [ 'type' => 'list', 'member' => [ 'shape' => 'Bucket', 'locationName' => 'Bucket', ], ], 'BypassGovernanceRetention' => [ 'type' => 'boolean', 'box' => true, ], 'BytesProcessed' => [ 'type' => 'long', 'box' => true, ], 'BytesReturned' => [ 'type' => 'long', 'box' => true, ], 'BytesScanned' => [ 'type' => 'long', 'box' => true, ], 'CORSConfiguration' => [ 'type' => 'structure', 'required' => [ 'CORSRules', ], 'members' => [ 'CORSRules' => [ 'shape' => 'CORSRules', 'locationName' => 'CORSRule', ], ], ], 'CORSRule' => [ 'type' => 'structure', 'required' => [ 'AllowedMethods', 'AllowedOrigins', ], 'members' => [ 'ID' => [ 'shape' => 'ID', ], 'AllowedHeaders' => [ 'shape' => 'AllowedHeaders', 'locationName' => 'AllowedHeader', ], 'AllowedMethods' => [ 'shape' => 'AllowedMethods', 'locationName' => 'AllowedMethod', ], 'AllowedOrigins' => [ 'shape' => 'AllowedOrigins', 'locationName' => 'AllowedOrigin', ], 'ExposeHeaders' => [ 'shape' => 'ExposeHeaders', 'locationName' => 'ExposeHeader', ], 'MaxAgeSeconds' => [ 'shape' => 'MaxAgeSeconds', ], ], ], 'CORSRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'CORSRule', ], 'flattened' => true, ], 'CSVInput' => [ 'type' => 'structure', 'members' => [ 'FileHeaderInfo' => [ 'shape' => 'FileHeaderInfo', ], 'Comments' => [ 'shape' => 'Comments', ], 'QuoteEscapeCharacter' => [ 'shape' => 'QuoteEscapeCharacter', ], 'RecordDelimiter' => [ 'shape' => 'RecordDelimiter', ], 'FieldDelimiter' => [ 'shape' => 'FieldDelimiter', ], 'QuoteCharacter' => [ 'shape' => 'QuoteCharacter', ], 'AllowQuotedRecordDelimiter' => [ 'shape' => 'AllowQuotedRecordDelimiter', ], ], ], 'CSVOutput' => [ 'type' => 'structure', 'members' => [ 'QuoteFields' => [ 'shape' => 'QuoteFields', ], 'QuoteEscapeCharacter' => [ 'shape' => 'QuoteEscapeCharacter', ], 'RecordDelimiter' => [ 'shape' => 'RecordDelimiter', ], 'FieldDelimiter' => [ 'shape' => 'FieldDelimiter', ], 'QuoteCharacter' => [ 'shape' => 'QuoteCharacter', ], ], ], 'CacheControl' => [ 'type' => 'string', ], 'Checksum' => [ 'type' => 'structure', 'members' => [ 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], ], ], 'ChecksumAlgorithm' => [ 'type' => 'string', 'enum' => [ 'CRC32', 'CRC32C', 'SHA1', 'SHA256', ], ], 'ChecksumAlgorithmList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ChecksumAlgorithm', ], 'flattened' => true, ], 'ChecksumCRC32' => [ 'type' => 'string', ], 'ChecksumCRC32C' => [ 'type' => 'string', ], 'ChecksumMode' => [ 'type' => 'string', 'enum' => [ 'ENABLED', ], ], 'ChecksumSHA1' => [ 'type' => 'string', ], 'ChecksumSHA256' => [ 'type' => 'string', ], 'CloudFunction' => [ 'type' => 'string', ], 'CloudFunctionConfiguration' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'NotificationId', ], 'Event' => [ 'shape' => 'Event', 'deprecated' => true, ], 'Events' => [ 'shape' => 'EventList', 'locationName' => 'Event', ], 'CloudFunction' => [ 'shape' => 'CloudFunction', ], 'InvocationRole' => [ 'shape' => 'CloudFunctionInvocationRole', ], ], ], 'CloudFunctionInvocationRole' => [ 'type' => 'string', ], 'Code' => [ 'type' => 'string', ], 'Comments' => [ 'type' => 'string', ], 'CommonPrefix' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], ], ], 'CommonPrefixList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CommonPrefix', ], 'flattened' => true, ], 'CompleteMultipartUploadOutput' => [ 'type' => 'structure', 'members' => [ 'Location' => [ 'shape' => 'Location', ], 'Bucket' => [ 'shape' => 'BucketName', ], 'Key' => [ 'shape' => 'ObjectKey', ], 'Expiration' => [ 'shape' => 'Expiration', 'location' => 'header', 'locationName' => 'x-amz-expiration', ], 'ETag' => [ 'shape' => 'ETag', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'CompleteMultipartUploadRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'UploadId', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'MultipartUpload' => [ 'shape' => 'CompletedMultipartUpload', 'locationName' => 'CompleteMultipartUpload', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'UploadId' => [ 'shape' => 'MultipartUploadId', 'location' => 'querystring', 'locationName' => 'uploadId', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'IfMatch' => [ 'shape' => 'IfMatch', 'location' => 'header', 'locationName' => 'If-Match', ], 'IfNoneMatch' => [ 'shape' => 'IfNoneMatch', 'location' => 'header', 'locationName' => 'If-None-Match', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], ], 'payload' => 'MultipartUpload', ], 'CompletedMultipartUpload' => [ 'type' => 'structure', 'members' => [ 'Parts' => [ 'shape' => 'CompletedPartList', 'locationName' => 'Part', ], ], ], 'CompletedPart' => [ 'type' => 'structure', 'members' => [ 'ETag' => [ 'shape' => 'ETag', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], 'PartNumber' => [ 'shape' => 'PartNumber', ], ], ], 'CompletedPartList' => [ 'type' => 'list', 'member' => [ 'shape' => 'CompletedPart', ], 'flattened' => true, ], 'CompressionType' => [ 'type' => 'string', 'enum' => [ 'NONE', 'GZIP', 'BZIP2', ], ], 'Condition' => [ 'type' => 'structure', 'members' => [ 'HttpErrorCodeReturnedEquals' => [ 'shape' => 'HttpErrorCodeReturnedEquals', ], 'KeyPrefixEquals' => [ 'shape' => 'KeyPrefixEquals', ], ], ], 'ConfirmRemoveSelfBucketAccess' => [ 'type' => 'boolean', 'box' => true, ], 'ContentDisposition' => [ 'type' => 'string', ], 'ContentEncoding' => [ 'type' => 'string', ], 'ContentLanguage' => [ 'type' => 'string', ], 'ContentLength' => [ 'type' => 'long', ], 'ContentMD5' => [ 'type' => 'string', ], 'ContentRange' => [ 'type' => 'string', ], 'ContentType' => [ 'type' => 'string', ], 'ContinuationEvent' => [ 'type' => 'structure', 'members' => [], 'event' => true, ], 'CopyObjectOutput' => [ 'type' => 'structure', 'members' => [ 'CopyObjectResult' => [ 'shape' => 'CopyObjectResult', ], 'Expiration' => [ 'shape' => 'Expiration', 'location' => 'header', 'locationName' => 'x-amz-expiration', ], 'CopySourceVersionId' => [ 'shape' => 'CopySourceVersionId', 'location' => 'header', 'locationName' => 'x-amz-copy-source-version-id', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], 'payload' => 'CopyObjectResult', ], 'CopyObjectRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'CopySource', 'Key', ], 'members' => [ 'ACL' => [ 'shape' => 'ObjectCannedACL', 'location' => 'header', 'locationName' => 'x-amz-acl', ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'CacheControl' => [ 'shape' => 'CacheControl', 'location' => 'header', 'locationName' => 'Cache-Control', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-checksum-algorithm', ], 'ContentDisposition' => [ 'shape' => 'ContentDisposition', 'location' => 'header', 'locationName' => 'Content-Disposition', ], 'ContentEncoding' => [ 'shape' => 'ContentEncoding', 'location' => 'header', 'locationName' => 'Content-Encoding', ], 'ContentLanguage' => [ 'shape' => 'ContentLanguage', 'location' => 'header', 'locationName' => 'Content-Language', ], 'ContentType' => [ 'shape' => 'ContentType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'CopySource' => [ 'shape' => 'CopySource', 'contextParam' => [ 'name' => 'CopySource', ], 'location' => 'header', 'locationName' => 'x-amz-copy-source', ], 'CopySourceIfMatch' => [ 'shape' => 'CopySourceIfMatch', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-match', ], 'CopySourceIfModifiedSince' => [ 'shape' => 'CopySourceIfModifiedSince', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-modified-since', ], 'CopySourceIfNoneMatch' => [ 'shape' => 'CopySourceIfNoneMatch', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-none-match', ], 'CopySourceIfUnmodifiedSince' => [ 'shape' => 'CopySourceIfUnmodifiedSince', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-unmodified-since', ], 'Expires' => [ 'shape' => 'Expires', 'location' => 'header', 'locationName' => 'Expires', ], 'GrantFullControl' => [ 'shape' => 'GrantFullControl', 'location' => 'header', 'locationName' => 'x-amz-grant-full-control', ], 'GrantRead' => [ 'shape' => 'GrantRead', 'location' => 'header', 'locationName' => 'x-amz-grant-read', ], 'GrantReadACP' => [ 'shape' => 'GrantReadACP', 'location' => 'header', 'locationName' => 'x-amz-grant-read-acp', ], 'GrantWriteACP' => [ 'shape' => 'GrantWriteACP', 'location' => 'header', 'locationName' => 'x-amz-grant-write-acp', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'Metadata' => [ 'shape' => 'Metadata', 'location' => 'headers', 'locationName' => 'x-amz-meta-', ], 'MetadataDirective' => [ 'shape' => 'MetadataDirective', 'location' => 'header', 'locationName' => 'x-amz-metadata-directive', ], 'TaggingDirective' => [ 'shape' => 'TaggingDirective', 'location' => 'header', 'locationName' => 'x-amz-tagging-directive', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'StorageClass' => [ 'shape' => 'StorageClass', 'location' => 'header', 'locationName' => 'x-amz-storage-class', ], 'WebsiteRedirectLocation' => [ 'shape' => 'WebsiteRedirectLocation', 'location' => 'header', 'locationName' => 'x-amz-website-redirect-location', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'CopySourceSSECustomerAlgorithm' => [ 'shape' => 'CopySourceSSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-copy-source-server-side-encryption-customer-algorithm', ], 'CopySourceSSECustomerKey' => [ 'shape' => 'CopySourceSSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-copy-source-server-side-encryption-customer-key', ], 'CopySourceSSECustomerKeyMD5' => [ 'shape' => 'CopySourceSSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-copy-source-server-side-encryption-customer-key-MD5', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'Tagging' => [ 'shape' => 'TaggingHeader', 'location' => 'header', 'locationName' => 'x-amz-tagging', ], 'ObjectLockMode' => [ 'shape' => 'ObjectLockMode', 'location' => 'header', 'locationName' => 'x-amz-object-lock-mode', ], 'ObjectLockRetainUntilDate' => [ 'shape' => 'ObjectLockRetainUntilDate', 'location' => 'header', 'locationName' => 'x-amz-object-lock-retain-until-date', ], 'ObjectLockLegalHoldStatus' => [ 'shape' => 'ObjectLockLegalHoldStatus', 'location' => 'header', 'locationName' => 'x-amz-object-lock-legal-hold', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ExpectedSourceBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-source-expected-bucket-owner', ], ], ], 'CopyObjectResult' => [ 'type' => 'structure', 'members' => [ 'ETag' => [ 'shape' => 'ETag', ], 'LastModified' => [ 'shape' => 'LastModified', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], ], ], 'CopyPartResult' => [ 'type' => 'structure', 'members' => [ 'ETag' => [ 'shape' => 'ETag', ], 'LastModified' => [ 'shape' => 'LastModified', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], ], ], 'CopySource' => [ 'type' => 'string', 'pattern' => '\\/.+\\/.+', ], 'CopySourceIfMatch' => [ 'type' => 'string', ], 'CopySourceIfModifiedSince' => [ 'type' => 'timestamp', ], 'CopySourceIfNoneMatch' => [ 'type' => 'string', ], 'CopySourceIfUnmodifiedSince' => [ 'type' => 'timestamp', ], 'CopySourceRange' => [ 'type' => 'string', ], 'CopySourceSSECustomerAlgorithm' => [ 'type' => 'string', ], 'CopySourceSSECustomerKey' => [ 'type' => 'string', 'sensitive' => true, ], 'CopySourceSSECustomerKeyMD5' => [ 'type' => 'string', ], 'CopySourceVersionId' => [ 'type' => 'string', ], 'CreateBucketConfiguration' => [ 'type' => 'structure', 'members' => [ 'LocationConstraint' => [ 'shape' => 'BucketLocationConstraint', ], 'Location' => [ 'shape' => 'LocationInfo', ], 'Bucket' => [ 'shape' => 'BucketInfo', ], ], ], 'CreateBucketOutput' => [ 'type' => 'structure', 'members' => [ 'Location' => [ 'shape' => 'Location', 'location' => 'header', 'locationName' => 'Location', ], ], ], 'CreateBucketRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'ACL' => [ 'shape' => 'BucketCannedACL', 'location' => 'header', 'locationName' => 'x-amz-acl', ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'CreateBucketConfiguration' => [ 'shape' => 'CreateBucketConfiguration', 'locationName' => 'CreateBucketConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'GrantFullControl' => [ 'shape' => 'GrantFullControl', 'location' => 'header', 'locationName' => 'x-amz-grant-full-control', ], 'GrantRead' => [ 'shape' => 'GrantRead', 'location' => 'header', 'locationName' => 'x-amz-grant-read', ], 'GrantReadACP' => [ 'shape' => 'GrantReadACP', 'location' => 'header', 'locationName' => 'x-amz-grant-read-acp', ], 'GrantWrite' => [ 'shape' => 'GrantWrite', 'location' => 'header', 'locationName' => 'x-amz-grant-write', ], 'GrantWriteACP' => [ 'shape' => 'GrantWriteACP', 'location' => 'header', 'locationName' => 'x-amz-grant-write-acp', ], 'ObjectLockEnabledForBucket' => [ 'shape' => 'ObjectLockEnabledForBucket', 'location' => 'header', 'locationName' => 'x-amz-bucket-object-lock-enabled', ], 'ObjectOwnership' => [ 'shape' => 'ObjectOwnership', 'location' => 'header', 'locationName' => 'x-amz-object-ownership', ], ], 'payload' => 'CreateBucketConfiguration', ], 'CreateMultipartUploadOutput' => [ 'type' => 'structure', 'members' => [ 'AbortDate' => [ 'shape' => 'AbortDate', 'location' => 'header', 'locationName' => 'x-amz-abort-date', ], 'AbortRuleId' => [ 'shape' => 'AbortRuleId', 'location' => 'header', 'locationName' => 'x-amz-abort-rule-id', ], 'Bucket' => [ 'shape' => 'BucketName', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', ], 'UploadId' => [ 'shape' => 'MultipartUploadId', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-checksum-algorithm', ], ], ], 'CreateMultipartUploadRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'ACL' => [ 'shape' => 'ObjectCannedACL', 'location' => 'header', 'locationName' => 'x-amz-acl', ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'CacheControl' => [ 'shape' => 'CacheControl', 'location' => 'header', 'locationName' => 'Cache-Control', ], 'ContentDisposition' => [ 'shape' => 'ContentDisposition', 'location' => 'header', 'locationName' => 'Content-Disposition', ], 'ContentEncoding' => [ 'shape' => 'ContentEncoding', 'location' => 'header', 'locationName' => 'Content-Encoding', ], 'ContentLanguage' => [ 'shape' => 'ContentLanguage', 'location' => 'header', 'locationName' => 'Content-Language', ], 'ContentType' => [ 'shape' => 'ContentType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'Expires' => [ 'shape' => 'Expires', 'location' => 'header', 'locationName' => 'Expires', ], 'GrantFullControl' => [ 'shape' => 'GrantFullControl', 'location' => 'header', 'locationName' => 'x-amz-grant-full-control', ], 'GrantRead' => [ 'shape' => 'GrantRead', 'location' => 'header', 'locationName' => 'x-amz-grant-read', ], 'GrantReadACP' => [ 'shape' => 'GrantReadACP', 'location' => 'header', 'locationName' => 'x-amz-grant-read-acp', ], 'GrantWriteACP' => [ 'shape' => 'GrantWriteACP', 'location' => 'header', 'locationName' => 'x-amz-grant-write-acp', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'Metadata' => [ 'shape' => 'Metadata', 'location' => 'headers', 'locationName' => 'x-amz-meta-', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'StorageClass' => [ 'shape' => 'StorageClass', 'location' => 'header', 'locationName' => 'x-amz-storage-class', ], 'WebsiteRedirectLocation' => [ 'shape' => 'WebsiteRedirectLocation', 'location' => 'header', 'locationName' => 'x-amz-website-redirect-location', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'Tagging' => [ 'shape' => 'TaggingHeader', 'location' => 'header', 'locationName' => 'x-amz-tagging', ], 'ObjectLockMode' => [ 'shape' => 'ObjectLockMode', 'location' => 'header', 'locationName' => 'x-amz-object-lock-mode', ], 'ObjectLockRetainUntilDate' => [ 'shape' => 'ObjectLockRetainUntilDate', 'location' => 'header', 'locationName' => 'x-amz-object-lock-retain-until-date', ], 'ObjectLockLegalHoldStatus' => [ 'shape' => 'ObjectLockLegalHoldStatus', 'location' => 'header', 'locationName' => 'x-amz-object-lock-legal-hold', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-checksum-algorithm', ], ], ], 'CreateSessionOutput' => [ 'type' => 'structure', 'required' => [ 'Credentials', ], 'members' => [ 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'Credentials' => [ 'shape' => 'SessionCredentials', 'locationName' => 'Credentials', ], ], ], 'CreateSessionRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'SessionMode' => [ 'shape' => 'SessionMode', 'location' => 'header', 'locationName' => 'x-amz-create-session-mode', ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], ], ], 'CreationDate' => [ 'type' => 'timestamp', ], 'DataRedundancy' => [ 'type' => 'string', 'enum' => [ 'SingleAvailabilityZone', ], ], 'Date' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'Days' => [ 'type' => 'integer', 'box' => true, ], 'DaysAfterInitiation' => [ 'type' => 'integer', 'box' => true, ], 'DefaultRetention' => [ 'type' => 'structure', 'members' => [ 'Mode' => [ 'shape' => 'ObjectLockRetentionMode', ], 'Days' => [ 'shape' => 'Days', ], 'Years' => [ 'shape' => 'Years', ], ], ], 'Delete' => [ 'type' => 'structure', 'required' => [ 'Objects', ], 'members' => [ 'Objects' => [ 'shape' => 'ObjectIdentifierList', 'locationName' => 'Object', ], 'Quiet' => [ 'shape' => 'Quiet', ], ], ], 'DeleteBucketAnalyticsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'AnalyticsId', 'location' => 'querystring', 'locationName' => 'id', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketCorsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketEncryptionRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketIntelligentTieringConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'IntelligentTieringId', 'location' => 'querystring', 'locationName' => 'id', ], ], ], 'DeleteBucketInventoryConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'InventoryId', 'location' => 'querystring', 'locationName' => 'id', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketLifecycleRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketMetricsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'MetricsId', 'location' => 'querystring', 'locationName' => 'id', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketOwnershipControlsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketReplicationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketTaggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteBucketWebsiteRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteMarker' => [ 'type' => 'boolean', ], 'DeleteMarkerEntry' => [ 'type' => 'structure', 'members' => [ 'Owner' => [ 'shape' => 'Owner', ], 'Key' => [ 'shape' => 'ObjectKey', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', ], 'IsLatest' => [ 'shape' => 'IsLatest', ], 'LastModified' => [ 'shape' => 'LastModified', ], ], ], 'DeleteMarkerReplication' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'DeleteMarkerReplicationStatus', ], ], ], 'DeleteMarkerReplicationStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'DeleteMarkerVersionId' => [ 'type' => 'string', ], 'DeleteMarkers' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeleteMarkerEntry', ], 'flattened' => true, ], 'DeleteObjectOutput' => [ 'type' => 'structure', 'members' => [ 'DeleteMarker' => [ 'shape' => 'DeleteMarker', 'location' => 'header', 'locationName' => 'x-amz-delete-marker', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'DeleteObjectRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'MFA' => [ 'shape' => 'MFA', 'location' => 'header', 'locationName' => 'x-amz-mfa', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'BypassGovernanceRetention' => [ 'shape' => 'BypassGovernanceRetention', 'location' => 'header', 'locationName' => 'x-amz-bypass-governance-retention', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'IfMatch' => [ 'shape' => 'IfMatch', 'location' => 'header', 'locationName' => 'If-Match', ], 'IfMatchLastModifiedTime' => [ 'shape' => 'IfMatchLastModifiedTime', 'location' => 'header', 'locationName' => 'x-amz-if-match-last-modified-time', ], 'IfMatchSize' => [ 'shape' => 'IfMatchSize', 'location' => 'header', 'locationName' => 'x-amz-if-match-size', ], ], ], 'DeleteObjectTaggingOutput' => [ 'type' => 'structure', 'members' => [ 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], ], ], 'DeleteObjectTaggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeleteObjectsOutput' => [ 'type' => 'structure', 'members' => [ 'Deleted' => [ 'shape' => 'DeletedObjects', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'Errors' => [ 'shape' => 'Errors', 'locationName' => 'Error', ], ], ], 'DeleteObjectsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Delete', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Delete' => [ 'shape' => 'Delete', 'locationName' => 'Delete', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'MFA' => [ 'shape' => 'MFA', 'location' => 'header', 'locationName' => 'x-amz-mfa', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'BypassGovernanceRetention' => [ 'shape' => 'BypassGovernanceRetention', 'location' => 'header', 'locationName' => 'x-amz-bypass-governance-retention', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], ], 'payload' => 'Delete', ], 'DeletePublicAccessBlockRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'DeletedObject' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ObjectKey', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', ], 'DeleteMarker' => [ 'shape' => 'DeleteMarker', ], 'DeleteMarkerVersionId' => [ 'shape' => 'DeleteMarkerVersionId', ], ], ], 'DeletedObjects' => [ 'type' => 'list', 'member' => [ 'shape' => 'DeletedObject', ], 'flattened' => true, ], 'Delimiter' => [ 'type' => 'string', ], 'Description' => [ 'type' => 'string', ], 'Destination' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', ], 'Account' => [ 'shape' => 'AccountId', ], 'StorageClass' => [ 'shape' => 'StorageClass', ], 'AccessControlTranslation' => [ 'shape' => 'AccessControlTranslation', ], 'EncryptionConfiguration' => [ 'shape' => 'EncryptionConfiguration', ], 'ReplicationTime' => [ 'shape' => 'ReplicationTime', ], 'Metrics' => [ 'shape' => 'Metrics', ], ], ], 'DirectoryBucketToken' => [ 'type' => 'string', 'max' => 1024, 'min' => 0, ], 'DisplayName' => [ 'type' => 'string', ], 'ETag' => [ 'type' => 'string', ], 'EmailAddress' => [ 'type' => 'string', ], 'EnableRequestProgress' => [ 'type' => 'boolean', 'box' => true, ], 'EncodingType' => [ 'type' => 'string', 'enum' => [ 'url', ], ], 'Encryption' => [ 'type' => 'structure', 'required' => [ 'EncryptionType', ], 'members' => [ 'EncryptionType' => [ 'shape' => 'ServerSideEncryption', ], 'KMSKeyId' => [ 'shape' => 'SSEKMSKeyId', ], 'KMSContext' => [ 'shape' => 'KMSContext', ], ], ], 'EncryptionConfiguration' => [ 'type' => 'structure', 'members' => [ 'ReplicaKmsKeyID' => [ 'shape' => 'ReplicaKmsKeyID', ], ], ], 'EncryptionTypeMismatch' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'End' => [ 'type' => 'long', 'box' => true, ], 'EndEvent' => [ 'type' => 'structure', 'members' => [], 'event' => true, ], 'Error' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ObjectKey', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', ], 'Code' => [ 'shape' => 'Code', ], 'Message' => [ 'shape' => 'Message', ], ], ], 'ErrorCode' => [ 'type' => 'string', ], 'ErrorDocument' => [ 'type' => 'structure', 'required' => [ 'Key', ], 'members' => [ 'Key' => [ 'shape' => 'ObjectKey', ], ], ], 'ErrorMessage' => [ 'type' => 'string', ], 'Errors' => [ 'type' => 'list', 'member' => [ 'shape' => 'Error', ], 'flattened' => true, ], 'Event' => [ 'type' => 'string', 'enum' => [ 's3:ReducedRedundancyLostObject', 's3:ObjectCreated:*', 's3:ObjectCreated:Put', 's3:ObjectCreated:Post', 's3:ObjectCreated:Copy', 's3:ObjectCreated:CompleteMultipartUpload', 's3:ObjectRemoved:*', 's3:ObjectRemoved:Delete', 's3:ObjectRemoved:DeleteMarkerCreated', 's3:ObjectRestore:*', 's3:ObjectRestore:Post', 's3:ObjectRestore:Completed', 's3:Replication:*', 's3:Replication:OperationFailedReplication', 's3:Replication:OperationNotTracked', 's3:Replication:OperationMissedThreshold', 's3:Replication:OperationReplicatedAfterThreshold', 's3:ObjectRestore:Delete', 's3:LifecycleTransition', 's3:IntelligentTiering', 's3:ObjectAcl:Put', 's3:LifecycleExpiration:*', 's3:LifecycleExpiration:Delete', 's3:LifecycleExpiration:DeleteMarkerCreated', 's3:ObjectTagging:*', 's3:ObjectTagging:Put', 's3:ObjectTagging:Delete', ], ], 'EventBridgeConfiguration' => [ 'type' => 'structure', 'members' => [], ], 'EventList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Event', ], 'flattened' => true, ], 'ExistingObjectReplication' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'ExistingObjectReplicationStatus', ], ], ], 'ExistingObjectReplicationStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Expiration' => [ 'type' => 'string', ], 'ExpirationStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ExpiredObjectDeleteMarker' => [ 'type' => 'boolean', 'box' => true, ], 'Expires' => [ 'type' => 'timestamp', ], 'ExposeHeader' => [ 'type' => 'string', ], 'ExposeHeaders' => [ 'type' => 'list', 'member' => [ 'shape' => 'ExposeHeader', ], 'flattened' => true, ], 'Expression' => [ 'type' => 'string', ], 'ExpressionType' => [ 'type' => 'string', 'enum' => [ 'SQL', ], ], 'FetchOwner' => [ 'type' => 'boolean', 'box' => true, ], 'FieldDelimiter' => [ 'type' => 'string', ], 'FileHeaderInfo' => [ 'type' => 'string', 'enum' => [ 'USE', 'IGNORE', 'NONE', ], ], 'FilterRule' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'FilterRuleName', ], 'Value' => [ 'shape' => 'FilterRuleValue', ], ], ], 'FilterRuleList' => [ 'type' => 'list', 'member' => [ 'shape' => 'FilterRule', ], 'flattened' => true, ], 'FilterRuleName' => [ 'type' => 'string', 'enum' => [ 'prefix', 'suffix', ], ], 'FilterRuleValue' => [ 'type' => 'string', ], 'GetBucketAccelerateConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'BucketAccelerateStatus', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'GetBucketAccelerateConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], ], ], 'GetBucketAclOutput' => [ 'type' => 'structure', 'members' => [ 'Owner' => [ 'shape' => 'Owner', ], 'Grants' => [ 'shape' => 'Grants', 'locationName' => 'AccessControlList', ], ], ], 'GetBucketAclRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketAnalyticsConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'AnalyticsConfiguration' => [ 'shape' => 'AnalyticsConfiguration', ], ], 'payload' => 'AnalyticsConfiguration', ], 'GetBucketAnalyticsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'AnalyticsId', 'location' => 'querystring', 'locationName' => 'id', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketCorsOutput' => [ 'type' => 'structure', 'members' => [ 'CORSRules' => [ 'shape' => 'CORSRules', 'locationName' => 'CORSRule', ], ], ], 'GetBucketCorsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketEncryptionOutput' => [ 'type' => 'structure', 'members' => [ 'ServerSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', ], ], 'payload' => 'ServerSideEncryptionConfiguration', ], 'GetBucketEncryptionRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketIntelligentTieringConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'IntelligentTieringConfiguration' => [ 'shape' => 'IntelligentTieringConfiguration', ], ], 'payload' => 'IntelligentTieringConfiguration', ], 'GetBucketIntelligentTieringConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'IntelligentTieringId', 'location' => 'querystring', 'locationName' => 'id', ], ], ], 'GetBucketInventoryConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'InventoryConfiguration' => [ 'shape' => 'InventoryConfiguration', ], ], 'payload' => 'InventoryConfiguration', ], 'GetBucketInventoryConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'InventoryId', 'location' => 'querystring', 'locationName' => 'id', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketLifecycleConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'Rules' => [ 'shape' => 'LifecycleRules', 'locationName' => 'Rule', ], 'TransitionDefaultMinimumObjectSize' => [ 'shape' => 'TransitionDefaultMinimumObjectSize', 'location' => 'header', 'locationName' => 'x-amz-transition-default-minimum-object-size', ], ], ], 'GetBucketLifecycleConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketLifecycleOutput' => [ 'type' => 'structure', 'members' => [ 'Rules' => [ 'shape' => 'Rules', 'locationName' => 'Rule', ], ], ], 'GetBucketLifecycleRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketLocationOutput' => [ 'type' => 'structure', 'members' => [ 'LocationConstraint' => [ 'shape' => 'BucketLocationConstraint', ], ], ], 'GetBucketLocationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketLoggingOutput' => [ 'type' => 'structure', 'members' => [ 'LoggingEnabled' => [ 'shape' => 'LoggingEnabled', ], ], ], 'GetBucketLoggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketMetricsConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'MetricsConfiguration' => [ 'shape' => 'MetricsConfiguration', ], ], 'payload' => 'MetricsConfiguration', ], 'GetBucketMetricsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'MetricsId', 'location' => 'querystring', 'locationName' => 'id', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketNotificationConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketOwnershipControlsOutput' => [ 'type' => 'structure', 'members' => [ 'OwnershipControls' => [ 'shape' => 'OwnershipControls', ], ], 'payload' => 'OwnershipControls', ], 'GetBucketOwnershipControlsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketPolicyOutput' => [ 'type' => 'structure', 'members' => [ 'Policy' => [ 'shape' => 'Policy', ], ], 'payload' => 'Policy', ], 'GetBucketPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketPolicyStatusOutput' => [ 'type' => 'structure', 'members' => [ 'PolicyStatus' => [ 'shape' => 'PolicyStatus', ], ], 'payload' => 'PolicyStatus', ], 'GetBucketPolicyStatusRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketReplicationOutput' => [ 'type' => 'structure', 'members' => [ 'ReplicationConfiguration' => [ 'shape' => 'ReplicationConfiguration', ], ], 'payload' => 'ReplicationConfiguration', ], 'GetBucketReplicationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketRequestPaymentOutput' => [ 'type' => 'structure', 'members' => [ 'Payer' => [ 'shape' => 'Payer', ], ], ], 'GetBucketRequestPaymentRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketTaggingOutput' => [ 'type' => 'structure', 'required' => [ 'TagSet', ], 'members' => [ 'TagSet' => [ 'shape' => 'TagSet', ], ], ], 'GetBucketTaggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketVersioningOutput' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'BucketVersioningStatus', ], 'MFADelete' => [ 'shape' => 'MFADeleteStatus', 'locationName' => 'MfaDelete', ], ], ], 'GetBucketVersioningRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetBucketWebsiteOutput' => [ 'type' => 'structure', 'members' => [ 'RedirectAllRequestsTo' => [ 'shape' => 'RedirectAllRequestsTo', ], 'IndexDocument' => [ 'shape' => 'IndexDocument', ], 'ErrorDocument' => [ 'shape' => 'ErrorDocument', ], 'RoutingRules' => [ 'shape' => 'RoutingRules', ], ], ], 'GetBucketWebsiteRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetObjectAclOutput' => [ 'type' => 'structure', 'members' => [ 'Owner' => [ 'shape' => 'Owner', ], 'Grants' => [ 'shape' => 'Grants', 'locationName' => 'AccessControlList', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'GetObjectAclRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetObjectAttributesOutput' => [ 'type' => 'structure', 'members' => [ 'DeleteMarker' => [ 'shape' => 'DeleteMarker', 'location' => 'header', 'locationName' => 'x-amz-delete-marker', ], 'LastModified' => [ 'shape' => 'LastModified', 'location' => 'header', 'locationName' => 'Last-Modified', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'ETag' => [ 'shape' => 'ETag', ], 'Checksum' => [ 'shape' => 'Checksum', ], 'ObjectParts' => [ 'shape' => 'GetObjectAttributesParts', ], 'StorageClass' => [ 'shape' => 'StorageClass', ], 'ObjectSize' => [ 'shape' => 'ObjectSize', ], ], ], 'GetObjectAttributesParts' => [ 'type' => 'structure', 'members' => [ 'TotalPartsCount' => [ 'shape' => 'PartsCount', 'locationName' => 'PartsCount', ], 'PartNumberMarker' => [ 'shape' => 'PartNumberMarker', ], 'NextPartNumberMarker' => [ 'shape' => 'NextPartNumberMarker', ], 'MaxParts' => [ 'shape' => 'MaxParts', ], 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'Parts' => [ 'shape' => 'PartsList', 'locationName' => 'Part', ], ], ], 'GetObjectAttributesRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'ObjectAttributes', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'MaxParts' => [ 'shape' => 'MaxParts', 'location' => 'header', 'locationName' => 'x-amz-max-parts', ], 'PartNumberMarker' => [ 'shape' => 'PartNumberMarker', 'location' => 'header', 'locationName' => 'x-amz-part-number-marker', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ObjectAttributes' => [ 'shape' => 'ObjectAttributesList', 'location' => 'header', 'locationName' => 'x-amz-object-attributes', ], ], ], 'GetObjectLegalHoldOutput' => [ 'type' => 'structure', 'members' => [ 'LegalHold' => [ 'shape' => 'ObjectLockLegalHold', 'locationName' => 'LegalHold', ], ], 'payload' => 'LegalHold', ], 'GetObjectLegalHoldRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetObjectLockConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'ObjectLockConfiguration' => [ 'shape' => 'ObjectLockConfiguration', ], ], 'payload' => 'ObjectLockConfiguration', ], 'GetObjectLockConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetObjectOutput' => [ 'type' => 'structure', 'members' => [ 'Body' => [ 'shape' => 'Body', 'streaming' => true, ], 'DeleteMarker' => [ 'shape' => 'DeleteMarker', 'location' => 'header', 'locationName' => 'x-amz-delete-marker', ], 'AcceptRanges' => [ 'shape' => 'AcceptRanges', 'location' => 'header', 'locationName' => 'accept-ranges', ], 'Expiration' => [ 'shape' => 'Expiration', 'location' => 'header', 'locationName' => 'x-amz-expiration', ], 'Restore' => [ 'shape' => 'Restore', 'location' => 'header', 'locationName' => 'x-amz-restore', ], 'LastModified' => [ 'shape' => 'LastModified', 'location' => 'header', 'locationName' => 'Last-Modified', ], 'ContentLength' => [ 'shape' => 'ContentLength', 'location' => 'header', 'locationName' => 'Content-Length', ], 'ETag' => [ 'shape' => 'ETag', 'location' => 'header', 'locationName' => 'ETag', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'MissingMeta' => [ 'shape' => 'MissingMeta', 'location' => 'header', 'locationName' => 'x-amz-missing-meta', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'CacheControl' => [ 'shape' => 'CacheControl', 'location' => 'header', 'locationName' => 'Cache-Control', ], 'ContentDisposition' => [ 'shape' => 'ContentDisposition', 'location' => 'header', 'locationName' => 'Content-Disposition', ], 'ContentEncoding' => [ 'shape' => 'ContentEncoding', 'location' => 'header', 'locationName' => 'Content-Encoding', ], 'ContentLanguage' => [ 'shape' => 'ContentLanguage', 'location' => 'header', 'locationName' => 'Content-Language', ], 'ContentRange' => [ 'shape' => 'ContentRange', 'location' => 'header', 'locationName' => 'Content-Range', ], 'ContentType' => [ 'shape' => 'ContentType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'Expires' => [ 'shape' => 'Expires', 'location' => 'header', 'locationName' => 'Expires', ], 'WebsiteRedirectLocation' => [ 'shape' => 'WebsiteRedirectLocation', 'location' => 'header', 'locationName' => 'x-amz-website-redirect-location', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'Metadata' => [ 'shape' => 'Metadata', 'location' => 'headers', 'locationName' => 'x-amz-meta-', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'StorageClass' => [ 'shape' => 'StorageClass', 'location' => 'header', 'locationName' => 'x-amz-storage-class', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'ReplicationStatus' => [ 'shape' => 'ReplicationStatus', 'location' => 'header', 'locationName' => 'x-amz-replication-status', ], 'PartsCount' => [ 'shape' => 'PartsCount', 'location' => 'header', 'locationName' => 'x-amz-mp-parts-count', ], 'TagCount' => [ 'shape' => 'TagCount', 'location' => 'header', 'locationName' => 'x-amz-tagging-count', ], 'ObjectLockMode' => [ 'shape' => 'ObjectLockMode', 'location' => 'header', 'locationName' => 'x-amz-object-lock-mode', ], 'ObjectLockRetainUntilDate' => [ 'shape' => 'ObjectLockRetainUntilDate', 'location' => 'header', 'locationName' => 'x-amz-object-lock-retain-until-date', ], 'ObjectLockLegalHoldStatus' => [ 'shape' => 'ObjectLockLegalHoldStatus', 'location' => 'header', 'locationName' => 'x-amz-object-lock-legal-hold', ], ], 'payload' => 'Body', ], 'GetObjectRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'IfMatch' => [ 'shape' => 'IfMatch', 'location' => 'header', 'locationName' => 'If-Match', ], 'IfModifiedSince' => [ 'shape' => 'IfModifiedSince', 'location' => 'header', 'locationName' => 'If-Modified-Since', ], 'IfNoneMatch' => [ 'shape' => 'IfNoneMatch', 'location' => 'header', 'locationName' => 'If-None-Match', ], 'IfUnmodifiedSince' => [ 'shape' => 'IfUnmodifiedSince', 'location' => 'header', 'locationName' => 'If-Unmodified-Since', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'Range' => [ 'shape' => 'Range', 'location' => 'header', 'locationName' => 'Range', ], 'ResponseCacheControl' => [ 'shape' => 'ResponseCacheControl', 'location' => 'querystring', 'locationName' => 'response-cache-control', ], 'ResponseContentDisposition' => [ 'shape' => 'ResponseContentDisposition', 'location' => 'querystring', 'locationName' => 'response-content-disposition', ], 'ResponseContentEncoding' => [ 'shape' => 'ResponseContentEncoding', 'location' => 'querystring', 'locationName' => 'response-content-encoding', ], 'ResponseContentLanguage' => [ 'shape' => 'ResponseContentLanguage', 'location' => 'querystring', 'locationName' => 'response-content-language', ], 'ResponseContentType' => [ 'shape' => 'ResponseContentType', 'location' => 'querystring', 'locationName' => 'response-content-type', ], 'ResponseExpires' => [ 'shape' => 'ResponseExpires', 'location' => 'querystring', 'locationName' => 'response-expires', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'PartNumber' => [ 'shape' => 'PartNumber', 'location' => 'querystring', 'locationName' => 'partNumber', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ChecksumMode' => [ 'shape' => 'ChecksumMode', 'location' => 'header', 'locationName' => 'x-amz-checksum-mode', ], ], ], 'GetObjectResponseStatusCode' => [ 'type' => 'integer', 'box' => true, ], 'GetObjectRetentionOutput' => [ 'type' => 'structure', 'members' => [ 'Retention' => [ 'shape' => 'ObjectLockRetention', 'locationName' => 'Retention', ], ], 'payload' => 'Retention', ], 'GetObjectRetentionRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetObjectTaggingOutput' => [ 'type' => 'structure', 'required' => [ 'TagSet', ], 'members' => [ 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'TagSet' => [ 'shape' => 'TagSet', ], ], ], 'GetObjectTaggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], ], ], 'GetObjectTorrentOutput' => [ 'type' => 'structure', 'members' => [ 'Body' => [ 'shape' => 'Body', 'streaming' => true, ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], 'payload' => 'Body', ], 'GetObjectTorrentRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GetPublicAccessBlockOutput' => [ 'type' => 'structure', 'members' => [ 'PublicAccessBlockConfiguration' => [ 'shape' => 'PublicAccessBlockConfiguration', ], ], 'payload' => 'PublicAccessBlockConfiguration', ], 'GetPublicAccessBlockRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'GlacierJobParameters' => [ 'type' => 'structure', 'required' => [ 'Tier', ], 'members' => [ 'Tier' => [ 'shape' => 'Tier', ], ], ], 'Grant' => [ 'type' => 'structure', 'members' => [ 'Grantee' => [ 'shape' => 'Grantee', ], 'Permission' => [ 'shape' => 'Permission', ], ], ], 'GrantFullControl' => [ 'type' => 'string', ], 'GrantRead' => [ 'type' => 'string', ], 'GrantReadACP' => [ 'type' => 'string', ], 'GrantWrite' => [ 'type' => 'string', ], 'GrantWriteACP' => [ 'type' => 'string', ], 'Grantee' => [ 'type' => 'structure', 'required' => [ 'Type', ], 'members' => [ 'DisplayName' => [ 'shape' => 'DisplayName', ], 'EmailAddress' => [ 'shape' => 'EmailAddress', ], 'ID' => [ 'shape' => 'ID', ], 'Type' => [ 'shape' => 'Type', 'locationName' => 'xsi:type', 'xmlAttribute' => true, ], 'URI' => [ 'shape' => 'URI', ], ], 'xmlNamespace' => [ 'prefix' => 'xsi', 'uri' => 'http://www.w3.org/2001/XMLSchema-instance', ], ], 'Grants' => [ 'type' => 'list', 'member' => [ 'shape' => 'Grant', 'locationName' => 'Grant', ], ], 'HeadBucketOutput' => [ 'type' => 'structure', 'members' => [ 'BucketLocationType' => [ 'shape' => 'LocationType', 'location' => 'header', 'locationName' => 'x-amz-bucket-location-type', ], 'BucketLocationName' => [ 'shape' => 'BucketLocationName', 'location' => 'header', 'locationName' => 'x-amz-bucket-location-name', ], 'BucketRegion' => [ 'shape' => 'Region', 'location' => 'header', 'locationName' => 'x-amz-bucket-region', ], 'AccessPointAlias' => [ 'shape' => 'AccessPointAlias', 'location' => 'header', 'locationName' => 'x-amz-access-point-alias', ], ], ], 'HeadBucketRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'HeadObjectOutput' => [ 'type' => 'structure', 'members' => [ 'DeleteMarker' => [ 'shape' => 'DeleteMarker', 'location' => 'header', 'locationName' => 'x-amz-delete-marker', ], 'AcceptRanges' => [ 'shape' => 'AcceptRanges', 'location' => 'header', 'locationName' => 'accept-ranges', ], 'Expiration' => [ 'shape' => 'Expiration', 'location' => 'header', 'locationName' => 'x-amz-expiration', ], 'Restore' => [ 'shape' => 'Restore', 'location' => 'header', 'locationName' => 'x-amz-restore', ], 'ArchiveStatus' => [ 'shape' => 'ArchiveStatus', 'location' => 'header', 'locationName' => 'x-amz-archive-status', ], 'LastModified' => [ 'shape' => 'LastModified', 'location' => 'header', 'locationName' => 'Last-Modified', ], 'ContentLength' => [ 'shape' => 'ContentLength', 'location' => 'header', 'locationName' => 'Content-Length', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'ETag' => [ 'shape' => 'ETag', 'location' => 'header', 'locationName' => 'ETag', ], 'MissingMeta' => [ 'shape' => 'MissingMeta', 'location' => 'header', 'locationName' => 'x-amz-missing-meta', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'CacheControl' => [ 'shape' => 'CacheControl', 'location' => 'header', 'locationName' => 'Cache-Control', ], 'ContentDisposition' => [ 'shape' => 'ContentDisposition', 'location' => 'header', 'locationName' => 'Content-Disposition', ], 'ContentEncoding' => [ 'shape' => 'ContentEncoding', 'location' => 'header', 'locationName' => 'Content-Encoding', ], 'ContentLanguage' => [ 'shape' => 'ContentLanguage', 'location' => 'header', 'locationName' => 'Content-Language', ], 'ContentType' => [ 'shape' => 'ContentType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'Expires' => [ 'shape' => 'Expires', 'location' => 'header', 'locationName' => 'Expires', ], 'WebsiteRedirectLocation' => [ 'shape' => 'WebsiteRedirectLocation', 'location' => 'header', 'locationName' => 'x-amz-website-redirect-location', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'Metadata' => [ 'shape' => 'Metadata', 'location' => 'headers', 'locationName' => 'x-amz-meta-', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'StorageClass' => [ 'shape' => 'StorageClass', 'location' => 'header', 'locationName' => 'x-amz-storage-class', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'ReplicationStatus' => [ 'shape' => 'ReplicationStatus', 'location' => 'header', 'locationName' => 'x-amz-replication-status', ], 'PartsCount' => [ 'shape' => 'PartsCount', 'location' => 'header', 'locationName' => 'x-amz-mp-parts-count', ], 'ObjectLockMode' => [ 'shape' => 'ObjectLockMode', 'location' => 'header', 'locationName' => 'x-amz-object-lock-mode', ], 'ObjectLockRetainUntilDate' => [ 'shape' => 'ObjectLockRetainUntilDate', 'location' => 'header', 'locationName' => 'x-amz-object-lock-retain-until-date', ], 'ObjectLockLegalHoldStatus' => [ 'shape' => 'ObjectLockLegalHoldStatus', 'location' => 'header', 'locationName' => 'x-amz-object-lock-legal-hold', ], ], ], 'HeadObjectRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'IfMatch' => [ 'shape' => 'IfMatch', 'location' => 'header', 'locationName' => 'If-Match', ], 'IfModifiedSince' => [ 'shape' => 'IfModifiedSince', 'location' => 'header', 'locationName' => 'If-Modified-Since', ], 'IfNoneMatch' => [ 'shape' => 'IfNoneMatch', 'location' => 'header', 'locationName' => 'If-None-Match', ], 'IfUnmodifiedSince' => [ 'shape' => 'IfUnmodifiedSince', 'location' => 'header', 'locationName' => 'If-Unmodified-Since', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'Range' => [ 'shape' => 'Range', 'location' => 'header', 'locationName' => 'Range', ], 'ResponseCacheControl' => [ 'shape' => 'ResponseCacheControl', 'location' => 'querystring', 'locationName' => 'response-cache-control', ], 'ResponseContentDisposition' => [ 'shape' => 'ResponseContentDisposition', 'location' => 'querystring', 'locationName' => 'response-content-disposition', ], 'ResponseContentEncoding' => [ 'shape' => 'ResponseContentEncoding', 'location' => 'querystring', 'locationName' => 'response-content-encoding', ], 'ResponseContentLanguage' => [ 'shape' => 'ResponseContentLanguage', 'location' => 'querystring', 'locationName' => 'response-content-language', ], 'ResponseContentType' => [ 'shape' => 'ResponseContentType', 'location' => 'querystring', 'locationName' => 'response-content-type', ], 'ResponseExpires' => [ 'shape' => 'ResponseExpires', 'location' => 'querystring', 'locationName' => 'response-expires', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'PartNumber' => [ 'shape' => 'PartNumber', 'location' => 'querystring', 'locationName' => 'partNumber', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ChecksumMode' => [ 'shape' => 'ChecksumMode', 'location' => 'header', 'locationName' => 'x-amz-checksum-mode', ], ], ], 'HostName' => [ 'type' => 'string', ], 'HttpErrorCodeReturnedEquals' => [ 'type' => 'string', ], 'HttpRedirectCode' => [ 'type' => 'string', ], 'ID' => [ 'type' => 'string', ], 'IfMatch' => [ 'type' => 'string', ], 'IfMatchInitiatedTime' => [ 'type' => 'timestamp', 'timestampFormat' => 'rfc822', ], 'IfMatchLastModifiedTime' => [ 'type' => 'timestamp', 'timestampFormat' => 'rfc822', ], 'IfMatchSize' => [ 'type' => 'long', 'box' => true, ], 'IfModifiedSince' => [ 'type' => 'timestamp', ], 'IfNoneMatch' => [ 'type' => 'string', ], 'IfUnmodifiedSince' => [ 'type' => 'timestamp', ], 'IndexDocument' => [ 'type' => 'structure', 'required' => [ 'Suffix', ], 'members' => [ 'Suffix' => [ 'shape' => 'Suffix', ], ], ], 'Initiated' => [ 'type' => 'timestamp', ], 'Initiator' => [ 'type' => 'structure', 'members' => [ 'ID' => [ 'shape' => 'ID', ], 'DisplayName' => [ 'shape' => 'DisplayName', ], ], ], 'InputSerialization' => [ 'type' => 'structure', 'members' => [ 'CSV' => [ 'shape' => 'CSVInput', ], 'CompressionType' => [ 'shape' => 'CompressionType', ], 'JSON' => [ 'shape' => 'JSONInput', ], 'Parquet' => [ 'shape' => 'ParquetInput', ], ], ], 'IntelligentTieringAccessTier' => [ 'type' => 'string', 'enum' => [ 'ARCHIVE_ACCESS', 'DEEP_ARCHIVE_ACCESS', ], ], 'IntelligentTieringAndOperator' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tags' => [ 'shape' => 'TagSet', 'flattened' => true, 'locationName' => 'Tag', ], ], ], 'IntelligentTieringConfiguration' => [ 'type' => 'structure', 'required' => [ 'Id', 'Status', 'Tierings', ], 'members' => [ 'Id' => [ 'shape' => 'IntelligentTieringId', ], 'Filter' => [ 'shape' => 'IntelligentTieringFilter', ], 'Status' => [ 'shape' => 'IntelligentTieringStatus', ], 'Tierings' => [ 'shape' => 'TieringList', 'locationName' => 'Tiering', ], ], ], 'IntelligentTieringConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'IntelligentTieringConfiguration', ], 'flattened' => true, ], 'IntelligentTieringDays' => [ 'type' => 'integer', 'box' => true, ], 'IntelligentTieringFilter' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tag' => [ 'shape' => 'Tag', ], 'And' => [ 'shape' => 'IntelligentTieringAndOperator', ], ], ], 'IntelligentTieringId' => [ 'type' => 'string', ], 'IntelligentTieringStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'InvalidObjectState' => [ 'type' => 'structure', 'members' => [ 'StorageClass' => [ 'shape' => 'StorageClass', ], 'AccessTier' => [ 'shape' => 'IntelligentTieringAccessTier', ], ], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'InvalidRequest' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InvalidWriteOffset' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'InventoryConfiguration' => [ 'type' => 'structure', 'required' => [ 'Destination', 'IsEnabled', 'Id', 'IncludedObjectVersions', 'Schedule', ], 'members' => [ 'Destination' => [ 'shape' => 'InventoryDestination', ], 'IsEnabled' => [ 'shape' => 'IsEnabled', ], 'Filter' => [ 'shape' => 'InventoryFilter', ], 'Id' => [ 'shape' => 'InventoryId', ], 'IncludedObjectVersions' => [ 'shape' => 'InventoryIncludedObjectVersions', ], 'OptionalFields' => [ 'shape' => 'InventoryOptionalFields', ], 'Schedule' => [ 'shape' => 'InventorySchedule', ], ], ], 'InventoryConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'InventoryConfiguration', ], 'flattened' => true, ], 'InventoryDestination' => [ 'type' => 'structure', 'required' => [ 'S3BucketDestination', ], 'members' => [ 'S3BucketDestination' => [ 'shape' => 'InventoryS3BucketDestination', ], ], ], 'InventoryEncryption' => [ 'type' => 'structure', 'members' => [ 'SSES3' => [ 'shape' => 'SSES3', 'locationName' => 'SSE-S3', ], 'SSEKMS' => [ 'shape' => 'SSEKMS', 'locationName' => 'SSE-KMS', ], ], ], 'InventoryFilter' => [ 'type' => 'structure', 'required' => [ 'Prefix', ], 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], ], ], 'InventoryFormat' => [ 'type' => 'string', 'enum' => [ 'CSV', 'ORC', 'Parquet', ], ], 'InventoryFrequency' => [ 'type' => 'string', 'enum' => [ 'Daily', 'Weekly', ], ], 'InventoryId' => [ 'type' => 'string', ], 'InventoryIncludedObjectVersions' => [ 'type' => 'string', 'enum' => [ 'All', 'Current', ], ], 'InventoryOptionalField' => [ 'type' => 'string', 'enum' => [ 'Size', 'LastModifiedDate', 'StorageClass', 'ETag', 'IsMultipartUploaded', 'ReplicationStatus', 'EncryptionStatus', 'ObjectLockRetainUntilDate', 'ObjectLockMode', 'ObjectLockLegalHoldStatus', 'IntelligentTieringAccessTier', 'BucketKeyStatus', 'ChecksumAlgorithm', 'ObjectAccessControlList', 'ObjectOwner', ], ], 'InventoryOptionalFields' => [ 'type' => 'list', 'member' => [ 'shape' => 'InventoryOptionalField', 'locationName' => 'Field', ], ], 'InventoryS3BucketDestination' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Format', ], 'members' => [ 'AccountId' => [ 'shape' => 'AccountId', ], 'Bucket' => [ 'shape' => 'BucketName', ], 'Format' => [ 'shape' => 'InventoryFormat', ], 'Prefix' => [ 'shape' => 'Prefix', ], 'Encryption' => [ 'shape' => 'InventoryEncryption', ], ], ], 'InventorySchedule' => [ 'type' => 'structure', 'required' => [ 'Frequency', ], 'members' => [ 'Frequency' => [ 'shape' => 'InventoryFrequency', ], ], ], 'IsEnabled' => [ 'type' => 'boolean', 'box' => true, ], 'IsLatest' => [ 'type' => 'boolean', 'box' => true, ], 'IsPublic' => [ 'type' => 'boolean', 'box' => true, ], 'IsRestoreInProgress' => [ 'type' => 'boolean', 'box' => true, ], 'IsTruncated' => [ 'type' => 'boolean', 'box' => true, ], 'JSONInput' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'JSONType', ], ], ], 'JSONOutput' => [ 'type' => 'structure', 'members' => [ 'RecordDelimiter' => [ 'shape' => 'RecordDelimiter', ], ], ], 'JSONType' => [ 'type' => 'string', 'enum' => [ 'DOCUMENT', 'LINES', ], ], 'KMSContext' => [ 'type' => 'string', ], 'KeyCount' => [ 'type' => 'integer', ], 'KeyMarker' => [ 'type' => 'string', ], 'KeyPrefixEquals' => [ 'type' => 'string', ], 'LambdaFunctionArn' => [ 'type' => 'string', ], 'LambdaFunctionConfiguration' => [ 'type' => 'structure', 'required' => [ 'LambdaFunctionArn', 'Events', ], 'members' => [ 'Id' => [ 'shape' => 'NotificationId', ], 'LambdaFunctionArn' => [ 'shape' => 'LambdaFunctionArn', 'locationName' => 'CloudFunction', ], 'Events' => [ 'shape' => 'EventList', 'locationName' => 'Event', ], 'Filter' => [ 'shape' => 'NotificationConfigurationFilter', ], ], ], 'LambdaFunctionConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'LambdaFunctionConfiguration', ], 'flattened' => true, ], 'LastModified' => [ 'type' => 'timestamp', ], 'LastModifiedTime' => [ 'type' => 'timestamp', 'timestampFormat' => 'rfc822', ], 'LifecycleConfiguration' => [ 'type' => 'structure', 'required' => [ 'Rules', ], 'members' => [ 'Rules' => [ 'shape' => 'Rules', 'locationName' => 'Rule', ], ], ], 'LifecycleExpiration' => [ 'type' => 'structure', 'members' => [ 'Date' => [ 'shape' => 'Date', ], 'Days' => [ 'shape' => 'Days', ], 'ExpiredObjectDeleteMarker' => [ 'shape' => 'ExpiredObjectDeleteMarker', ], ], ], 'LifecycleRule' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Expiration' => [ 'shape' => 'LifecycleExpiration', ], 'ID' => [ 'shape' => 'ID', ], 'Prefix' => [ 'shape' => 'Prefix', 'deprecated' => true, ], 'Filter' => [ 'shape' => 'LifecycleRuleFilter', ], 'Status' => [ 'shape' => 'ExpirationStatus', ], 'Transitions' => [ 'shape' => 'TransitionList', 'locationName' => 'Transition', ], 'NoncurrentVersionTransitions' => [ 'shape' => 'NoncurrentVersionTransitionList', 'locationName' => 'NoncurrentVersionTransition', ], 'NoncurrentVersionExpiration' => [ 'shape' => 'NoncurrentVersionExpiration', ], 'AbortIncompleteMultipartUpload' => [ 'shape' => 'AbortIncompleteMultipartUpload', ], ], ], 'LifecycleRuleAndOperator' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tags' => [ 'shape' => 'TagSet', 'flattened' => true, 'locationName' => 'Tag', ], 'ObjectSizeGreaterThan' => [ 'shape' => 'ObjectSizeGreaterThanBytes', ], 'ObjectSizeLessThan' => [ 'shape' => 'ObjectSizeLessThanBytes', ], ], ], 'LifecycleRuleFilter' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tag' => [ 'shape' => 'Tag', ], 'ObjectSizeGreaterThan' => [ 'shape' => 'ObjectSizeGreaterThanBytes', ], 'ObjectSizeLessThan' => [ 'shape' => 'ObjectSizeLessThanBytes', ], 'And' => [ 'shape' => 'LifecycleRuleAndOperator', ], ], ], 'LifecycleRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'LifecycleRule', ], 'flattened' => true, ], 'ListBucketAnalyticsConfigurationsOutput' => [ 'type' => 'structure', 'members' => [ 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'ContinuationToken' => [ 'shape' => 'Token', ], 'NextContinuationToken' => [ 'shape' => 'NextToken', ], 'AnalyticsConfigurationList' => [ 'shape' => 'AnalyticsConfigurationList', 'locationName' => 'AnalyticsConfiguration', ], ], ], 'ListBucketAnalyticsConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContinuationToken' => [ 'shape' => 'Token', 'location' => 'querystring', 'locationName' => 'continuation-token', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'ListBucketIntelligentTieringConfigurationsOutput' => [ 'type' => 'structure', 'members' => [ 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'ContinuationToken' => [ 'shape' => 'Token', ], 'NextContinuationToken' => [ 'shape' => 'NextToken', ], 'IntelligentTieringConfigurationList' => [ 'shape' => 'IntelligentTieringConfigurationList', 'locationName' => 'IntelligentTieringConfiguration', ], ], ], 'ListBucketIntelligentTieringConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContinuationToken' => [ 'shape' => 'Token', 'location' => 'querystring', 'locationName' => 'continuation-token', ], ], ], 'ListBucketInventoryConfigurationsOutput' => [ 'type' => 'structure', 'members' => [ 'ContinuationToken' => [ 'shape' => 'Token', ], 'InventoryConfigurationList' => [ 'shape' => 'InventoryConfigurationList', 'locationName' => 'InventoryConfiguration', ], 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'NextContinuationToken' => [ 'shape' => 'NextToken', ], ], ], 'ListBucketInventoryConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContinuationToken' => [ 'shape' => 'Token', 'location' => 'querystring', 'locationName' => 'continuation-token', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'ListBucketMetricsConfigurationsOutput' => [ 'type' => 'structure', 'members' => [ 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'ContinuationToken' => [ 'shape' => 'Token', ], 'NextContinuationToken' => [ 'shape' => 'NextToken', ], 'MetricsConfigurationList' => [ 'shape' => 'MetricsConfigurationList', 'locationName' => 'MetricsConfiguration', ], ], ], 'ListBucketMetricsConfigurationsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContinuationToken' => [ 'shape' => 'Token', 'location' => 'querystring', 'locationName' => 'continuation-token', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'ListBucketsOutput' => [ 'type' => 'structure', 'members' => [ 'Buckets' => [ 'shape' => 'Buckets', ], 'Owner' => [ 'shape' => 'Owner', ], 'ContinuationToken' => [ 'shape' => 'NextToken', ], 'Prefix' => [ 'shape' => 'Prefix', ], ], ], 'ListBucketsRequest' => [ 'type' => 'structure', 'members' => [ 'MaxBuckets' => [ 'shape' => 'MaxBuckets', 'location' => 'querystring', 'locationName' => 'max-buckets', ], 'ContinuationToken' => [ 'shape' => 'Token', 'location' => 'querystring', 'locationName' => 'continuation-token', ], 'Prefix' => [ 'shape' => 'Prefix', 'location' => 'querystring', 'locationName' => 'prefix', ], 'BucketRegion' => [ 'shape' => 'BucketRegion', 'location' => 'querystring', 'locationName' => 'bucket-region', ], ], ], 'ListDirectoryBucketsOutput' => [ 'type' => 'structure', 'members' => [ 'Buckets' => [ 'shape' => 'Buckets', ], 'ContinuationToken' => [ 'shape' => 'DirectoryBucketToken', ], ], ], 'ListDirectoryBucketsRequest' => [ 'type' => 'structure', 'members' => [ 'ContinuationToken' => [ 'shape' => 'DirectoryBucketToken', 'location' => 'querystring', 'locationName' => 'continuation-token', ], 'MaxDirectoryBuckets' => [ 'shape' => 'MaxDirectoryBuckets', 'location' => 'querystring', 'locationName' => 'max-directory-buckets', ], ], ], 'ListMultipartUploadsOutput' => [ 'type' => 'structure', 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', ], 'KeyMarker' => [ 'shape' => 'KeyMarker', ], 'UploadIdMarker' => [ 'shape' => 'UploadIdMarker', ], 'NextKeyMarker' => [ 'shape' => 'NextKeyMarker', ], 'Prefix' => [ 'shape' => 'Prefix', ], 'Delimiter' => [ 'shape' => 'Delimiter', ], 'NextUploadIdMarker' => [ 'shape' => 'NextUploadIdMarker', ], 'MaxUploads' => [ 'shape' => 'MaxUploads', ], 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'Uploads' => [ 'shape' => 'MultipartUploadList', 'locationName' => 'Upload', ], 'CommonPrefixes' => [ 'shape' => 'CommonPrefixList', ], 'EncodingType' => [ 'shape' => 'EncodingType', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'ListMultipartUploadsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Delimiter' => [ 'shape' => 'Delimiter', 'location' => 'querystring', 'locationName' => 'delimiter', ], 'EncodingType' => [ 'shape' => 'EncodingType', 'location' => 'querystring', 'locationName' => 'encoding-type', ], 'KeyMarker' => [ 'shape' => 'KeyMarker', 'location' => 'querystring', 'locationName' => 'key-marker', ], 'MaxUploads' => [ 'shape' => 'MaxUploads', 'location' => 'querystring', 'locationName' => 'max-uploads', ], 'Prefix' => [ 'shape' => 'Prefix', 'contextParam' => [ 'name' => 'Prefix', ], 'location' => 'querystring', 'locationName' => 'prefix', ], 'UploadIdMarker' => [ 'shape' => 'UploadIdMarker', 'location' => 'querystring', 'locationName' => 'upload-id-marker', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], ], ], 'ListObjectVersionsOutput' => [ 'type' => 'structure', 'members' => [ 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'KeyMarker' => [ 'shape' => 'KeyMarker', ], 'VersionIdMarker' => [ 'shape' => 'VersionIdMarker', ], 'NextKeyMarker' => [ 'shape' => 'NextKeyMarker', ], 'NextVersionIdMarker' => [ 'shape' => 'NextVersionIdMarker', ], 'Versions' => [ 'shape' => 'ObjectVersionList', 'locationName' => 'Version', ], 'DeleteMarkers' => [ 'shape' => 'DeleteMarkers', 'locationName' => 'DeleteMarker', ], 'Name' => [ 'shape' => 'BucketName', ], 'Prefix' => [ 'shape' => 'Prefix', ], 'Delimiter' => [ 'shape' => 'Delimiter', ], 'MaxKeys' => [ 'shape' => 'MaxKeys', ], 'CommonPrefixes' => [ 'shape' => 'CommonPrefixList', ], 'EncodingType' => [ 'shape' => 'EncodingType', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'ListObjectVersionsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Delimiter' => [ 'shape' => 'Delimiter', 'location' => 'querystring', 'locationName' => 'delimiter', ], 'EncodingType' => [ 'shape' => 'EncodingType', 'location' => 'querystring', 'locationName' => 'encoding-type', ], 'KeyMarker' => [ 'shape' => 'KeyMarker', 'location' => 'querystring', 'locationName' => 'key-marker', ], 'MaxKeys' => [ 'shape' => 'MaxKeys', 'location' => 'querystring', 'locationName' => 'max-keys', ], 'Prefix' => [ 'shape' => 'Prefix', 'contextParam' => [ 'name' => 'Prefix', ], 'location' => 'querystring', 'locationName' => 'prefix', ], 'VersionIdMarker' => [ 'shape' => 'VersionIdMarker', 'location' => 'querystring', 'locationName' => 'version-id-marker', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'OptionalObjectAttributes' => [ 'shape' => 'OptionalObjectAttributesList', 'location' => 'header', 'locationName' => 'x-amz-optional-object-attributes', ], ], ], 'ListObjectsOutput' => [ 'type' => 'structure', 'members' => [ 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'Marker' => [ 'shape' => 'Marker', ], 'NextMarker' => [ 'shape' => 'NextMarker', ], 'Contents' => [ 'shape' => 'ObjectList', ], 'Name' => [ 'shape' => 'BucketName', ], 'Prefix' => [ 'shape' => 'Prefix', ], 'Delimiter' => [ 'shape' => 'Delimiter', ], 'MaxKeys' => [ 'shape' => 'MaxKeys', ], 'CommonPrefixes' => [ 'shape' => 'CommonPrefixList', ], 'EncodingType' => [ 'shape' => 'EncodingType', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'ListObjectsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Delimiter' => [ 'shape' => 'Delimiter', 'location' => 'querystring', 'locationName' => 'delimiter', ], 'EncodingType' => [ 'shape' => 'EncodingType', 'location' => 'querystring', 'locationName' => 'encoding-type', ], 'Marker' => [ 'shape' => 'Marker', 'location' => 'querystring', 'locationName' => 'marker', ], 'MaxKeys' => [ 'shape' => 'MaxKeys', 'location' => 'querystring', 'locationName' => 'max-keys', ], 'Prefix' => [ 'shape' => 'Prefix', 'contextParam' => [ 'name' => 'Prefix', ], 'location' => 'querystring', 'locationName' => 'prefix', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'OptionalObjectAttributes' => [ 'shape' => 'OptionalObjectAttributesList', 'location' => 'header', 'locationName' => 'x-amz-optional-object-attributes', ], ], ], 'ListObjectsV2Output' => [ 'type' => 'structure', 'members' => [ 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'Contents' => [ 'shape' => 'ObjectList', ], 'Name' => [ 'shape' => 'BucketName', ], 'Prefix' => [ 'shape' => 'Prefix', ], 'Delimiter' => [ 'shape' => 'Delimiter', ], 'MaxKeys' => [ 'shape' => 'MaxKeys', ], 'CommonPrefixes' => [ 'shape' => 'CommonPrefixList', ], 'EncodingType' => [ 'shape' => 'EncodingType', ], 'KeyCount' => [ 'shape' => 'KeyCount', ], 'ContinuationToken' => [ 'shape' => 'Token', ], 'NextContinuationToken' => [ 'shape' => 'NextToken', ], 'StartAfter' => [ 'shape' => 'StartAfter', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'ListObjectsV2Request' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Delimiter' => [ 'shape' => 'Delimiter', 'location' => 'querystring', 'locationName' => 'delimiter', ], 'EncodingType' => [ 'shape' => 'EncodingType', 'location' => 'querystring', 'locationName' => 'encoding-type', ], 'MaxKeys' => [ 'shape' => 'MaxKeys', 'location' => 'querystring', 'locationName' => 'max-keys', ], 'Prefix' => [ 'shape' => 'Prefix', 'contextParam' => [ 'name' => 'Prefix', ], 'location' => 'querystring', 'locationName' => 'prefix', ], 'ContinuationToken' => [ 'shape' => 'Token', 'location' => 'querystring', 'locationName' => 'continuation-token', ], 'FetchOwner' => [ 'shape' => 'FetchOwner', 'location' => 'querystring', 'locationName' => 'fetch-owner', ], 'StartAfter' => [ 'shape' => 'StartAfter', 'location' => 'querystring', 'locationName' => 'start-after', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'OptionalObjectAttributes' => [ 'shape' => 'OptionalObjectAttributesList', 'location' => 'header', 'locationName' => 'x-amz-optional-object-attributes', ], ], ], 'ListPartsOutput' => [ 'type' => 'structure', 'members' => [ 'AbortDate' => [ 'shape' => 'AbortDate', 'location' => 'header', 'locationName' => 'x-amz-abort-date', ], 'AbortRuleId' => [ 'shape' => 'AbortRuleId', 'location' => 'header', 'locationName' => 'x-amz-abort-rule-id', ], 'Bucket' => [ 'shape' => 'BucketName', ], 'Key' => [ 'shape' => 'ObjectKey', ], 'UploadId' => [ 'shape' => 'MultipartUploadId', ], 'PartNumberMarker' => [ 'shape' => 'PartNumberMarker', ], 'NextPartNumberMarker' => [ 'shape' => 'NextPartNumberMarker', ], 'MaxParts' => [ 'shape' => 'MaxParts', ], 'IsTruncated' => [ 'shape' => 'IsTruncated', ], 'Parts' => [ 'shape' => 'Parts', 'locationName' => 'Part', ], 'Initiator' => [ 'shape' => 'Initiator', ], 'Owner' => [ 'shape' => 'Owner', ], 'StorageClass' => [ 'shape' => 'StorageClass', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', ], ], ], 'ListPartsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'UploadId', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'MaxParts' => [ 'shape' => 'MaxParts', 'location' => 'querystring', 'locationName' => 'max-parts', ], 'PartNumberMarker' => [ 'shape' => 'PartNumberMarker', 'location' => 'querystring', 'locationName' => 'part-number-marker', ], 'UploadId' => [ 'shape' => 'MultipartUploadId', 'location' => 'querystring', 'locationName' => 'uploadId', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], ], ], 'Location' => [ 'type' => 'string', ], 'LocationInfo' => [ 'type' => 'structure', 'members' => [ 'Type' => [ 'shape' => 'LocationType', ], 'Name' => [ 'shape' => 'LocationNameAsString', ], ], ], 'LocationNameAsString' => [ 'type' => 'string', ], 'LocationPrefix' => [ 'type' => 'string', ], 'LocationType' => [ 'type' => 'string', 'enum' => [ 'AvailabilityZone', ], ], 'LoggingEnabled' => [ 'type' => 'structure', 'required' => [ 'TargetBucket', 'TargetPrefix', ], 'members' => [ 'TargetBucket' => [ 'shape' => 'TargetBucket', ], 'TargetGrants' => [ 'shape' => 'TargetGrants', ], 'TargetPrefix' => [ 'shape' => 'TargetPrefix', ], 'TargetObjectKeyFormat' => [ 'shape' => 'TargetObjectKeyFormat', ], ], ], 'MFA' => [ 'type' => 'string', ], 'MFADelete' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'MFADeleteStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Marker' => [ 'type' => 'string', ], 'MaxAgeSeconds' => [ 'type' => 'integer', 'box' => true, ], 'MaxBuckets' => [ 'type' => 'integer', 'box' => true, 'max' => 10000, 'min' => 1, ], 'MaxDirectoryBuckets' => [ 'type' => 'integer', 'box' => true, 'max' => 1000, 'min' => 0, ], 'MaxKeys' => [ 'type' => 'integer', ], 'MaxParts' => [ 'type' => 'integer', ], 'MaxUploads' => [ 'type' => 'integer', ], 'Message' => [ 'type' => 'string', ], 'Metadata' => [ 'type' => 'map', 'key' => [ 'shape' => 'MetadataKey', ], 'value' => [ 'shape' => 'MetadataValue', ], ], 'MetadataDirective' => [ 'type' => 'string', 'enum' => [ 'COPY', 'REPLACE', ], ], 'MetadataEntry' => [ 'type' => 'structure', 'members' => [ 'Name' => [ 'shape' => 'MetadataKey', ], 'Value' => [ 'shape' => 'MetadataValue', ], ], ], 'MetadataKey' => [ 'type' => 'string', ], 'MetadataValue' => [ 'type' => 'string', ], 'Metrics' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'MetricsStatus', ], 'EventThreshold' => [ 'shape' => 'ReplicationTimeValue', ], ], ], 'MetricsAndOperator' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tags' => [ 'shape' => 'TagSet', 'flattened' => true, 'locationName' => 'Tag', ], 'AccessPointArn' => [ 'shape' => 'AccessPointArn', ], ], ], 'MetricsConfiguration' => [ 'type' => 'structure', 'required' => [ 'Id', ], 'members' => [ 'Id' => [ 'shape' => 'MetricsId', ], 'Filter' => [ 'shape' => 'MetricsFilter', ], ], ], 'MetricsConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetricsConfiguration', ], 'flattened' => true, ], 'MetricsFilter' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tag' => [ 'shape' => 'Tag', ], 'AccessPointArn' => [ 'shape' => 'AccessPointArn', ], 'And' => [ 'shape' => 'MetricsAndOperator', ], ], ], 'MetricsId' => [ 'type' => 'string', ], 'MetricsStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Minutes' => [ 'type' => 'integer', 'box' => true, ], 'MissingMeta' => [ 'type' => 'integer', ], 'MultipartUpload' => [ 'type' => 'structure', 'members' => [ 'UploadId' => [ 'shape' => 'MultipartUploadId', ], 'Key' => [ 'shape' => 'ObjectKey', ], 'Initiated' => [ 'shape' => 'Initiated', ], 'StorageClass' => [ 'shape' => 'StorageClass', ], 'Owner' => [ 'shape' => 'Owner', ], 'Initiator' => [ 'shape' => 'Initiator', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', ], ], ], 'MultipartUploadId' => [ 'type' => 'string', ], 'MultipartUploadList' => [ 'type' => 'list', 'member' => [ 'shape' => 'MultipartUpload', ], 'flattened' => true, ], 'NextKeyMarker' => [ 'type' => 'string', ], 'NextMarker' => [ 'type' => 'string', ], 'NextPartNumberMarker' => [ 'type' => 'integer', 'box' => true, ], 'NextToken' => [ 'type' => 'string', ], 'NextUploadIdMarker' => [ 'type' => 'string', ], 'NextVersionIdMarker' => [ 'type' => 'string', ], 'NoSuchBucket' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'NoSuchKey' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'NoSuchUpload' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 404, ], 'exception' => true, ], 'NoncurrentVersionExpiration' => [ 'type' => 'structure', 'members' => [ 'NoncurrentDays' => [ 'shape' => 'Days', ], 'NewerNoncurrentVersions' => [ 'shape' => 'VersionCount', ], ], ], 'NoncurrentVersionTransition' => [ 'type' => 'structure', 'members' => [ 'NoncurrentDays' => [ 'shape' => 'Days', ], 'StorageClass' => [ 'shape' => 'TransitionStorageClass', ], 'NewerNoncurrentVersions' => [ 'shape' => 'VersionCount', ], ], ], 'NoncurrentVersionTransitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'NoncurrentVersionTransition', ], 'flattened' => true, ], 'NotificationConfiguration' => [ 'type' => 'structure', 'members' => [ 'TopicConfigurations' => [ 'shape' => 'TopicConfigurationList', 'locationName' => 'TopicConfiguration', ], 'QueueConfigurations' => [ 'shape' => 'QueueConfigurationList', 'locationName' => 'QueueConfiguration', ], 'LambdaFunctionConfigurations' => [ 'shape' => 'LambdaFunctionConfigurationList', 'locationName' => 'CloudFunctionConfiguration', ], 'EventBridgeConfiguration' => [ 'shape' => 'EventBridgeConfiguration', ], ], ], 'NotificationConfigurationDeprecated' => [ 'type' => 'structure', 'members' => [ 'TopicConfiguration' => [ 'shape' => 'TopicConfigurationDeprecated', ], 'QueueConfiguration' => [ 'shape' => 'QueueConfigurationDeprecated', ], 'CloudFunctionConfiguration' => [ 'shape' => 'CloudFunctionConfiguration', ], ], ], 'NotificationConfigurationFilter' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'S3KeyFilter', 'locationName' => 'S3Key', ], ], ], 'NotificationId' => [ 'type' => 'string', ], 'Object' => [ 'type' => 'structure', 'members' => [ 'Key' => [ 'shape' => 'ObjectKey', ], 'LastModified' => [ 'shape' => 'LastModified', ], 'ETag' => [ 'shape' => 'ETag', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithmList', ], 'Size' => [ 'shape' => 'Size', ], 'StorageClass' => [ 'shape' => 'ObjectStorageClass', ], 'Owner' => [ 'shape' => 'Owner', ], 'RestoreStatus' => [ 'shape' => 'RestoreStatus', ], ], ], 'ObjectAlreadyInActiveTierError' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'ObjectAttributes' => [ 'type' => 'string', 'enum' => [ 'ETag', 'Checksum', 'ObjectParts', 'StorageClass', 'ObjectSize', ], ], 'ObjectAttributesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ObjectAttributes', ], ], 'ObjectCannedACL' => [ 'type' => 'string', 'enum' => [ 'private', 'public-read', 'public-read-write', 'authenticated-read', 'aws-exec-read', 'bucket-owner-read', 'bucket-owner-full-control', ], ], 'ObjectIdentifier' => [ 'type' => 'structure', 'required' => [ 'Key', ], 'members' => [ 'Key' => [ 'shape' => 'ObjectKey', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', ], 'ETag' => [ 'shape' => 'ETag', ], 'LastModifiedTime' => [ 'shape' => 'LastModifiedTime', ], 'Size' => [ 'shape' => 'Size', ], ], ], 'ObjectIdentifierList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ObjectIdentifier', ], 'flattened' => true, ], 'ObjectKey' => [ 'type' => 'string', 'min' => 1, ], 'ObjectList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Object', ], 'flattened' => true, ], 'ObjectLockConfiguration' => [ 'type' => 'structure', 'members' => [ 'ObjectLockEnabled' => [ 'shape' => 'ObjectLockEnabled', ], 'Rule' => [ 'shape' => 'ObjectLockRule', ], ], ], 'ObjectLockEnabled' => [ 'type' => 'string', 'enum' => [ 'Enabled', ], ], 'ObjectLockEnabledForBucket' => [ 'type' => 'boolean', 'box' => true, ], 'ObjectLockLegalHold' => [ 'type' => 'structure', 'members' => [ 'Status' => [ 'shape' => 'ObjectLockLegalHoldStatus', ], ], ], 'ObjectLockLegalHoldStatus' => [ 'type' => 'string', 'enum' => [ 'ON', 'OFF', ], ], 'ObjectLockMode' => [ 'type' => 'string', 'enum' => [ 'GOVERNANCE', 'COMPLIANCE', ], ], 'ObjectLockRetainUntilDate' => [ 'type' => 'timestamp', 'timestampFormat' => 'iso8601', ], 'ObjectLockRetention' => [ 'type' => 'structure', 'members' => [ 'Mode' => [ 'shape' => 'ObjectLockRetentionMode', ], 'RetainUntilDate' => [ 'shape' => 'Date', ], ], ], 'ObjectLockRetentionMode' => [ 'type' => 'string', 'enum' => [ 'GOVERNANCE', 'COMPLIANCE', ], ], 'ObjectLockRule' => [ 'type' => 'structure', 'members' => [ 'DefaultRetention' => [ 'shape' => 'DefaultRetention', ], ], ], 'ObjectLockToken' => [ 'type' => 'string', ], 'ObjectNotInActiveTierError' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 403, ], 'exception' => true, ], 'ObjectOwnership' => [ 'type' => 'string', 'enum' => [ 'BucketOwnerPreferred', 'ObjectWriter', 'BucketOwnerEnforced', ], ], 'ObjectPart' => [ 'type' => 'structure', 'members' => [ 'PartNumber' => [ 'shape' => 'PartNumber', ], 'Size' => [ 'shape' => 'Size', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], ], ], 'ObjectSize' => [ 'type' => 'long', 'box' => true, ], 'ObjectSizeGreaterThanBytes' => [ 'type' => 'long', 'box' => true, ], 'ObjectSizeLessThanBytes' => [ 'type' => 'long', 'box' => true, ], 'ObjectStorageClass' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'REDUCED_REDUNDANCY', 'GLACIER', 'STANDARD_IA', 'ONEZONE_IA', 'INTELLIGENT_TIERING', 'DEEP_ARCHIVE', 'OUTPOSTS', 'GLACIER_IR', 'SNOW', 'EXPRESS_ONEZONE', ], ], 'ObjectVersion' => [ 'type' => 'structure', 'members' => [ 'ETag' => [ 'shape' => 'ETag', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithmList', ], 'Size' => [ 'shape' => 'Size', ], 'StorageClass' => [ 'shape' => 'ObjectVersionStorageClass', ], 'Key' => [ 'shape' => 'ObjectKey', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', ], 'IsLatest' => [ 'shape' => 'IsLatest', ], 'LastModified' => [ 'shape' => 'LastModified', ], 'Owner' => [ 'shape' => 'Owner', ], 'RestoreStatus' => [ 'shape' => 'RestoreStatus', ], ], ], 'ObjectVersionId' => [ 'type' => 'string', ], 'ObjectVersionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ObjectVersion', ], 'flattened' => true, ], 'ObjectVersionStorageClass' => [ 'type' => 'string', 'enum' => [ 'STANDARD', ], ], 'OptionalObjectAttributes' => [ 'type' => 'string', 'enum' => [ 'RestoreStatus', ], ], 'OptionalObjectAttributesList' => [ 'type' => 'list', 'member' => [ 'shape' => 'OptionalObjectAttributes', ], ], 'OutputLocation' => [ 'type' => 'structure', 'members' => [ 'S3' => [ 'shape' => 'S3Location', ], ], ], 'OutputSerialization' => [ 'type' => 'structure', 'members' => [ 'CSV' => [ 'shape' => 'CSVOutput', ], 'JSON' => [ 'shape' => 'JSONOutput', ], ], ], 'Owner' => [ 'type' => 'structure', 'members' => [ 'DisplayName' => [ 'shape' => 'DisplayName', ], 'ID' => [ 'shape' => 'ID', ], ], ], 'OwnerOverride' => [ 'type' => 'string', 'enum' => [ 'Destination', ], ], 'OwnershipControls' => [ 'type' => 'structure', 'required' => [ 'Rules', ], 'members' => [ 'Rules' => [ 'shape' => 'OwnershipControlsRules', 'locationName' => 'Rule', ], ], ], 'OwnershipControlsRule' => [ 'type' => 'structure', 'required' => [ 'ObjectOwnership', ], 'members' => [ 'ObjectOwnership' => [ 'shape' => 'ObjectOwnership', ], ], ], 'OwnershipControlsRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'OwnershipControlsRule', ], 'flattened' => true, ], 'ParquetInput' => [ 'type' => 'structure', 'members' => [], ], 'Part' => [ 'type' => 'structure', 'members' => [ 'PartNumber' => [ 'shape' => 'PartNumber', ], 'LastModified' => [ 'shape' => 'LastModified', ], 'ETag' => [ 'shape' => 'ETag', ], 'Size' => [ 'shape' => 'Size', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', ], ], ], 'PartNumber' => [ 'type' => 'integer', ], 'PartNumberMarker' => [ 'type' => 'integer', ], 'PartitionDateSource' => [ 'type' => 'string', 'enum' => [ 'EventTime', 'DeliveryTime', ], ], 'PartitionedPrefix' => [ 'type' => 'structure', 'members' => [ 'PartitionDateSource' => [ 'shape' => 'PartitionDateSource', ], ], 'locationName' => 'PartitionedPrefix', ], 'Parts' => [ 'type' => 'list', 'member' => [ 'shape' => 'Part', ], 'flattened' => true, ], 'PartsCount' => [ 'type' => 'integer', 'box' => true, ], 'PartsList' => [ 'type' => 'list', 'member' => [ 'shape' => 'ObjectPart', ], 'flattened' => true, ], 'Payer' => [ 'type' => 'string', 'enum' => [ 'Requester', 'BucketOwner', ], ], 'Permission' => [ 'type' => 'string', 'enum' => [ 'FULL_CONTROL', 'WRITE', 'WRITE_ACP', 'READ', 'READ_ACP', ], ], 'Policy' => [ 'type' => 'string', ], 'PolicyStatus' => [ 'type' => 'structure', 'members' => [ 'IsPublic' => [ 'shape' => 'IsPublic', 'locationName' => 'IsPublic', ], ], ], 'Prefix' => [ 'type' => 'string', ], 'Priority' => [ 'type' => 'integer', 'box' => true, ], 'Progress' => [ 'type' => 'structure', 'members' => [ 'BytesScanned' => [ 'shape' => 'BytesScanned', ], 'BytesProcessed' => [ 'shape' => 'BytesProcessed', ], 'BytesReturned' => [ 'shape' => 'BytesReturned', ], ], ], 'ProgressEvent' => [ 'type' => 'structure', 'members' => [ 'Details' => [ 'shape' => 'Progress', 'eventpayload' => true, ], ], 'event' => true, ], 'Protocol' => [ 'type' => 'string', 'enum' => [ 'http', 'https', ], ], 'PublicAccessBlockConfiguration' => [ 'type' => 'structure', 'members' => [ 'BlockPublicAcls' => [ 'shape' => 'Setting', 'locationName' => 'BlockPublicAcls', ], 'IgnorePublicAcls' => [ 'shape' => 'Setting', 'locationName' => 'IgnorePublicAcls', ], 'BlockPublicPolicy' => [ 'shape' => 'Setting', 'locationName' => 'BlockPublicPolicy', ], 'RestrictPublicBuckets' => [ 'shape' => 'Setting', 'locationName' => 'RestrictPublicBuckets', ], ], ], 'PutBucketAccelerateConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'AccelerateConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'AccelerateConfiguration' => [ 'shape' => 'AccelerateConfiguration', 'locationName' => 'AccelerateConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], ], 'payload' => 'AccelerateConfiguration', ], 'PutBucketAclRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'ACL' => [ 'shape' => 'BucketCannedACL', 'location' => 'header', 'locationName' => 'x-amz-acl', ], 'AccessControlPolicy' => [ 'shape' => 'AccessControlPolicy', 'locationName' => 'AccessControlPolicy', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'GrantFullControl' => [ 'shape' => 'GrantFullControl', 'location' => 'header', 'locationName' => 'x-amz-grant-full-control', ], 'GrantRead' => [ 'shape' => 'GrantRead', 'location' => 'header', 'locationName' => 'x-amz-grant-read', ], 'GrantReadACP' => [ 'shape' => 'GrantReadACP', 'location' => 'header', 'locationName' => 'x-amz-grant-read-acp', ], 'GrantWrite' => [ 'shape' => 'GrantWrite', 'location' => 'header', 'locationName' => 'x-amz-grant-write', ], 'GrantWriteACP' => [ 'shape' => 'GrantWriteACP', 'location' => 'header', 'locationName' => 'x-amz-grant-write-acp', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'AccessControlPolicy', ], 'PutBucketAnalyticsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', 'AnalyticsConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'AnalyticsId', 'location' => 'querystring', 'locationName' => 'id', ], 'AnalyticsConfiguration' => [ 'shape' => 'AnalyticsConfiguration', 'locationName' => 'AnalyticsConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'AnalyticsConfiguration', ], 'PutBucketCorsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'CORSConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'CORSConfiguration' => [ 'shape' => 'CORSConfiguration', 'locationName' => 'CORSConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'CORSConfiguration', ], 'PutBucketEncryptionRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'ServerSideEncryptionConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ServerSideEncryptionConfiguration' => [ 'shape' => 'ServerSideEncryptionConfiguration', 'locationName' => 'ServerSideEncryptionConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'ServerSideEncryptionConfiguration', ], 'PutBucketIntelligentTieringConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', 'IntelligentTieringConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'IntelligentTieringId', 'location' => 'querystring', 'locationName' => 'id', ], 'IntelligentTieringConfiguration' => [ 'shape' => 'IntelligentTieringConfiguration', 'locationName' => 'IntelligentTieringConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], ], 'payload' => 'IntelligentTieringConfiguration', ], 'PutBucketInventoryConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', 'InventoryConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'InventoryId', 'location' => 'querystring', 'locationName' => 'id', ], 'InventoryConfiguration' => [ 'shape' => 'InventoryConfiguration', 'locationName' => 'InventoryConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'InventoryConfiguration', ], 'PutBucketLifecycleConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'TransitionDefaultMinimumObjectSize' => [ 'shape' => 'TransitionDefaultMinimumObjectSize', 'location' => 'header', 'locationName' => 'x-amz-transition-default-minimum-object-size', ], ], ], 'PutBucketLifecycleConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'LifecycleConfiguration' => [ 'shape' => 'BucketLifecycleConfiguration', 'locationName' => 'LifecycleConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'TransitionDefaultMinimumObjectSize' => [ 'shape' => 'TransitionDefaultMinimumObjectSize', 'location' => 'header', 'locationName' => 'x-amz-transition-default-minimum-object-size', ], ], 'payload' => 'LifecycleConfiguration', ], 'PutBucketLifecycleRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'LifecycleConfiguration' => [ 'shape' => 'LifecycleConfiguration', 'locationName' => 'LifecycleConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'LifecycleConfiguration', ], 'PutBucketLoggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'BucketLoggingStatus', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'BucketLoggingStatus' => [ 'shape' => 'BucketLoggingStatus', 'locationName' => 'BucketLoggingStatus', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'BucketLoggingStatus', ], 'PutBucketMetricsConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Id', 'MetricsConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Id' => [ 'shape' => 'MetricsId', 'location' => 'querystring', 'locationName' => 'id', ], 'MetricsConfiguration' => [ 'shape' => 'MetricsConfiguration', 'locationName' => 'MetricsConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'MetricsConfiguration', ], 'PutBucketNotificationConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'NotificationConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfiguration', 'locationName' => 'NotificationConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'SkipDestinationValidation' => [ 'shape' => 'SkipValidation', 'location' => 'header', 'locationName' => 'x-amz-skip-destination-validation', ], ], 'payload' => 'NotificationConfiguration', ], 'PutBucketNotificationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'NotificationConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'NotificationConfiguration' => [ 'shape' => 'NotificationConfigurationDeprecated', 'locationName' => 'NotificationConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'NotificationConfiguration', ], 'PutBucketOwnershipControlsRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'OwnershipControls', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'OwnershipControls' => [ 'shape' => 'OwnershipControls', 'locationName' => 'OwnershipControls', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], ], 'payload' => 'OwnershipControls', ], 'PutBucketPolicyRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Policy', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ConfirmRemoveSelfBucketAccess' => [ 'shape' => 'ConfirmRemoveSelfBucketAccess', 'location' => 'header', 'locationName' => 'x-amz-confirm-remove-self-bucket-access', ], 'Policy' => [ 'shape' => 'Policy', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'Policy', ], 'PutBucketReplicationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'ReplicationConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ReplicationConfiguration' => [ 'shape' => 'ReplicationConfiguration', 'locationName' => 'ReplicationConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'Token' => [ 'shape' => 'ObjectLockToken', 'location' => 'header', 'locationName' => 'x-amz-bucket-object-lock-token', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'ReplicationConfiguration', ], 'PutBucketRequestPaymentRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'RequestPaymentConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'RequestPaymentConfiguration' => [ 'shape' => 'RequestPaymentConfiguration', 'locationName' => 'RequestPaymentConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'RequestPaymentConfiguration', ], 'PutBucketTaggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Tagging', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'Tagging' => [ 'shape' => 'Tagging', 'locationName' => 'Tagging', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'Tagging', ], 'PutBucketVersioningRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'VersioningConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'MFA' => [ 'shape' => 'MFA', 'location' => 'header', 'locationName' => 'x-amz-mfa', ], 'VersioningConfiguration' => [ 'shape' => 'VersioningConfiguration', 'locationName' => 'VersioningConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'VersioningConfiguration', ], 'PutBucketWebsiteRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'WebsiteConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'WebsiteConfiguration' => [ 'shape' => 'WebsiteConfiguration', 'locationName' => 'WebsiteConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'WebsiteConfiguration', ], 'PutObjectAclOutput' => [ 'type' => 'structure', 'members' => [ 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'PutObjectAclRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'ACL' => [ 'shape' => 'ObjectCannedACL', 'location' => 'header', 'locationName' => 'x-amz-acl', ], 'AccessControlPolicy' => [ 'shape' => 'AccessControlPolicy', 'locationName' => 'AccessControlPolicy', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'GrantFullControl' => [ 'shape' => 'GrantFullControl', 'location' => 'header', 'locationName' => 'x-amz-grant-full-control', ], 'GrantRead' => [ 'shape' => 'GrantRead', 'location' => 'header', 'locationName' => 'x-amz-grant-read', ], 'GrantReadACP' => [ 'shape' => 'GrantReadACP', 'location' => 'header', 'locationName' => 'x-amz-grant-read-acp', ], 'GrantWrite' => [ 'shape' => 'GrantWrite', 'location' => 'header', 'locationName' => 'x-amz-grant-write', ], 'GrantWriteACP' => [ 'shape' => 'GrantWriteACP', 'location' => 'header', 'locationName' => 'x-amz-grant-write-acp', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'AccessControlPolicy', ], 'PutObjectLegalHoldOutput' => [ 'type' => 'structure', 'members' => [ 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'PutObjectLegalHoldRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'LegalHold' => [ 'shape' => 'ObjectLockLegalHold', 'locationName' => 'LegalHold', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'LegalHold', ], 'PutObjectLockConfigurationOutput' => [ 'type' => 'structure', 'members' => [ 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'PutObjectLockConfigurationRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ObjectLockConfiguration' => [ 'shape' => 'ObjectLockConfiguration', 'locationName' => 'ObjectLockConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'Token' => [ 'shape' => 'ObjectLockToken', 'location' => 'header', 'locationName' => 'x-amz-bucket-object-lock-token', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'ObjectLockConfiguration', ], 'PutObjectOutput' => [ 'type' => 'structure', 'members' => [ 'Expiration' => [ 'shape' => 'Expiration', 'location' => 'header', 'locationName' => 'x-amz-expiration', ], 'ETag' => [ 'shape' => 'ETag', 'location' => 'header', 'locationName' => 'ETag', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'Size' => [ 'shape' => 'Size', 'location' => 'header', 'locationName' => 'x-amz-object-size', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'PutObjectRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'ACL' => [ 'shape' => 'ObjectCannedACL', 'location' => 'header', 'locationName' => 'x-amz-acl', ], 'Body' => [ 'shape' => 'Body', 'streaming' => true, ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'CacheControl' => [ 'shape' => 'CacheControl', 'location' => 'header', 'locationName' => 'Cache-Control', ], 'ContentDisposition' => [ 'shape' => 'ContentDisposition', 'location' => 'header', 'locationName' => 'Content-Disposition', ], 'ContentEncoding' => [ 'shape' => 'ContentEncoding', 'location' => 'header', 'locationName' => 'Content-Encoding', ], 'ContentLanguage' => [ 'shape' => 'ContentLanguage', 'location' => 'header', 'locationName' => 'Content-Language', ], 'ContentLength' => [ 'shape' => 'ContentLength', 'location' => 'header', 'locationName' => 'Content-Length', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ContentType' => [ 'shape' => 'ContentType', 'location' => 'header', 'locationName' => 'Content-Type', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'Expires' => [ 'shape' => 'Expires', 'location' => 'header', 'locationName' => 'Expires', ], 'IfMatch' => [ 'shape' => 'IfMatch', 'location' => 'header', 'locationName' => 'If-Match', ], 'IfNoneMatch' => [ 'shape' => 'IfNoneMatch', 'location' => 'header', 'locationName' => 'If-None-Match', ], 'GrantFullControl' => [ 'shape' => 'GrantFullControl', 'location' => 'header', 'locationName' => 'x-amz-grant-full-control', ], 'GrantRead' => [ 'shape' => 'GrantRead', 'location' => 'header', 'locationName' => 'x-amz-grant-read', ], 'GrantReadACP' => [ 'shape' => 'GrantReadACP', 'location' => 'header', 'locationName' => 'x-amz-grant-read-acp', ], 'GrantWriteACP' => [ 'shape' => 'GrantWriteACP', 'location' => 'header', 'locationName' => 'x-amz-grant-write-acp', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'WriteOffsetBytes' => [ 'shape' => 'WriteOffsetBytes', 'location' => 'header', 'locationName' => 'x-amz-write-offset-bytes', ], 'Metadata' => [ 'shape' => 'Metadata', 'location' => 'headers', 'locationName' => 'x-amz-meta-', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'StorageClass' => [ 'shape' => 'StorageClass', 'location' => 'header', 'locationName' => 'x-amz-storage-class', ], 'WebsiteRedirectLocation' => [ 'shape' => 'WebsiteRedirectLocation', 'location' => 'header', 'locationName' => 'x-amz-website-redirect-location', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'SSEKMSEncryptionContext' => [ 'shape' => 'SSEKMSEncryptionContext', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-context', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'Tagging' => [ 'shape' => 'TaggingHeader', 'location' => 'header', 'locationName' => 'x-amz-tagging', ], 'ObjectLockMode' => [ 'shape' => 'ObjectLockMode', 'location' => 'header', 'locationName' => 'x-amz-object-lock-mode', ], 'ObjectLockRetainUntilDate' => [ 'shape' => 'ObjectLockRetainUntilDate', 'location' => 'header', 'locationName' => 'x-amz-object-lock-retain-until-date', ], 'ObjectLockLegalHoldStatus' => [ 'shape' => 'ObjectLockLegalHoldStatus', 'location' => 'header', 'locationName' => 'x-amz-object-lock-legal-hold', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'Body', ], 'PutObjectRetentionOutput' => [ 'type' => 'structure', 'members' => [ 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'PutObjectRetentionRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'Retention' => [ 'shape' => 'ObjectLockRetention', 'locationName' => 'Retention', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'BypassGovernanceRetention' => [ 'shape' => 'BypassGovernanceRetention', 'location' => 'header', 'locationName' => 'x-amz-bypass-governance-retention', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'Retention', ], 'PutObjectTaggingOutput' => [ 'type' => 'structure', 'members' => [ 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-version-id', ], ], ], 'PutObjectTaggingRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'Tagging', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'Tagging' => [ 'shape' => 'Tagging', 'locationName' => 'Tagging', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], ], 'payload' => 'Tagging', ], 'PutPublicAccessBlockRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'PublicAccessBlockConfiguration', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'PublicAccessBlockConfiguration' => [ 'shape' => 'PublicAccessBlockConfiguration', 'locationName' => 'PublicAccessBlockConfiguration', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'PublicAccessBlockConfiguration', ], 'QueueArn' => [ 'type' => 'string', ], 'QueueConfiguration' => [ 'type' => 'structure', 'required' => [ 'QueueArn', 'Events', ], 'members' => [ 'Id' => [ 'shape' => 'NotificationId', ], 'QueueArn' => [ 'shape' => 'QueueArn', 'locationName' => 'Queue', ], 'Events' => [ 'shape' => 'EventList', 'locationName' => 'Event', ], 'Filter' => [ 'shape' => 'NotificationConfigurationFilter', ], ], ], 'QueueConfigurationDeprecated' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'NotificationId', ], 'Event' => [ 'shape' => 'Event', 'deprecated' => true, ], 'Events' => [ 'shape' => 'EventList', 'locationName' => 'Event', ], 'Queue' => [ 'shape' => 'QueueArn', ], ], ], 'QueueConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'QueueConfiguration', ], 'flattened' => true, ], 'Quiet' => [ 'type' => 'boolean', 'box' => true, ], 'QuoteCharacter' => [ 'type' => 'string', ], 'QuoteEscapeCharacter' => [ 'type' => 'string', ], 'QuoteFields' => [ 'type' => 'string', 'enum' => [ 'ALWAYS', 'ASNEEDED', ], ], 'Range' => [ 'type' => 'string', ], 'RecordDelimiter' => [ 'type' => 'string', ], 'RecordsEvent' => [ 'type' => 'structure', 'members' => [ 'Payload' => [ 'shape' => 'Body', 'eventpayload' => true, ], ], 'event' => true, ], 'Redirect' => [ 'type' => 'structure', 'members' => [ 'HostName' => [ 'shape' => 'HostName', ], 'HttpRedirectCode' => [ 'shape' => 'HttpRedirectCode', ], 'Protocol' => [ 'shape' => 'Protocol', ], 'ReplaceKeyPrefixWith' => [ 'shape' => 'ReplaceKeyPrefixWith', ], 'ReplaceKeyWith' => [ 'shape' => 'ReplaceKeyWith', ], ], ], 'RedirectAllRequestsTo' => [ 'type' => 'structure', 'required' => [ 'HostName', ], 'members' => [ 'HostName' => [ 'shape' => 'HostName', ], 'Protocol' => [ 'shape' => 'Protocol', ], ], ], 'Region' => [ 'type' => 'string', 'max' => 20, 'min' => 0, ], 'ReplaceKeyPrefixWith' => [ 'type' => 'string', ], 'ReplaceKeyWith' => [ 'type' => 'string', ], 'ReplicaKmsKeyID' => [ 'type' => 'string', ], 'ReplicaModifications' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'ReplicaModificationsStatus', ], ], ], 'ReplicaModificationsStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ReplicationConfiguration' => [ 'type' => 'structure', 'required' => [ 'Role', 'Rules', ], 'members' => [ 'Role' => [ 'shape' => 'Role', ], 'Rules' => [ 'shape' => 'ReplicationRules', 'locationName' => 'Rule', ], ], ], 'ReplicationRule' => [ 'type' => 'structure', 'required' => [ 'Status', 'Destination', ], 'members' => [ 'ID' => [ 'shape' => 'ID', ], 'Priority' => [ 'shape' => 'Priority', ], 'Prefix' => [ 'shape' => 'Prefix', 'deprecated' => true, ], 'Filter' => [ 'shape' => 'ReplicationRuleFilter', ], 'Status' => [ 'shape' => 'ReplicationRuleStatus', ], 'SourceSelectionCriteria' => [ 'shape' => 'SourceSelectionCriteria', ], 'ExistingObjectReplication' => [ 'shape' => 'ExistingObjectReplication', ], 'Destination' => [ 'shape' => 'Destination', ], 'DeleteMarkerReplication' => [ 'shape' => 'DeleteMarkerReplication', ], ], ], 'ReplicationRuleAndOperator' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tags' => [ 'shape' => 'TagSet', 'flattened' => true, 'locationName' => 'Tag', ], ], ], 'ReplicationRuleFilter' => [ 'type' => 'structure', 'members' => [ 'Prefix' => [ 'shape' => 'Prefix', ], 'Tag' => [ 'shape' => 'Tag', ], 'And' => [ 'shape' => 'ReplicationRuleAndOperator', ], ], ], 'ReplicationRuleStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ReplicationRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ReplicationRule', ], 'flattened' => true, ], 'ReplicationStatus' => [ 'type' => 'string', 'enum' => [ 'COMPLETE', 'PENDING', 'FAILED', 'REPLICA', 'COMPLETED', ], ], 'ReplicationTime' => [ 'type' => 'structure', 'required' => [ 'Status', 'Time', ], 'members' => [ 'Status' => [ 'shape' => 'ReplicationTimeStatus', ], 'Time' => [ 'shape' => 'ReplicationTimeValue', ], ], ], 'ReplicationTimeStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'ReplicationTimeValue' => [ 'type' => 'structure', 'members' => [ 'Minutes' => [ 'shape' => 'Minutes', ], ], ], 'RequestCharged' => [ 'type' => 'string', 'enum' => [ 'requester', ], ], 'RequestPayer' => [ 'type' => 'string', 'enum' => [ 'requester', ], ], 'RequestPaymentConfiguration' => [ 'type' => 'structure', 'required' => [ 'Payer', ], 'members' => [ 'Payer' => [ 'shape' => 'Payer', ], ], ], 'RequestProgress' => [ 'type' => 'structure', 'members' => [ 'Enabled' => [ 'shape' => 'EnableRequestProgress', ], ], ], 'RequestRoute' => [ 'type' => 'string', ], 'RequestToken' => [ 'type' => 'string', ], 'ResponseCacheControl' => [ 'type' => 'string', ], 'ResponseContentDisposition' => [ 'type' => 'string', ], 'ResponseContentEncoding' => [ 'type' => 'string', ], 'ResponseContentLanguage' => [ 'type' => 'string', ], 'ResponseContentType' => [ 'type' => 'string', ], 'ResponseExpires' => [ 'type' => 'timestamp', 'timestampFormat' => 'rfc822', ], 'Restore' => [ 'type' => 'string', ], 'RestoreExpiryDate' => [ 'type' => 'timestamp', ], 'RestoreObjectOutput' => [ 'type' => 'structure', 'members' => [ 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], 'RestoreOutputPath' => [ 'shape' => 'RestoreOutputPath', 'location' => 'header', 'locationName' => 'x-amz-restore-output-path', ], ], ], 'RestoreObjectRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'querystring', 'locationName' => 'versionId', ], 'RestoreRequest' => [ 'shape' => 'RestoreRequest', 'locationName' => 'RestoreRequest', 'xmlNamespace' => [ 'uri' => 'http://s3.amazonaws.com/doc/2006-03-01/', ], ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'RestoreRequest', ], 'RestoreOutputPath' => [ 'type' => 'string', ], 'RestoreRequest' => [ 'type' => 'structure', 'members' => [ 'Days' => [ 'shape' => 'Days', ], 'GlacierJobParameters' => [ 'shape' => 'GlacierJobParameters', ], 'Type' => [ 'shape' => 'RestoreRequestType', ], 'Tier' => [ 'shape' => 'Tier', ], 'Description' => [ 'shape' => 'Description', ], 'SelectParameters' => [ 'shape' => 'SelectParameters', ], 'OutputLocation' => [ 'shape' => 'OutputLocation', ], ], ], 'RestoreRequestType' => [ 'type' => 'string', 'enum' => [ 'SELECT', ], ], 'RestoreStatus' => [ 'type' => 'structure', 'members' => [ 'IsRestoreInProgress' => [ 'shape' => 'IsRestoreInProgress', ], 'RestoreExpiryDate' => [ 'shape' => 'RestoreExpiryDate', ], ], ], 'Role' => [ 'type' => 'string', ], 'RoutingRule' => [ 'type' => 'structure', 'required' => [ 'Redirect', ], 'members' => [ 'Condition' => [ 'shape' => 'Condition', ], 'Redirect' => [ 'shape' => 'Redirect', ], ], ], 'RoutingRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'RoutingRule', 'locationName' => 'RoutingRule', ], ], 'Rule' => [ 'type' => 'structure', 'required' => [ 'Prefix', 'Status', ], 'members' => [ 'Expiration' => [ 'shape' => 'LifecycleExpiration', ], 'ID' => [ 'shape' => 'ID', ], 'Prefix' => [ 'shape' => 'Prefix', ], 'Status' => [ 'shape' => 'ExpirationStatus', ], 'Transition' => [ 'shape' => 'Transition', ], 'NoncurrentVersionTransition' => [ 'shape' => 'NoncurrentVersionTransition', ], 'NoncurrentVersionExpiration' => [ 'shape' => 'NoncurrentVersionExpiration', ], 'AbortIncompleteMultipartUpload' => [ 'shape' => 'AbortIncompleteMultipartUpload', ], ], ], 'Rules' => [ 'type' => 'list', 'member' => [ 'shape' => 'Rule', ], 'flattened' => true, ], 'S3KeyFilter' => [ 'type' => 'structure', 'members' => [ 'FilterRules' => [ 'shape' => 'FilterRuleList', 'locationName' => 'FilterRule', ], ], ], 'S3Location' => [ 'type' => 'structure', 'required' => [ 'BucketName', 'Prefix', ], 'members' => [ 'BucketName' => [ 'shape' => 'BucketName', ], 'Prefix' => [ 'shape' => 'LocationPrefix', ], 'Encryption' => [ 'shape' => 'Encryption', ], 'CannedACL' => [ 'shape' => 'ObjectCannedACL', ], 'AccessControlList' => [ 'shape' => 'Grants', ], 'Tagging' => [ 'shape' => 'Tagging', ], 'UserMetadata' => [ 'shape' => 'UserMetadata', ], 'StorageClass' => [ 'shape' => 'StorageClass', ], ], ], 'SSECustomerAlgorithm' => [ 'type' => 'string', ], 'SSECustomerKey' => [ 'type' => 'string', 'sensitive' => true, ], 'SSECustomerKeyMD5' => [ 'type' => 'string', ], 'SSEKMS' => [ 'type' => 'structure', 'required' => [ 'KeyId', ], 'members' => [ 'KeyId' => [ 'shape' => 'SSEKMSKeyId', ], ], 'locationName' => 'SSE-KMS', ], 'SSEKMSEncryptionContext' => [ 'type' => 'string', 'sensitive' => true, ], 'SSEKMSKeyId' => [ 'type' => 'string', 'sensitive' => true, ], 'SSES3' => [ 'type' => 'structure', 'members' => [], 'locationName' => 'SSE-S3', ], 'ScanRange' => [ 'type' => 'structure', 'members' => [ 'Start' => [ 'shape' => 'Start', ], 'End' => [ 'shape' => 'End', ], ], ], 'SelectObjectContentEventStream' => [ 'type' => 'structure', 'members' => [ 'Records' => [ 'shape' => 'RecordsEvent', ], 'Stats' => [ 'shape' => 'StatsEvent', ], 'Progress' => [ 'shape' => 'ProgressEvent', ], 'Cont' => [ 'shape' => 'ContinuationEvent', ], 'End' => [ 'shape' => 'EndEvent', ], ], 'eventstream' => true, ], 'SelectObjectContentOutput' => [ 'type' => 'structure', 'members' => [ 'Payload' => [ 'shape' => 'SelectObjectContentEventStream', ], ], 'payload' => 'Payload', ], 'SelectObjectContentRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'Expression', 'ExpressionType', 'InputSerialization', 'OutputSerialization', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'Expression' => [ 'shape' => 'Expression', ], 'ExpressionType' => [ 'shape' => 'ExpressionType', ], 'RequestProgress' => [ 'shape' => 'RequestProgress', ], 'InputSerialization' => [ 'shape' => 'InputSerialization', ], 'OutputSerialization' => [ 'shape' => 'OutputSerialization', ], 'ScanRange' => [ 'shape' => 'ScanRange', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], ], 'SelectParameters' => [ 'type' => 'structure', 'required' => [ 'InputSerialization', 'ExpressionType', 'Expression', 'OutputSerialization', ], 'members' => [ 'InputSerialization' => [ 'shape' => 'InputSerialization', ], 'ExpressionType' => [ 'shape' => 'ExpressionType', ], 'Expression' => [ 'shape' => 'Expression', ], 'OutputSerialization' => [ 'shape' => 'OutputSerialization', ], ], ], 'ServerSideEncryption' => [ 'type' => 'string', 'enum' => [ 'AES256', 'aws:kms', 'aws:kms:dsse', ], ], 'ServerSideEncryptionByDefault' => [ 'type' => 'structure', 'required' => [ 'SSEAlgorithm', ], 'members' => [ 'SSEAlgorithm' => [ 'shape' => 'ServerSideEncryption', ], 'KMSMasterKeyID' => [ 'shape' => 'SSEKMSKeyId', ], ], ], 'ServerSideEncryptionConfiguration' => [ 'type' => 'structure', 'required' => [ 'Rules', ], 'members' => [ 'Rules' => [ 'shape' => 'ServerSideEncryptionRules', 'locationName' => 'Rule', ], ], ], 'ServerSideEncryptionRule' => [ 'type' => 'structure', 'members' => [ 'ApplyServerSideEncryptionByDefault' => [ 'shape' => 'ServerSideEncryptionByDefault', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', ], ], ], 'ServerSideEncryptionRules' => [ 'type' => 'list', 'member' => [ 'shape' => 'ServerSideEncryptionRule', ], 'flattened' => true, ], 'SessionCredentialValue' => [ 'type' => 'string', 'sensitive' => true, ], 'SessionCredentials' => [ 'type' => 'structure', 'required' => [ 'AccessKeyId', 'SecretAccessKey', 'SessionToken', 'Expiration', ], 'members' => [ 'AccessKeyId' => [ 'shape' => 'AccessKeyIdValue', 'locationName' => 'AccessKeyId', ], 'SecretAccessKey' => [ 'shape' => 'SessionCredentialValue', 'locationName' => 'SecretAccessKey', ], 'SessionToken' => [ 'shape' => 'SessionCredentialValue', 'locationName' => 'SessionToken', ], 'Expiration' => [ 'shape' => 'SessionExpiration', 'locationName' => 'Expiration', ], ], ], 'SessionExpiration' => [ 'type' => 'timestamp', ], 'SessionMode' => [ 'type' => 'string', 'enum' => [ 'ReadOnly', 'ReadWrite', ], ], 'Setting' => [ 'type' => 'boolean', 'box' => true, ], 'SimplePrefix' => [ 'type' => 'structure', 'members' => [], 'locationName' => 'SimplePrefix', ], 'Size' => [ 'type' => 'long', 'box' => true, ], 'SkipValidation' => [ 'type' => 'boolean', 'box' => true, ], 'SourceSelectionCriteria' => [ 'type' => 'structure', 'members' => [ 'SseKmsEncryptedObjects' => [ 'shape' => 'SseKmsEncryptedObjects', ], 'ReplicaModifications' => [ 'shape' => 'ReplicaModifications', ], ], ], 'SseKmsEncryptedObjects' => [ 'type' => 'structure', 'required' => [ 'Status', ], 'members' => [ 'Status' => [ 'shape' => 'SseKmsEncryptedObjectsStatus', ], ], ], 'SseKmsEncryptedObjectsStatus' => [ 'type' => 'string', 'enum' => [ 'Enabled', 'Disabled', ], ], 'Start' => [ 'type' => 'long', 'box' => true, ], 'StartAfter' => [ 'type' => 'string', ], 'Stats' => [ 'type' => 'structure', 'members' => [ 'BytesScanned' => [ 'shape' => 'BytesScanned', ], 'BytesProcessed' => [ 'shape' => 'BytesProcessed', ], 'BytesReturned' => [ 'shape' => 'BytesReturned', ], ], ], 'StatsEvent' => [ 'type' => 'structure', 'members' => [ 'Details' => [ 'shape' => 'Stats', 'eventpayload' => true, ], ], 'event' => true, ], 'StorageClass' => [ 'type' => 'string', 'enum' => [ 'STANDARD', 'REDUCED_REDUNDANCY', 'STANDARD_IA', 'ONEZONE_IA', 'INTELLIGENT_TIERING', 'GLACIER', 'DEEP_ARCHIVE', 'OUTPOSTS', 'GLACIER_IR', 'SNOW', 'EXPRESS_ONEZONE', ], ], 'StorageClassAnalysis' => [ 'type' => 'structure', 'members' => [ 'DataExport' => [ 'shape' => 'StorageClassAnalysisDataExport', ], ], ], 'StorageClassAnalysisDataExport' => [ 'type' => 'structure', 'required' => [ 'OutputSchemaVersion', 'Destination', ], 'members' => [ 'OutputSchemaVersion' => [ 'shape' => 'StorageClassAnalysisSchemaVersion', ], 'Destination' => [ 'shape' => 'AnalyticsExportDestination', ], ], ], 'StorageClassAnalysisSchemaVersion' => [ 'type' => 'string', 'enum' => [ 'V_1', ], ], 'Suffix' => [ 'type' => 'string', ], 'Tag' => [ 'type' => 'structure', 'required' => [ 'Key', 'Value', ], 'members' => [ 'Key' => [ 'shape' => 'ObjectKey', ], 'Value' => [ 'shape' => 'Value', ], ], ], 'TagCount' => [ 'type' => 'integer', 'box' => true, ], 'TagSet' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tag', 'locationName' => 'Tag', ], ], 'Tagging' => [ 'type' => 'structure', 'required' => [ 'TagSet', ], 'members' => [ 'TagSet' => [ 'shape' => 'TagSet', ], ], ], 'TaggingDirective' => [ 'type' => 'string', 'enum' => [ 'COPY', 'REPLACE', ], ], 'TaggingHeader' => [ 'type' => 'string', ], 'TargetBucket' => [ 'type' => 'string', ], 'TargetGrant' => [ 'type' => 'structure', 'members' => [ 'Grantee' => [ 'shape' => 'Grantee', ], 'Permission' => [ 'shape' => 'BucketLogsPermission', ], ], ], 'TargetGrants' => [ 'type' => 'list', 'member' => [ 'shape' => 'TargetGrant', 'locationName' => 'Grant', ], ], 'TargetObjectKeyFormat' => [ 'type' => 'structure', 'members' => [ 'SimplePrefix' => [ 'shape' => 'SimplePrefix', 'locationName' => 'SimplePrefix', ], 'PartitionedPrefix' => [ 'shape' => 'PartitionedPrefix', 'locationName' => 'PartitionedPrefix', ], ], ], 'TargetPrefix' => [ 'type' => 'string', ], 'Tier' => [ 'type' => 'string', 'enum' => [ 'Standard', 'Bulk', 'Expedited', ], ], 'Tiering' => [ 'type' => 'structure', 'required' => [ 'Days', 'AccessTier', ], 'members' => [ 'Days' => [ 'shape' => 'IntelligentTieringDays', ], 'AccessTier' => [ 'shape' => 'IntelligentTieringAccessTier', ], ], ], 'TieringList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Tiering', ], 'flattened' => true, ], 'Token' => [ 'type' => 'string', ], 'TooManyParts' => [ 'type' => 'structure', 'members' => [], 'error' => [ 'httpStatusCode' => 400, ], 'exception' => true, ], 'TopicArn' => [ 'type' => 'string', ], 'TopicConfiguration' => [ 'type' => 'structure', 'required' => [ 'TopicArn', 'Events', ], 'members' => [ 'Id' => [ 'shape' => 'NotificationId', ], 'TopicArn' => [ 'shape' => 'TopicArn', 'locationName' => 'Topic', ], 'Events' => [ 'shape' => 'EventList', 'locationName' => 'Event', ], 'Filter' => [ 'shape' => 'NotificationConfigurationFilter', ], ], ], 'TopicConfigurationDeprecated' => [ 'type' => 'structure', 'members' => [ 'Id' => [ 'shape' => 'NotificationId', ], 'Events' => [ 'shape' => 'EventList', 'locationName' => 'Event', ], 'Event' => [ 'shape' => 'Event', 'deprecated' => true, ], 'Topic' => [ 'shape' => 'TopicArn', ], ], ], 'TopicConfigurationList' => [ 'type' => 'list', 'member' => [ 'shape' => 'TopicConfiguration', ], 'flattened' => true, ], 'Transition' => [ 'type' => 'structure', 'members' => [ 'Date' => [ 'shape' => 'Date', ], 'Days' => [ 'shape' => 'Days', ], 'StorageClass' => [ 'shape' => 'TransitionStorageClass', ], ], ], 'TransitionDefaultMinimumObjectSize' => [ 'type' => 'string', 'enum' => [ 'varies_by_storage_class', 'all_storage_classes_128K', ], ], 'TransitionList' => [ 'type' => 'list', 'member' => [ 'shape' => 'Transition', ], 'flattened' => true, ], 'TransitionStorageClass' => [ 'type' => 'string', 'enum' => [ 'GLACIER', 'STANDARD_IA', 'ONEZONE_IA', 'INTELLIGENT_TIERING', 'DEEP_ARCHIVE', 'GLACIER_IR', ], ], 'Type' => [ 'type' => 'string', 'enum' => [ 'CanonicalUser', 'AmazonCustomerByEmail', 'Group', ], ], 'URI' => [ 'type' => 'string', ], 'UploadIdMarker' => [ 'type' => 'string', ], 'UploadPartCopyOutput' => [ 'type' => 'structure', 'members' => [ 'CopySourceVersionId' => [ 'shape' => 'CopySourceVersionId', 'location' => 'header', 'locationName' => 'x-amz-copy-source-version-id', ], 'CopyPartResult' => [ 'shape' => 'CopyPartResult', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], 'payload' => 'CopyPartResult', ], 'UploadPartCopyRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'CopySource', 'Key', 'PartNumber', 'UploadId', ], 'members' => [ 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'CopySource' => [ 'shape' => 'CopySource', 'location' => 'header', 'locationName' => 'x-amz-copy-source', ], 'CopySourceIfMatch' => [ 'shape' => 'CopySourceIfMatch', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-match', ], 'CopySourceIfModifiedSince' => [ 'shape' => 'CopySourceIfModifiedSince', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-modified-since', ], 'CopySourceIfNoneMatch' => [ 'shape' => 'CopySourceIfNoneMatch', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-none-match', ], 'CopySourceIfUnmodifiedSince' => [ 'shape' => 'CopySourceIfUnmodifiedSince', 'location' => 'header', 'locationName' => 'x-amz-copy-source-if-unmodified-since', ], 'CopySourceRange' => [ 'shape' => 'CopySourceRange', 'location' => 'header', 'locationName' => 'x-amz-copy-source-range', ], 'Key' => [ 'shape' => 'ObjectKey', 'location' => 'uri', 'locationName' => 'Key', ], 'PartNumber' => [ 'shape' => 'PartNumber', 'location' => 'querystring', 'locationName' => 'partNumber', ], 'UploadId' => [ 'shape' => 'MultipartUploadId', 'location' => 'querystring', 'locationName' => 'uploadId', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'CopySourceSSECustomerAlgorithm' => [ 'shape' => 'CopySourceSSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-copy-source-server-side-encryption-customer-algorithm', ], 'CopySourceSSECustomerKey' => [ 'shape' => 'CopySourceSSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-copy-source-server-side-encryption-customer-key', ], 'CopySourceSSECustomerKeyMD5' => [ 'shape' => 'CopySourceSSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-copy-source-server-side-encryption-customer-key-MD5', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], 'ExpectedSourceBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-source-expected-bucket-owner', ], ], ], 'UploadPartOutput' => [ 'type' => 'structure', 'members' => [ 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption', ], 'ETag' => [ 'shape' => 'ETag', 'location' => 'header', 'locationName' => 'ETag', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-aws-kms-key-id', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-bucket-key-enabled', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-request-charged', ], ], ], 'UploadPartRequest' => [ 'type' => 'structure', 'required' => [ 'Bucket', 'Key', 'PartNumber', 'UploadId', ], 'members' => [ 'Body' => [ 'shape' => 'Body', 'streaming' => true, ], 'Bucket' => [ 'shape' => 'BucketName', 'contextParam' => [ 'name' => 'Bucket', ], 'location' => 'uri', 'locationName' => 'Bucket', ], 'ContentLength' => [ 'shape' => 'ContentLength', 'location' => 'header', 'locationName' => 'Content-Length', ], 'ContentMD5' => [ 'shape' => 'ContentMD5', 'location' => 'header', 'locationName' => 'Content-MD5', ], 'ChecksumAlgorithm' => [ 'shape' => 'ChecksumAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-sdk-checksum-algorithm', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-checksum-sha256', ], 'Key' => [ 'shape' => 'ObjectKey', 'contextParam' => [ 'name' => 'Key', ], 'location' => 'uri', 'locationName' => 'Key', ], 'PartNumber' => [ 'shape' => 'PartNumber', 'location' => 'querystring', 'locationName' => 'partNumber', ], 'UploadId' => [ 'shape' => 'MultipartUploadId', 'location' => 'querystring', 'locationName' => 'uploadId', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-algorithm', ], 'SSECustomerKey' => [ 'shape' => 'SSECustomerKey', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-server-side-encryption-customer-key-MD5', ], 'RequestPayer' => [ 'shape' => 'RequestPayer', 'location' => 'header', 'locationName' => 'x-amz-request-payer', ], 'ExpectedBucketOwner' => [ 'shape' => 'AccountId', 'location' => 'header', 'locationName' => 'x-amz-expected-bucket-owner', ], ], 'payload' => 'Body', ], 'UserMetadata' => [ 'type' => 'list', 'member' => [ 'shape' => 'MetadataEntry', 'locationName' => 'MetadataEntry', ], ], 'Value' => [ 'type' => 'string', ], 'VersionCount' => [ 'type' => 'integer', 'box' => true, ], 'VersionIdMarker' => [ 'type' => 'string', ], 'VersioningConfiguration' => [ 'type' => 'structure', 'members' => [ 'MFADelete' => [ 'shape' => 'MFADelete', 'locationName' => 'MfaDelete', ], 'Status' => [ 'shape' => 'BucketVersioningStatus', ], ], ], 'WebsiteConfiguration' => [ 'type' => 'structure', 'members' => [ 'ErrorDocument' => [ 'shape' => 'ErrorDocument', ], 'IndexDocument' => [ 'shape' => 'IndexDocument', ], 'RedirectAllRequestsTo' => [ 'shape' => 'RedirectAllRequestsTo', ], 'RoutingRules' => [ 'shape' => 'RoutingRules', ], ], ], 'WebsiteRedirectLocation' => [ 'type' => 'string', ], 'WriteGetObjectResponseRequest' => [ 'type' => 'structure', 'required' => [ 'RequestRoute', 'RequestToken', ], 'members' => [ 'RequestRoute' => [ 'shape' => 'RequestRoute', 'hostLabel' => true, 'location' => 'header', 'locationName' => 'x-amz-request-route', ], 'RequestToken' => [ 'shape' => 'RequestToken', 'location' => 'header', 'locationName' => 'x-amz-request-token', ], 'Body' => [ 'shape' => 'Body', 'streaming' => true, ], 'StatusCode' => [ 'shape' => 'GetObjectResponseStatusCode', 'location' => 'header', 'locationName' => 'x-amz-fwd-status', ], 'ErrorCode' => [ 'shape' => 'ErrorCode', 'location' => 'header', 'locationName' => 'x-amz-fwd-error-code', ], 'ErrorMessage' => [ 'shape' => 'ErrorMessage', 'location' => 'header', 'locationName' => 'x-amz-fwd-error-message', ], 'AcceptRanges' => [ 'shape' => 'AcceptRanges', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-accept-ranges', ], 'CacheControl' => [ 'shape' => 'CacheControl', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Cache-Control', ], 'ContentDisposition' => [ 'shape' => 'ContentDisposition', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Content-Disposition', ], 'ContentEncoding' => [ 'shape' => 'ContentEncoding', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Content-Encoding', ], 'ContentLanguage' => [ 'shape' => 'ContentLanguage', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Content-Language', ], 'ContentLength' => [ 'shape' => 'ContentLength', 'location' => 'header', 'locationName' => 'Content-Length', ], 'ContentRange' => [ 'shape' => 'ContentRange', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Content-Range', ], 'ContentType' => [ 'shape' => 'ContentType', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Content-Type', ], 'ChecksumCRC32' => [ 'shape' => 'ChecksumCRC32', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-checksum-crc32', ], 'ChecksumCRC32C' => [ 'shape' => 'ChecksumCRC32C', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-checksum-crc32c', ], 'ChecksumSHA1' => [ 'shape' => 'ChecksumSHA1', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-checksum-sha1', ], 'ChecksumSHA256' => [ 'shape' => 'ChecksumSHA256', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-checksum-sha256', ], 'DeleteMarker' => [ 'shape' => 'DeleteMarker', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-delete-marker', ], 'ETag' => [ 'shape' => 'ETag', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-ETag', ], 'Expires' => [ 'shape' => 'Expires', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Expires', ], 'Expiration' => [ 'shape' => 'Expiration', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-expiration', ], 'LastModified' => [ 'shape' => 'LastModified', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-Last-Modified', ], 'MissingMeta' => [ 'shape' => 'MissingMeta', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-missing-meta', ], 'Metadata' => [ 'shape' => 'Metadata', 'location' => 'headers', 'locationName' => 'x-amz-meta-', ], 'ObjectLockMode' => [ 'shape' => 'ObjectLockMode', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-object-lock-mode', ], 'ObjectLockLegalHoldStatus' => [ 'shape' => 'ObjectLockLegalHoldStatus', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-object-lock-legal-hold', ], 'ObjectLockRetainUntilDate' => [ 'shape' => 'ObjectLockRetainUntilDate', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-object-lock-retain-until-date', ], 'PartsCount' => [ 'shape' => 'PartsCount', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-mp-parts-count', ], 'ReplicationStatus' => [ 'shape' => 'ReplicationStatus', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-replication-status', ], 'RequestCharged' => [ 'shape' => 'RequestCharged', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-request-charged', ], 'Restore' => [ 'shape' => 'Restore', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-restore', ], 'ServerSideEncryption' => [ 'shape' => 'ServerSideEncryption', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-server-side-encryption', ], 'SSECustomerAlgorithm' => [ 'shape' => 'SSECustomerAlgorithm', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-server-side-encryption-customer-algorithm', ], 'SSEKMSKeyId' => [ 'shape' => 'SSEKMSKeyId', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-server-side-encryption-aws-kms-key-id', ], 'SSECustomerKeyMD5' => [ 'shape' => 'SSECustomerKeyMD5', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-server-side-encryption-customer-key-MD5', ], 'StorageClass' => [ 'shape' => 'StorageClass', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-storage-class', ], 'TagCount' => [ 'shape' => 'TagCount', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-tagging-count', ], 'VersionId' => [ 'shape' => 'ObjectVersionId', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-version-id', ], 'BucketKeyEnabled' => [ 'shape' => 'BucketKeyEnabled', 'location' => 'header', 'locationName' => 'x-amz-fwd-header-x-amz-server-side-encryption-bucket-key-enabled', ], ], 'payload' => 'Body', ], 'WriteOffsetBytes' => [ 'type' => 'long', 'box' => true, ], 'Years' => [ 'type' => 'integer', 'box' => true, ], ], 'clientContextParams' => [ 'Accelerate' => [ 'documentation' => 'Enables this client to use S3 Transfer Acceleration endpoints.', 'type' => 'boolean', ], 'DisableMultiRegionAccessPoints' => [ 'documentation' => 'Disables this client\'s usage of Multi-Region Access Points.', 'type' => 'boolean', ], 'DisableS3ExpressSessionAuth' => [ 'documentation' => 'Disables this client\'s usage of Session Auth for S3Express buckets and reverts to using conventional SigV4 for those.', 'type' => 'boolean', ], 'ForcePathStyle' => [ 'documentation' => 'Forces this client to use path-style addressing for buckets.', 'type' => 'boolean', ], 'UseArnRegion' => [ 'documentation' => 'Enables this client to use an ARN\'s region when constructing an endpoint instead of the client\'s configured region.', 'type' => 'boolean', ], ],]; diff --git a/src/data/s3/2006-03-01/docs-2.json b/src/data/s3/2006-03-01/docs-2.json index 27c1be83c8..a7a8d4ff79 100644 --- a/src/data/s3/2006-03-01/docs-2.json +++ b/src/data/s3/2006-03-01/docs-2.json @@ -87,7 +87,7 @@ "PutBucketReplication": "

This operation is not supported for directory buckets.

Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.

Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets 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. You can invoke this request for a specific Amazon Web Services Region by using the aws:RequestedRegion condition key.

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.

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.

If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.

For information about enabling versioning on a bucket, see Using Versioning.

Handling Replication of Encrypted Objects

By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using KMS keys.

For information on PutBucketReplication errors, see List of replication-related error codes

Permissions

To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration permissions for the bucket.

By default, a resource owner, in this case the Amazon Web Services 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.

To perform this operation, the user or role performing the action must have the iam:PassRole permission.

The following operations are related to PutBucketReplication:

", "PutBucketRequestPayment": "

This operation is not supported for directory buckets.

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.

The following operations are related to PutBucketRequestPayment:

", "PutBucketTagging": "

This operation is not supported for directory buckets.

Sets the tags for a bucket.

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

When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.

To use this operation, you must have permissions to perform the s3:PutBucketTagging 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.

PutBucketTagging has the following special errors. For more Amazon S3 errors see, Error Responses.

The following operations are related to PutBucketTagging:

", - "PutBucketVersioning": "

This operation is not supported for directory buckets.

When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (PUT or DELETE) on objects in the bucket.

Sets the versioning state of an existing bucket.

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.

In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you 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 configuration 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 configuration 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.

The following operations are related to PutBucketVersioning:

", + "PutBucketVersioning": "

This operation is not supported for directory buckets.

When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. While this change is propagating, you may encounter intermittent HTTP 404 NoSuchKey errors for requests to objects created or updated after enabling versioning. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (PUT or DELETE) on objects in the bucket.

Sets the versioning state of an existing bucket.

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.

In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you 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 configuration 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 configuration 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.

The following operations are related to PutBucketVersioning:

", "PutBucketWebsite": "

This operation is not supported for directory buckets.

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 action 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.

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.

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the Amazon S3 User Guide.

The maximum request length is limited to 128 KB.

", "PutObject": "

Adds an object to a 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. However, Amazon S3 provides features that can modify this behavior:

Permissions

  • General purpose bucket permissions - The following permissions are required in your policies when your PutObject request includes specific headers.

    • s3:PutObject - To successfully complete the PutObject request, you must always have the s3:PutObject permission on a bucket to add an object to it.

    • s3:PutObjectAcl - To successfully change the objects ACL of your PutObject request, you must have the s3:PutObjectAcl.

    • s3:PutObjectTagging - To successfully set the tag-set with your PutObject request, you must have the s3:PutObjectTagging.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

Data integrity with Content-MD5

  • General purpose bucket - 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, Amazon S3 returns an error. Alternatively, when the object's ETag is its MD5 digest, you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

  • Directory bucket - This functionality is not supported for directory buckets.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

For more information about related Amazon S3 APIs, see the following:

", "PutObjectAcl": "

This operation is not supported for directory buckets.

Uses the acl subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have the WRITE_ACP permission to set the ACL of an object. For more information, see What permissions can I grant? in the Amazon S3 User Guide.

This functionality is not supported for Amazon S3 on Outposts.

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. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide.
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 (Amazon Web Services 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:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    For example, the following x-amz-grant-read header grants list objects permission to the two Amazon Web Services 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 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>

  • 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.

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
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.

The following operations are related to PutObjectAcl:

", @@ -2063,9 +2063,11 @@ "IfMatch": { "base": null, "refs": { + "CompleteMultipartUploadRequest$IfMatch": "

Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should fetch the object's ETag, re-initiate the multipart upload with CreateMultipartUpload, and re-upload each part.

Expects the ETag value as a string.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

", "DeleteObjectRequest$IfMatch": "

The If-Match header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns a 412 Precondition Failed error. If the ETag matches or if the object doesn't exist, the operation will return a 204 Success (No Content) response.

For more information about conditional requests, see RFC 7232.

This functionality is only supported for directory buckets.

", "GetObjectRequest$IfMatch": "

Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a 412 Precondition Failed error.

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.

For more information about conditional requests, see RFC 7232.

", - "HeadObjectRequest$IfMatch": "

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

" + "HeadObjectRequest$IfMatch": "

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

", + "PutObjectRequest$IfMatch": "

Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should fetch the object's ETag and retry the upload.

Expects the ETag value as a string.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

" } }, "IfMatchInitiatedTime": { diff --git a/src/data/s3/2006-03-01/docs-2.json.php b/src/data/s3/2006-03-01/docs-2.json.php index 2a3fed29f6..6da286cb6f 100644 --- a/src/data/s3/2006-03-01/docs-2.json.php +++ b/src/data/s3/2006-03-01/docs-2.json.php @@ -1,3 +1,3 @@ '2.0', 'service' => '

', 'operations' => [ '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 and prevent getting charged for the part storage, you should call the ListParts API operation and ensure that the parts list is empty.

Permissions

  • General purpose bucket permissions - For information about permissions required to use the multipart upload, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to AbortMultipartUpload:

', 'CompleteMultipartUpload' => '

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the UploadPart operation or the UploadPartCopy operation. After successfully uploading all relevant parts of an upload, you call this CompleteMultipartUpload 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 CompleteMultipartUpload request, you must provide the parts list and ensure that the parts list is complete. The CompleteMultipartUpload API operation concatenates the parts that you provide in the list. For each part in the list, you must provide the PartNumber value and the ETag value that are returned after that part was uploaded.

The processing of a CompleteMultipartUpload request could take several minutes to finalize. 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. A request could fail after the initial 200 OK response has been sent. This means that a 200 OK response can contain either a success or an error. The error response might be embedded in the 200 OK response. If you call this API operation directly, make sure to design your application to parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don\'t use exceptions, they return an error).

Note that if CompleteMultipartUpload fails, applications should be prepared to retry any failed requests (including 500 error responses). For more information, see Amazon S3 Error Best Practices.

You can\'t use Content-Type: application/x-www-form-urlencoded for the CompleteMultipartUpload requests. Also, if you don\'t provide a Content-Type header, CompleteMultipartUpload can still return a 200 OK response.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

    If you provide an additional checksum value in your MultipartUpload requests and the object is encrypted with Key Management Service, you must have permission to use the kms:Decrypt action for the CompleteMultipartUpload request to succeed.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

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.

    • HTTP Status Code: 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 ETag might not have matched the uploaded part\'s ETag.

    • HTTP Status Code: 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.

    • HTTP Status Code: 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.

    • HTTP Status Code: 404 Not Found

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to CompleteMultipartUpload:

', 'CopyObject' => '

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 action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the REST Multipart Upload API.

You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose buckets and directory buckets.

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. For more information about how to enable a Region for your account, see Enable or disable a Region for standalone accounts in the Amazon Web Services Account Management Guide.

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, see Transfer Acceleration.
Authentication and authorization

All CopyObject requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.

Directory buckets - You must use the IAM credentials to authenticate and authorize your access to the CopyObject API operation, instead of using the temporary security credentials through the CreateSession API operation.

Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.

Permissions

You must have read access to the source object and write access to the destination bucket.

  • General purpose bucket permissions - You must have permissions in an IAM policy based on the source and destination bucket types in a CopyObject operation.

    • If the source object is in a general purpose bucket, you must have s3:GetObject permission to read the source object that is being copied.

    • If the destination bucket is a general purpose bucket, you must have s3:PutObject permission to write the object copy to the destination bucket.

  • Directory bucket permissions - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in a CopyObject operation.

    • If the source object that you want to copy is in a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to read the object. By default, the session is in the ReadWrite mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode condition key to ReadOnly on the copy source bucket.

    • If the copy destination is a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to write the object to the destination. The s3express:SessionMode condition key can\'t be set to ReadOnly on the copy destination bucket.

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

    For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.

Response and special errors

When the request is an HTTP 1.1 request, the response is chunk encoded. When the request is not an HTTP 1.1 request, the response would not contain the Content-Length. You always need to read the entire response body to check if the copy succeeds.

  • If the copy is successful, you receive a response with information about the copied object.

  • A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. A 200 OK response can contain either a success or an error.

    • If the error occurs before the copy action 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. For example, in a cross-region copy, you may encounter throttling and receive a 200 OK response. For more information, see Resolve the Error 200 response when copying objects to Amazon S3. The 200 OK status code means the copy was accepted, but it doesn\'t mean the copy is complete. Another example is when you disconnect from Amazon S3 before the copy is complete, Amazon S3 might cancel the copy and you may receive a 200 OK response. You must stay connected to Amazon S3 until the entire response is successfully received and processed.

      If you call this API operation directly, make sure to design your application to parse the content of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don\'t use exceptions, they return an error).

Charge

The copy request charge is based on the storage class and Region that you specify for the destination object. The request can also result in a data retrieval charge for the source if the source storage class bills for data retrieval. If the copy source is in a different region, the data transfer is billed to the copy source account. For pricing information, see Amazon S3 pricing.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to CopyObject:

', 'CreateBucket' => '

This action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket, see CreateBucket .

Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.

There are two types of buckets: general purpose buckets and directory buckets. For more information about these bucket types, see Creating, configuring, and working with Amazon S3 buckets in the Amazon S3 User Guide.

Permissions

  • General purpose bucket permissions - In addition to the s3:CreateBucket permission, the following permissions are required in a policy when your CreateBucket request includes specific headers:

    • Access control lists (ACLs) - In your CreateBucket request, if you specify an access control list (ACL) and set it to public-read, public-read-write, authenticated-read, or if you explicitly specify any other custom ACLs, both s3:CreateBucket and s3:PutBucketAcl permissions are required. In your CreateBucket request, if you set the ACL to private, or if you don\'t specify any ACLs, only the s3:CreateBucket permission is required.

    • Object Lock - In your CreateBucket request, if you set x-amz-bucket-object-lock-enabled to true, the s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.

    • S3 Object Ownership - If your CreateBucket request includes the x-amz-object-ownership header, then the s3:PutBucketOwnershipControls permission is required.

      To set an ACL on a bucket as part of a CreateBucket request, you must explicitly set S3 Object Ownership for the bucket to a different value than the default, BucketOwnerEnforced. Additionally, if your desired bucket ACL grants public access, you must first create the bucket (without the bucket ACL) and then explicitly disable Block Public Access on the bucket before using PutBucketAcl to set the ACL. If you try to create a bucket with a public ACL, the request will fail.

      For the majority of modern use cases in S3, we recommend that you keep all Block Public Access settings enabled and keep ACLs disabled. If you would like to share data with users outside of your account, you can use bucket policies as needed. For more information, see Controlling ownership of objects and disabling ACLs for your bucket and Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide.

    • S3 Block Public Access - If your specific use case requires granting public access to your S3 resources, you can disable Block Public Access. Specifically, you can create a new bucket with Block Public Access enabled, then separately call the DeletePublicAccessBlock API. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about S3 Block Public Access, see Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide.

  • Directory bucket permissions - You must have the s3express:CreateBucket permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    The permissions for ACLs, Object Lock, S3 Object Ownership, and S3 Block Public Access are not supported for directory buckets. For directory buckets, all Block Public Access settings are enabled at the bucket level and S3 Object Ownership is set to Bucket owner enforced (ACLs disabled). These settings can\'t be modified.

    For more information about permissions for creating and working with directory buckets, see Directory buckets in the Amazon S3 User Guide. For more information about supported S3 features for directory buckets, see Features of S3 Express One Zone in the Amazon S3 User Guide.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to CreateBucket:

', 'CreateMultipartUpload' => '

This action 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 in the Amazon S3 User Guide.

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 stops charging you for storing them only after you either complete or abort a multipart upload.

If you have configured a lifecycle rule to abort incomplete multipart uploads, the created multipart upload must be completed within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.

Request signing

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 (Amazon Web Services Signature Version 4) in the Amazon S3 User Guide.

Permissions

  • General purpose bucket permissions - To perform a multipart upload with encryption using an Key Management Service (KMS) KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey actions on the key. The requester must also have permissions for the kms:GenerateDataKey action for the CreateMultipartUpload API. Then, the requester needs permissions for the kms:Decrypt action on the UploadPart and UploadPartCopy APIs. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions and Protecting data using server-side encryption with Amazon Web Services KMS in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Encryption

  • General purpose buckets - 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. Amazon S3 automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a multipart upload, if you don\'t specify encryption information in your request, the encryption setting of the uploaded parts is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded parts. When you perform a CreateMultipartUpload operation, if you want to use a different type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the object with a different encryption key (such as an Amazon S3 managed key, a KMS key, or a customer-provided key). When the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence. 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 CreateMultipartUpload request.

    • Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (aws/s3) and KMS customer managed keys stored in Key Management Service (KMS) – If you want Amazon Web Services 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 Amazon Web Services managed key (aws/s3 key) in KMS to protect the data.

      • To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* 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. For more information, see Multipart upload API and permissions and Protecting data using server-side encryption with Amazon Web Services KMS in the Amazon S3 User Guide.

      • If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role is in a different account from the key, then you must have the permissions on both the key policy and your IAM user or role.

      • All GET and PUT requests for an object protected by KMS fail if you don\'t make them by using Secure Sockets Layer (SSL), Transport Layer Security (TLS), or Signature Version 4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

      For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys in the Amazon S3 User Guide.

    • Use customer-provided encryption keys (SSE-C) – 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 customer-provided encryption keys (SSE-C), see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C) in the Amazon S3 User Guide.

  • Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket\'s default encryption uses the desired encryption configuration and you don\'t override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

    In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession request. You can\'t override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) that are specified in the CreateSession request. You don\'t need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket.

    When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket\'s default encryption configuration for the CreateSession request. It\'s not supported to override the encryption settings values in the CreateSession request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the encryption request headers must match the default encryption configuration of the directory bucket.

    For directory buckets, when you perform a CreateMultipartUpload operation and an UploadPartCopy operation, the request headers you provide in the CreateMultipartUpload request must match the default encryption configuration of the destination bucket.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to CreateMultipartUpload:

', 'CreateSession' => '

Creates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint API operations on directory buckets. For more information about Zonal endpoint API operations that include the Availability Zone in the request endpoint, see S3 Express One Zone APIs in the Amazon S3 User Guide.

To make Zonal endpoint API requests on a directory bucket, use the CreateSession API operation. Specifically, you grant s3express:CreateSession permission to a bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM credentials to make the CreateSession API request on the bucket, which returns temporary security credentials that include the access key ID, secret access key, session token, and expiration. These credentials have associated permissions to access the Zonal endpoint API operations. After the session is created, you don’t need to use other policies to grant permissions to each Zonal endpoint API individually. Instead, in your Zonal endpoint API requests, you sign your requests by applying the temporary security credentials of the session to the request headers and following the SigV4 protocol for authentication. You also apply the session token to the x-amz-s3session-token request header for authorization. Temporary security credentials are scoped to the bucket and expire after 5 minutes. After the expiration time, any calls that you make with those credentials will fail. You must use IAM credentials again to make a CreateSession API request that generates a new set of temporary credentials for use. Temporary credentials cannot be extended or refreshed beyond the original specified interval.

If you use Amazon Web Services SDKs, SDKs handle the session token refreshes automatically to avoid service interruptions when a session expires. We recommend that you use the Amazon Web Services SDKs to initiate and manage requests to the CreateSession API. For more information, see Performance guidelines and design patterns in the Amazon S3 User Guide.

Permissions

To obtain temporary security credentials, you must create a bucket policy or an IAM identity-based policy that grants s3express:CreateSession permission to the bucket. In a policy, you can have the s3express:SessionMode condition key to control who can create a ReadWrite or ReadOnly session. For more information about ReadWrite or ReadOnly sessions, see x-amz-create-session-mode . For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.

To grant cross-account access to Zonal endpoint API operations, the bucket policy should also grant both accounts the s3express:CreateSession permission.

If you want to encrypt objects with SSE-KMS, you must also have the kms:GenerateDataKey and the kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the target KMS key.

Encryption

For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket\'s default encryption uses the desired encryption configuration and you don\'t override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

For Zonal endpoint (object-level) API operations except CopyObject and UploadPartCopy, you authenticate and authorize requests through CreateSession for low latency. To encrypt new objects in a directory bucket with SSE-KMS, you must specify SSE-KMS as the directory bucket\'s default encryption configuration with a KMS key (specifically, a customer managed key). Then, when a session is created for Zonal endpoint API operations, new objects are automatically encrypted and decrypted with SSE-KMS and S3 Bucket Keys during the session.

Only 1 customer managed key is supported per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn\'t supported. After you specify SSE-KMS as your bucket\'s default encryption configuration with a customer managed key, you can\'t change the customer managed key for the bucket\'s SSE-KMS configuration.

In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, you can\'t override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) from the CreateSession request. You don\'t need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket.

When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket\'s default encryption configuration for the CreateSession request. It\'s not supported to override the encryption settings values in the CreateSession request. Also, in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), it\'s not supported to override the values of the encryption settings from the CreateSession request.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

', 'DeleteBucket' => '

Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

Permissions

  • General purpose bucket permissions - You must have the s3:DeleteBucket permission on the specified bucket in a policy.

  • Directory bucket permissions - You must have the s3express:DeleteBucket permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to DeleteBucket:

', 'DeleteBucketAnalyticsConfiguration' => '

This operation is not supported for directory buckets.

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:

', 'DeleteBucketCors' => '

This operation is not supported for directory buckets.

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 S3 User Guide.

Related Resources

', 'DeleteBucketEncryption' => '

This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption with Amazon S3 managed keys (SSE-S3).

Permissions

  • General purpose bucket permissions - The s3:PutEncryptionConfiguration permission is required in a policy. 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 Operations and Managing Access Permissions to Your Amazon S3 Resources.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutEncryptionConfiguration permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to DeleteBucketEncryption:

', 'DeleteBucketIntelligentTieringConfiguration' => '

This operation is not supported for directory buckets.

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to DeleteBucketIntelligentTieringConfiguration include:

', 'DeleteBucketInventoryConfiguration' => '

This operation is not supported for directory buckets.

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:

', 'DeleteBucketLifecycle' => '

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

Permissions

  • General purpose bucket permissions - By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must have the s3:PutLifecycleConfiguration permission.

    For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

  • Directory bucket permissions - You must have the s3express:PutLifecycleConfiguration permission in an IAM identity-based policy to use this operation. Cross-account access to this API operation isn\'t supported. The resource owner can optionally grant access permissions to others by creating a role or user for them as long as they are within the same account as the owner and resource.

    For more information about directory bucket policies and permissions, see Authorizing Regional endpoint APIs with IAM in the Amazon S3 User Guide.

    Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

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

Related actions include:

', 'DeleteBucketMetricsConfiguration' => '

This operation is not supported for directory buckets.

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:

', 'DeleteBucketOwnershipControls' => '

This operation is not supported for directory buckets.

Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to DeleteBucketOwnershipControls:

', 'DeleteBucketPolicy' => '

Deletes the policy of a specified bucket.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must both 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 not using an identity that belongs to the bucket owner\'s account, Amazon S3 returns a 405 Method Not Allowed error.

To ensure that bucket owners don\'t inadvertently lock themselves out of their own buckets, the root principal in a bucket owner\'s Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal\'s access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

  • General purpose bucket permissions - The s3:DeleteBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:DeleteBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to DeleteBucketPolicy

', 'DeleteBucketReplication' => '

This operation is not supported for directory buckets.

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 User Guide.

The following operations are related to DeleteBucketReplication:

', 'DeleteBucketTagging' => '

This operation is not supported for directory buckets.

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:

', 'DeleteBucketWebsite' => '

This operation is not supported for directory buckets.

This action 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 action 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:

', 'DeleteObject' => '

Removes an object from a bucket. The behavior depends on the bucket\'s versioning state. For more information, see Best practices to consider before deleting an object.

To remove a specific version, you must use the versionId query parameter. Using this query parameter 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 and to see example requests, see Using MFA delete and Sample request in the Amazon S3 User Guide.

Permissions

  • General purpose bucket permissions - The following permissions are required in your policies when your DeleteObjects request includes specific headers.

    • s3:DeleteObject - To delete an object from a bucket, you must always have the s3:DeleteObject permission.

      You can also use PutBucketLifecycle to delete objects in Amazon S3.

    • s3:DeleteObjectVersion - To delete a specific version of an object from a versioning-enabled bucket, you must have the s3:DeleteObjectVersion permission.

    • 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 permissions.

  • Directory buckets permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following action is related to DeleteObject:

', 'DeleteObjectTagging' => '

This operation is not supported for directory buckets.

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 DeleteObjectTagging:

', '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 can contain 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 in a quiet mode, the operation does not return any information about the delete in the response body.

When performing this action 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 in the Amazon S3 User Guide.

Directory buckets - MFA delete is not supported by directory buckets.
Permissions

  • General purpose bucket permissions - The following permissions are required in your policies when your DeleteObjects request includes specific headers.

    • s3:DeleteObject - To delete an object from a bucket, you must always specify the s3:DeleteObject permission.

    • s3:DeleteObjectVersion - To delete a specific version of an object from a versioning-enabled bucket, you must specify the s3:DeleteObjectVersion permission.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Content-MD5 request header

  • General purpose bucket - The Content-MD5 request 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.

  • Directory bucket - The Content-MD5 request header or a additional checksum request header (including x-amz-checksum-crc32, x-amz-checksum-crc32c, x-amz-checksum-sha1, or x-amz-checksum-sha256) is required for all Multi-Object Delete requests.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to DeleteObjects:

', 'DeletePublicAccessBlock' => '

This operation is not supported for directory buckets.

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 DeletePublicAccessBlock:

', 'GetBucketAccelerateConfiguration' => '

This operation is not supported for directory buckets.

This implementation of the GET action 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 S3 User 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 S3 User Guide.

The following operations are related to GetBucketAccelerateConfiguration:

', 'GetBucketAcl' => '

This operation is not supported for directory buckets.

This implementation of the GET action uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have the READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

The following operations are related to GetBucketAcl:

', 'GetBucketAnalyticsConfiguration' => '

This operation is not supported for directory buckets.

This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration 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 S3 User Guide.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide.

The following operations are related to GetBucketAnalyticsConfiguration:

', 'GetBucketCors' => '

This operation is not supported for directory buckets.

Returns the Cross-Origin Resource Sharing (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.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

For more information about CORS, see Enabling Cross-Origin Resource Sharing.

The following operations are related to GetBucketCors:

', 'GetBucketEncryption' => '

Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3).

Permissions

  • General purpose bucket permissions - The s3:GetEncryptionConfiguration permission is required in a policy. 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 Operations and Managing Access Permissions to Your Amazon S3 Resources.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:GetEncryptionConfiguration permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to GetBucketEncryption:

', 'GetBucketIntelligentTieringConfiguration' => '

This operation is not supported for directory buckets.

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to GetBucketIntelligentTieringConfiguration include:

', 'GetBucketInventoryConfiguration' => '

This operation is not supported for directory buckets.

Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration 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.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

The following operations are related to GetBucketInventoryConfiguration:

', '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.

This operation is not supported for directory buckets.

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:

The following operations are related to GetBucketLifecycle:

', 'GetBucketLifecycleConfiguration' => '

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API, which is compatible with the new functionality. The previous version of the API supported filtering based only on an object key name prefix, which is supported for general purpose buckets for backward compatibility. For the related API description, see GetBucketLifecycle.

Lifecyle configurations for directory buckets only support expiring objects and cancelling multipart uploads. Expiring of versioned objects, transitions and tag filters are not supported.
Permissions

  • General purpose bucket permissions - By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must have the s3:GetLifecycleConfiguration permission.

    For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

  • Directory bucket permissions - You must have the s3express:GetLifecycleConfiguration permission in an IAM identity-based policy to use this operation. Cross-account access to this API operation isn\'t supported. The resource owner can optionally grant access permissions to others by creating a role or user for them as long as they are within the same account as the owner and resource.

    For more information about directory bucket policies and permissions, see Authorizing Regional endpoint APIs with IAM in the Amazon S3 User Guide.

    Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

GetBucketLifecycleConfiguration has the following special error:

The following operations are related to GetBucketLifecycleConfiguration:

', 'GetBucketLocation' => '

This operation is not supported for directory buckets.

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.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

We recommend that you use HeadBucket to return the Region that a bucket resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation.

The following operations are related to GetBucketLocation:

', 'GetBucketLogging' => '

This operation is not supported for directory buckets.

Returns the logging status of a bucket and the permissions users have to view and modify that status.

The following operations are related to GetBucketLogging:

', 'GetBucketMetricsConfiguration' => '

This operation is not supported for directory buckets.

Gets a metrics configuration (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:GetMetricsConfiguration 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 GetBucketMetricsConfiguration:

', 'GetBucketNotification' => '

This operation is not supported for directory buckets.

No longer used, see GetBucketNotificationConfiguration.

', 'GetBucketNotificationConfiguration' => '

This operation is not supported for directory buckets.

Returns the notification configuration of a bucket.

If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration element.

By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.

The following action is related to GetBucketNotification:

', 'GetBucketOwnershipControls' => '

This operation is not supported for directory buckets.

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to GetBucketOwnershipControls:

', 'GetBucketPolicy' => '

Returns the policy of a specified bucket.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

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

If you don\'t have GetBucketPolicy 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.

To ensure that bucket owners don\'t inadvertently lock themselves out of their own buckets, the root principal in a bucket owner\'s Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal\'s access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

  • General purpose bucket permissions - The s3:GetBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:GetBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

Example bucket policies

General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.

Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following action is related to GetBucketPolicy:

', 'GetBucketPolicyStatus' => '

This operation is not supported for directory buckets.

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".

The following operations are related to GetBucketPolicyStatus:

', 'GetBucketReplication' => '

This operation is not supported for directory buckets.

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 S3 User Guide.

This action 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 List of replication-related error codes

The following operations are related to GetBucketReplication:

', 'GetBucketRequestPayment' => '

This operation is not supported for directory buckets.

Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

The following operations are related to GetBucketRequestPayment:

', 'GetBucketTagging' => '

This operation is not supported for directory buckets.

Returns the tag set associated with the bucket.

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

GetBucketTagging has the following special error:

The following operations are related to GetBucketTagging:

', 'GetBucketVersioning' => '

This operation is not supported for directory buckets.

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:

', 'GetBucketWebsite' => '

This operation is not supported for directory buckets.

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 action 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 GetBucketWebsite:

', 'GetObject' => '

Retrieves an object from Amazon S3.

In the GetObject request, specify the full key name for the object.

General purpose buckets - Both the virtual-hosted-style requests and the path-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the object key name 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 object key name as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification in the Amazon S3 User Guide.

Directory buckets - Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket--use1-az5--x-s3, specify the object key name as /photos/2006/February/sample.jpg. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

Permissions

  • General purpose bucket permissions - You must have the required permissions in a policy. To use GetObject, you must have the READ access to the object (or version). If you grant READ access to the anonymous user, the GetObject operation returns the object without using an authorization header. For more information, see Specifying permissions in a policy in the Amazon S3 User Guide.

    If you include a versionId in your request header, you must have the s3:GetObjectVersion permission to access a specific version of an object. The s3:GetObject permission is not required in this scenario.

    If you request the current version of an object without a specific versionId in the request header, only the s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in this scenario.

    If the object that you request doesn’t exist, the error that 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 Not Found error.

    • If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Access Denied error.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If the object is encrypted using SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

Storage classes

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects in the Amazon S3 User Guide.

Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. Unsupported storage class values won\'t write a destination object and will respond with the HTTP status code 400 Bad Request.

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for the GetObject requests, if your object uses server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your GetObject requests for the object that uses these types of keys, you’ll get an HTTP 400 Bad Request error.

Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn\'t supported. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

Overriding response header values through the request

There are times when you want to override certain response header values of a GetObject response. For example, you might override the Content-Disposition response header value through your GetObject request.

You can override values for a set of response headers. These modified response header values are included only in a successful response, that is, when the HTTP status code 200 OK is returned. The headers you can override using the following query parameters in the request are a subset of the headers that Amazon S3 accepts when you create an object.

The response headers that you can override for the GetObject response are Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, and Expires.

To override values for a set of response headers in the GetObject response, you can use the following query parameters in the request.

  • response-cache-control

  • response-content-disposition

  • response-content-encoding

  • response-content-language

  • response-content-type

  • response-expires

When you use these parameters, you must sign the request by using either an Authorization header or a presigned URL. These parameters cannot be used with an unsigned (anonymous) request.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to GetObject:

', 'GetObjectAcl' => '

This operation is not supported for directory buckets.

Returns the access control list (ACL) of an object. To use this operation, you must have s3:GetObjectAcl permissions or READ_ACP access to the object. For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3 User Guide

This functionality is not supported for Amazon S3 on Outposts.

By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

The following operations are related to GetObjectAcl:

', 'GetObjectAttributes' => '

Retrieves all the metadata from an object without returning the object itself. This operation is useful if you\'re interested only in an object\'s metadata.

GetObjectAttributes combines the functionality of HeadObject and ListParts. All of the data returned with each of those individual calls can be returned with a single call to GetObjectAttributes.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - To use GetObjectAttributes, you must have READ access to the object. The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a Policy in the Amazon S3 User Guide. If the object that 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 Not Found ("no such key") error.

    • If you don\'t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden ("access denied") error.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a GET request for an object that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It\'s because the encryption method can\'t be changed when you retrieve the object.

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 to provide the encryption key for the server to be able to retrieve the object\'s metadata. The headers are:

  • 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) in the Amazon S3 User Guide.

Directory bucket permissions - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket\'s default encryption uses the desired encryption configuration and you don\'t override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
Versioning

Directory buckets - S3 Versioning isn\'t enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

Conditional request headers

Consider the following when using request headers:

  • If both of the If-Match and If-Unmodified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested:

    • If-Match condition evaluates to true.

    • If-Unmodified-Since condition evaluates to false.

    For more information about conditional requests, see RFC 7232.

  • If both of the If-None-Match and If-Modified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 304 Not Modified:

    • If-None-Match condition evaluates to false.

    • If-Modified-Since condition evaluates to true.

    For more information about conditional requests, see RFC 7232.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following actions are related to GetObjectAttributes:

', 'GetObjectLegalHold' => '

This operation is not supported for directory buckets.

Gets an object\'s current legal hold status. For more information, see Locking Objects.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to GetObjectLegalHold:

', 'GetObjectLockConfiguration' => '

This operation is not supported for directory buckets.

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

The following action is related to GetObjectLockConfiguration:

', 'GetObjectRetention' => '

This operation is not supported for directory buckets.

Retrieves an object\'s retention settings. For more information, see Locking Objects.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to GetObjectRetention:

', 'GetObjectTagging' => '

This operation is not supported for directory buckets.

Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action.

By default, the bucket owner has this permission and can grant this permission to others.

For information about the Amazon S3 object tagging feature, see Object Tagging.

The following actions are related to GetObjectTagging:

', 'GetObjectTorrent' => '

This operation is not supported for directory buckets.

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you\'re distributing large files.

You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.

To use GET, you must have READ access to the object.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to GetObjectTorrent:

', 'GetPublicAccessBlock' => '

This operation is not supported for directory buckets.

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:

', 'HeadBucket' => '

You can use this operation to determine if a bucket exists and if you have permission to access it. The action returns a 200 OK if the bucket exists and you have permission to access it.

If the bucket does not exist or you do not have permission to access it, the HEAD request returns a generic 400 Bad Request, 403 Forbidden or 404 Not Found code. A message body is not included, so you cannot determine the exception beyond these HTTP response codes.
Authentication and authorization

General purpose buckets - Request to public buckets that grant the s3:ListBucket permission publicly do not need to be signed. All other HeadBucket requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.

Directory buckets - You must use IAM credentials to authenticate and authorize your access to the HeadBucket API operation, instead of using the temporary security credentials through the CreateSession API operation.

Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.

Permissions

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
', 'HeadObject' => '

The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you\'re interested only in an object\'s metadata.

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. Because of this, if the HEAD request generates an error, it returns a generic code, such as 400 Bad Request, 403 Forbidden, 404 Not Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. It\'s not possible to retrieve the exact exception of these error codes.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers.

Permissions

  • General purpose bucket permissions - To use HEAD, you must have the s3:GetObject permission. You need the relevant read object (or version) permission for this operation. For more information, see Actions, resources, and condition keys for Amazon S3 in the Amazon S3 User Guide. For more information about the permissions to S3 API operations by S3 resource types, see Required permissions for Amazon S3 API operations in the Amazon S3 User Guide.

    If the object you request doesn\'t exist, the error that 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 Not Found error.

    • If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden error.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If you enable x-amz-checksum-mode in the request and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a HEAD request for an object that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It\'s because the encryption method can\'t be changed when you retrieve the object.

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 to provide the encryption key for the server to be able to retrieve the object\'s metadata. The headers are:

  • 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) in the Amazon S3 User Guide.

Directory bucket - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn\'t supported. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

Versioning

  • 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.

  • If the specified version is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

  • Directory buckets - Delete marker is not supported for directory buckets.

  • Directory buckets - S3 Versioning isn\'t enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

The following actions are related to HeadObject:

', 'ListBucketAnalyticsConfigurations' => '

This operation is not supported for directory buckets.

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration 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 ListBucketAnalyticsConfigurations:

', 'ListBucketIntelligentTieringConfigurations' => '

This operation is not supported for directory buckets.

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to ListBucketIntelligentTieringConfigurations include:

', 'ListBucketInventoryConfigurations' => '

This operation is not supported for directory buckets.

Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration 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

The following operations are related to ListBucketInventoryConfigurations:

', 'ListBucketMetricsConfigurations' => '

This operation is not supported for directory buckets.

Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration 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 more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to ListBucketMetricsConfigurations:

', 'ListBuckets' => '

This operation is not supported for directory buckets.

Returns a list of all buckets owned by the authenticated sender of the request. To grant IAM permission to use this operation, you must add the s3:ListAllMyBuckets policy action.

For information about Amazon S3 buckets, see Creating, configuring, and working with Amazon S3 buckets.

We strongly recommend using only paginated ListBuckets requests. Unpaginated ListBuckets requests are only supported for Amazon Web Services accounts set to the default general purpose bucket quota of 10,000. If you have an approved general purpose bucket quota above 10,000, you must send paginated ListBuckets requests to list your account’s buckets. All unpaginated ListBuckets requests will be rejected for Amazon Web Services accounts with a general purpose bucket quota greater than 10,000.

', 'ListDirectoryBuckets' => '

Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the request. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

You must have the s3express:ListAllMyDirectoryBuckets permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The BucketRegion response element is not part of the ListDirectoryBuckets Response Syntax.

', 'ListMultipartUploads' => '

This operation lists in-progress multipart uploads in a bucket. An in-progress multipart upload is a multipart upload that has been initiated by the CreateMultipartUpload request, but has not yet been completed or aborted.

Directory buckets - If multipart uploads in a directory bucket are in progress, you can\'t delete the bucket until all the in-progress multipart uploads are aborted or completed. To delete these in-progress multipart uploads, use the ListMultipartUploads operation to list the in-progress multipart uploads in the bucket and use the AbortMultipartUpload operation to abort all the in-progress multipart uploads.

The ListMultipartUploads operation returns a maximum of 1,000 multipart uploads in the response. The limit of 1,000 multipart uploads is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads request parameter. If there are more than 1,000 multipart uploads that satisfy your ListMultipartUploads request, the response returns an IsTruncated element with the value of true, a NextKeyMarker element, and a NextUploadIdMarker element. To list the remaining multipart uploads, you need to make subsequent ListMultipartUploads requests. In these requests, include two query parameters: key-marker and upload-id-marker. Set the value of key-marker to the NextKeyMarker value from the previous response. Similarly, set the value of upload-id-marker to the NextUploadIdMarker value from the previous response.

Directory buckets - The upload-id-marker element and the NextUploadIdMarker element aren\'t supported by directory buckets. To list the additional multipart uploads, you only need to set the value of key-marker to the NextKeyMarker value from the previous response.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Sorting of multipart uploads in response

  • General purpose bucket - In the ListMultipartUploads response, the multipart uploads are sorted based on two criteria:

    • Key-based sorting - Multipart uploads are initially sorted in ascending order based on their object keys.

    • Time-based sorting - For uploads that share the same object key, they are further sorted in ascending order based on the upload initiation time. Among uploads with the same key, the one that was initiated first will appear before the ones that were initiated later.

  • Directory bucket - In the ListMultipartUploads response, the multipart uploads aren\'t sorted lexicographically based on the object keys.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to ListMultipartUploads:

', 'ListObjectVersions' => '

This operation is not supported for directory buckets.

Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.

To use this operation, you must have permission to perform the s3:ListBucketVersions action. Be aware of the name difference.

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.

The following operations are related to ListObjectVersions:

', 'ListObjects' => '

This operation is not supported for directory buckets.

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 action 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:

', 'ListObjectsV2' => '

Returns some or all (up to 1,000) of the objects in a bucket with each request. 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. For more information about listing objects, see Listing object keys programmatically in the Amazon S3 User Guide. To get a list of your buckets, see ListBuckets.

Permissions

  • General purpose bucket permissions - To use this operation, you must have READ access to the bucket. You must have permission 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 in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Sorting order of returned objects

  • General purpose bucket - For general purpose buckets, ListObjectsV2 returns objects in lexicographical order based on their key names.

  • Directory bucket - For directory buckets, ListObjectsV2 does not return objects in lexicographical order.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, ListObjects.

The following operations are related to ListObjectsV2:

', 'ListParts' => '

Lists the parts that have been uploaded for a specific multipart upload.

To use this operation, you must provide the upload ID in the request. You obtain this uploadID by sending the initiate multipart upload request through CreateMultipartUpload.

The ListParts request returns a maximum of 1,000 uploaded parts. The limit of 1,000 parts is also the default value. You can restrict the number of parts in a response by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. To list remaining uploaded parts, in subsequent ListParts requests, include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

    If the upload was created using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), you must have permission to the kms:Decrypt action for the ListParts request to succeed.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to ListParts:

', 'PutBucketAccelerateConfiguration' => '

This operation is not supported for directory buckets.

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.

To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration 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.

The Transfer Acceleration state of a bucket can be set to one of the following two values:

The GetBucketAccelerateConfiguration action returns the transfer acceleration state of a bucket.

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (".").

For more information about transfer acceleration, see Transfer Acceleration.

The following operations are related to PutBucketAccelerateConfiguration:

', 'PutBucketAcl' => '

This operation is not supported for directory buckets.

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 the WRITE_ACP permission.

You can use one of the following two ways to set a bucket\'s permissions:

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.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide.
Permissions

You can set access permissions by 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 (Amazon Web Services 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:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    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 Amazon Web Services accounts identified by their email addresses.

    x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"

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 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>

  • 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.

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

The following operations are related to PutBucketAcl:

', 'PutBucketAnalyticsConfiguration' => '

This operation is not supported for directory buckets.

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.

PutBucketAnalyticsConfiguration has the following special errors:

The following operations are related to PutBucketAnalyticsConfiguration:

', 'PutBucketCors' => '

This operation is not supported for directory buckets.

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:

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

The following operations are related to PutBucketCors:

', 'PutBucketEncryption' => '

This operation configures default encryption and Amazon S3 Bucket Keys for an existing bucket.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3).

If you\'re specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that\'s encrypted with a KMS key that belongs to the requester, and not the bucket owner.

Also, this action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4).

Permissions

  • General purpose bucket permissions - The s3:PutEncryptionConfiguration permission is required in a policy. 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 Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutEncryptionConfiguration permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    To set a directory bucket default encryption with SSE-KMS, you must also have the kms:GenerateDataKey and the kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the target KMS key.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to PutBucketEncryption:

', 'PutBucketIntelligentTieringConfiguration' => '

This operation is not supported for directory buckets.

Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to PutBucketIntelligentTieringConfiguration include:

You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.

PutBucketIntelligentTieringConfiguration has the following special errors:

HTTP 400 Bad Request Error

Code: InvalidArgument

Cause: Invalid Argument

HTTP 400 Bad Request Error

Code: TooManyConfigurations

Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

HTTP 403 Forbidden Error

Cause: You are not the owner of the specified bucket, or you do not have the s3:PutIntelligentTieringConfiguration bucket permission to set the configuration on the bucket.

', 'PutBucketInventoryConfiguration' => '

This operation is not supported for directory buckets.

This implementation of the PUT action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket.

When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide.

You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
Permissions

To use this operation, you must have permission to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others.

The s3:PutInventoryConfiguration permission allows a user to create an S3 Inventory report that includes all object metadata fields available and to specify the destination bucket to store the inventory. A user with read access to objects in the destination bucket can also access all object metadata fields that are available in the inventory report.

To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the Amazon S3 User Guide. For more information about the metadata fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For more information about permissions, see Permissions related to bucket subresource operations and Identity and access management in Amazon S3 in the Amazon S3 User Guide.

PutBucketInventoryConfiguration has the following special errors:

HTTP 400 Bad Request Error

Code: InvalidArgument

Cause: Invalid Argument

HTTP 400 Bad Request Error

Code: TooManyConfigurations

Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

HTTP 403 Forbidden Error

Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.

The following operations are related to PutBucketInventoryConfiguration:

', 'PutBucketLifecycle' => '

For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.

This operation is not supported for directory buckets.

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon S3 User Guide.

By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.

The following operations are related to PutBucketLifecycle:

', 'PutBucketLifecycleConfiguration' => '

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle.

Rules
Permissions
HTTP Host header syntax

You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable.

Bucket lifecycle configuration supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility for general purpose buckets. For the related API description, see PutBucketLifecycle.

Lifecyle configurations for directory buckets only support expiring objects and cancelling multipart uploads. Expiring of versioned objects,transitions and tag filters are not supported.

A lifecycle rule consists of the following:

  • A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, object size, or any combination of these.

  • A status indicating whether the rule is in effect.

  • One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.

For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.

  • General purpose bucket permissions - By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must have the s3:PutLifecycleConfiguration permission.

    You can also explicitly deny permissions. An explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

  • Directory bucket permissions - You must have the s3express:PutLifecycleConfiguration permission in an IAM identity-based policy to use this operation. Cross-account access to this API operation isn\'t supported. The resource owner can optionally grant access permissions to others by creating a role or user for them as long as they are within the same account as the owner and resource.

    For more information about directory bucket policies and permissions, see Authorizing Regional endpoint APIs with IAM in the Amazon S3 User Guide.

    Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to PutBucketLifecycleConfiguration:

', 'PutBucketLogging' => '

This operation is not supported for directory buckets.

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 Amazon Web Services 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.

If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can\'t use the Grantee request element to grant access to others. Permissions can only be granted using policies. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.
Grantee Values

You can specify the person (grantee) to whom you\'re assigning access rights (by 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 GETObjectAcl 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 in the Amazon S3 User Guide.

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:

', 'PutBucketMetricsConfiguration' => '

This operation is not supported for directory buckets.

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:

PutBucketMetricsConfiguration has the following special error:

', 'PutBucketNotification' => '

This operation is not supported for directory buckets.

No longer used, see the PutBucketNotificationConfiguration operation.

', 'PutBucketNotificationConfiguration' => '

This operation is not supported for directory buckets.

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 action 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 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.

For more information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon Web Services General Reference.

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 the required 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 action will fail, and Amazon S3 will not add the configuration to your bucket.

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 action is related to PutBucketNotificationConfiguration:

', 'PutBucketOwnershipControls' => '

This operation is not supported for directory buckets.

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see Using object ownership.

The following operations are related to PutBucketOwnershipControls:

', 'PutBucketPolicy' => '

Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

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

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

To ensure that bucket owners don\'t inadvertently lock themselves out of their own buckets, the root principal in a bucket owner\'s Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal\'s access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

  • General purpose bucket permissions - The s3:PutBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

Example bucket policies

General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.

Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to PutBucketPolicy:

', 'PutBucketReplication' => '

This operation is not supported for directory buckets.

Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.

Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets 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. You can invoke this request for a specific Amazon Web Services Region by using the aws:RequestedRegion condition key.

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.

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.

If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.

For information about enabling versioning on a bucket, see Using Versioning.

Handling Replication of Encrypted Objects

By default, Amazon S3 doesn\'t replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using KMS keys.

For information on PutBucketReplication errors, see List of replication-related error codes

Permissions

To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration permissions for the bucket.

By default, a resource owner, in this case the Amazon Web Services 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.

To perform this operation, the user or role performing the action must have the iam:PassRole permission.

The following operations are related to PutBucketReplication:

', 'PutBucketRequestPayment' => '

This operation is not supported for directory buckets.

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.

The following operations are related to PutBucketRequestPayment:

', 'PutBucketTagging' => '

This operation is not supported for directory buckets.

Sets the tags for a bucket.

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

When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.

To use this operation, you must have permissions to perform the s3:PutBucketTagging 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.

PutBucketTagging has the following special errors. For more Amazon S3 errors see, Error Responses.

The following operations are related to PutBucketTagging:

', 'PutBucketVersioning' => '

This operation is not supported for directory buckets.

When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (PUT or DELETE) on objects in the bucket.

Sets the versioning state of an existing bucket.

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.

In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you 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 configuration 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 configuration 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.

The following operations are related to PutBucketVersioning:

', 'PutBucketWebsite' => '

This operation is not supported for directory buckets.

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 action 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.

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.

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the Amazon S3 User Guide.

The maximum request length is limited to 128 KB.

', 'PutObject' => '

Adds an object to a 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. However, Amazon S3 provides features that can modify this behavior:

Permissions

  • General purpose bucket permissions - The following permissions are required in your policies when your PutObject request includes specific headers.

    • s3:PutObject - To successfully complete the PutObject request, you must always have the s3:PutObject permission on a bucket to add an object to it.

    • s3:PutObjectAcl - To successfully change the objects ACL of your PutObject request, you must have the s3:PutObjectAcl.

    • s3:PutObjectTagging - To successfully set the tag-set with your PutObject request, you must have the s3:PutObjectTagging.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

Data integrity with Content-MD5

  • General purpose bucket - 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, Amazon S3 returns an error. Alternatively, when the object\'s ETag is its MD5 digest, you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

  • Directory bucket - This functionality is not supported for directory buckets.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

For more information about related Amazon S3 APIs, see the following:

', 'PutObjectAcl' => '

This operation is not supported for directory buckets.

Uses the acl subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have the WRITE_ACP permission to set the ACL of an object. For more information, see What permissions can I grant? in the Amazon S3 User Guide.

This functionality is not supported for Amazon S3 on Outposts.

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. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide.
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 (Amazon Web Services 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:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    For example, the following x-amz-grant-read header grants list objects permission to the two Amazon Web Services 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 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>

  • 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.

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
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.

The following operations are related to PutObjectAcl:

', 'PutObjectLegalHold' => '

This operation is not supported for directory buckets.

Applies a legal hold configuration to the specified object. For more information, see Locking Objects.

This functionality is not supported for Amazon S3 on Outposts.

', 'PutObjectLockConfiguration' => '

This operation is not supported for directory buckets.

Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

', 'PutObjectRetention' => '

This operation is not supported for directory buckets.

Places an Object Retention configuration on an object. For more information, see Locking Objects. Users or accounts require the s3:PutObjectRetention permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the s3:BypassGovernanceRetention permission.

This functionality is not supported for Amazon S3 on Outposts.

', 'PutObjectTagging' => '

This operation is not supported for directory buckets.

Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair. For more information, see Object Tagging.

You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging.

For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.

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

To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action.

PutObjectTagging has the following special errors. For more Amazon S3 errors see, Error Responses.

The following operations are related to PutObjectTagging:

', 'PutPublicAccessBlock' => '

This operation is not supported for directory buckets.

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".

The following operations are related to PutPublicAccessBlock:

', 'RestoreObject' => '

This operation is not supported for directory buckets.

Restores an archived copy of an object back into Amazon S3

This functionality is not supported for Amazon S3 on Outposts.

This action performs the following types of requests:

For more information about the S3 structure in the request body, see the following:

Permissions

To use this operation, you must have permissions to perform the s3:RestoreObject 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 in the Amazon S3 User Guide.

Restoring objects

Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage classes, you must first initiate a restore request, and then wait until a temporary copy of the object is available. If you want a permanent copy of the object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must restore the object for the duration (number of days) that you specify. For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier.

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.

When restoring an archived object, 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 S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is 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 objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.

  • Standard - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.

  • Bulk - Bulk retrievals free for objects stored in the S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.

For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the Amazon S3 User 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 S3 User 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 S3 User Guide.

Responses

A successful action returns either the 200 OK or 202 Accepted status code.

  • If the object is not previously restored, then Amazon S3 returns 202 Accepted in the response.

  • If the object is previously restored, Amazon S3 returns 200 OK in the response.

  • Special errors:

    • Code: RestoreAlreadyInProgress

    • Cause: Object restore is already in progress.

    • HTTP Status Code: 409 Conflict

    • SOAP Fault Code Prefix: Client

    • Code: GlacierExpeditedRetrievalNotAvailable

    • Cause: 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 S3 Standard or Bulk retrievals.)

    • HTTP Status Code: 503

    • SOAP Fault Code Prefix: N/A

The following operations are related to RestoreObject:

', 'SelectObjectContent' => '

This operation is not supported for directory buckets.

This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

This functionality is not supported for Amazon S3 on Outposts.

For more information about Amazon S3 Select, see Selecting Content from Objects and SELECT Command in the Amazon S3 User Guide.

Permissions

You must have the s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon S3 User Guide.

Object Data Formats

You can use Amazon S3 Select to query objects that have the following format properties:

  • CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format.

  • UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.

  • GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.

  • Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption.

    For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

    For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you don\'t need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide.

Working with the Response Body

Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding header with chunked as its value in the response. For more information, see Appendix: SelectObjectContent Response.

GetObject Support

The SelectObjectContent action does not support the following GetObject functionality. For more information, see GetObject.

  • Range: Although you can specify a scan range for an Amazon S3 Select request (see SelectObjectContentRequest - ScanRange in the request parameters), you cannot specify the range of bytes of an object to return.

  • The GLACIER, DEEP_ARCHIVE, and REDUCED_REDUNDANCY storage classes, or the ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING storage class: You cannot query objects in the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes, nor objects in the ARCHIVE_ACCESS or DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING storage class. For more information about storage classes, see Using Amazon S3 storage classes in the Amazon S3 User Guide.

Special Errors

For a list of special errors for this operation, see List of SELECT Object Content Error Codes

The following operations are related to SelectObjectContent:

', 'UploadPart' => '

Uploads a part in a multipart upload.

In this operation, you provide new data as a part of an object 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.

For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.

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 S3 User Guide .

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - To perform a multipart upload with encryption using an Key Management Service key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey actions on the key. The requester must also have permissions for the kms:GenerateDataKey action for the CreateMultipartUpload API. Then, the requester needs permissions for the kms:Decrypt action on the UploadPart and UploadPartCopy APIs.

    These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information about KMS permissions, see Protecting data using server-side encryption with KMS in the Amazon S3 User Guide. For information about the permissions required to use the multipart upload API, see Multipart upload and permissions and Multipart upload API and permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

Data integrity

General purpose bucket - To ensure that data is not corrupted 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. If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256 header as a checksum instead of Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).

Directory buckets - MD5 is not supported by directory buckets. You can use checksum algorithms to check object integrity.
Encryption

  • General purpose bucket - 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. You have mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption with other key options. The option you use depends on whether you want to use KMS keys (SSE-KMS) or provide your own encryption key (SSE-C).

    Server-side encryption is supported by the S3 Multipart Upload operations. Unless you are using a customer-provided encryption key (SSE-C), 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 request server-side encryption using a customer-provided encryption key (SSE-C) in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following request 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, see Using Server-Side Encryption in the Amazon S3 User Guide.

  • Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms).

Special errors

  • 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.

    • HTTP Status Code: 404 Not Found

    • SOAP Fault Code Prefix: Client

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to UploadPart:

', 'UploadPartCopy' => '

Uploads a part by copying data from an existing object as data source. To specify the data source, you add the request header x-amz-copy-source in your request. To specify a byte range, you add the request header x-amz-copy-source-range in your request.

For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.

Instead of copying data from an existing object as part data, you might use the UploadPart action to upload new data as a part of an object in your request.

You must initiate a multipart upload before you can upload any part. In response to your initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in your upload part request.

For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide. For information about copying objects using a single atomic action vs. a multipart upload, see Operations on Objects in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Authentication and authorization

All UploadPartCopy requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.

Directory buckets - You must use IAM credentials to authenticate and authorize your access to the UploadPartCopy API operation, instead of using the temporary security credentials through the CreateSession API operation.

Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.

Permissions

You must have READ access to the source object and WRITE access to the destination bucket.

  • General purpose bucket permissions - You must have the permissions in a policy based on the bucket types of your source bucket and destination bucket in an UploadPartCopy operation.

    • If the source object is in a general purpose bucket, you must have the s3:GetObject permission to read the source object that is being copied.

    • If the destination bucket is a general purpose bucket, you must have the s3:PutObject permission to write the object copy to the destination bucket.

    • To perform a multipart upload with encryption using an Key Management Service key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey actions on the key. The requester must also have permissions for the kms:GenerateDataKey action for the CreateMultipartUpload API. Then, the requester needs permissions for the kms:Decrypt action on the UploadPart and UploadPartCopy APIs. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information about KMS permissions, see Protecting data using server-side encryption with KMS in the Amazon S3 User Guide. For information about the permissions required to use the multipart upload API, see Multipart upload and permissions and Multipart upload API and permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in an UploadPartCopy operation.

    • If the source object that you want to copy is in a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to read the object. By default, the session is in the ReadWrite mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode condition key to ReadOnly on the copy source bucket.

    • If the copy destination is a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to write the object to the destination. The s3express:SessionMode condition key cannot be set to ReadOnly on the copy destination.

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

    For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.

Encryption

  • General purpose buckets - For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.

  • Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

    For directory buckets, when you perform a CreateMultipartUpload operation and an UploadPartCopy operation, the request headers you provide in the CreateMultipartUpload request must match the default encryption configuration of the destination bucket.

    S3 Bucket Keys aren\'t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through UploadPartCopy. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

Special errors

  • 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.

    • HTTP Status Code: 404 Not Found

  • Error Code: InvalidRequest

    • Description: The specified copy source is not supported as a byte-range copy source.

    • HTTP Status Code: 400 Bad Request

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to UploadPartCopy:

', 'WriteGetObjectResponse' => '

This operation is not supported for directory buckets.

Passes transformed objects to a GetObject operation when using Object Lambda access points. For information about Object Lambda access points, see Transforming objects with Object Lambda access points in the Amazon S3 User Guide.

This operation supports metadata that can be returned by GetObject, in addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage. The GetObject response metadata is supported so that the WriteGetObjectResponse caller, typically an Lambda function, can provide the same metadata when it internally invokes GetObject. When WriteGetObjectResponse is called by a customer-owned Lambda function, the metadata returned to the end user GetObject call might differ from what Amazon S3 would normally return.

You can include any number of metadata headers. When including a metadata header, it should be prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this is to forward GetObject metadata.

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.

For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.

', ], 'shapes' => [ 'AbortDate' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartUploadOutput$AbortDate' => '

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 Configuration in the Amazon S3 User Guide.

The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines the abort action.

This functionality is not supported for directory buckets.

', 'ListPartsOutput$AbortDate' => '

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 Configuration.

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 functionality is not supported for directory buckets.

', ], ], 'AbortIncompleteMultipartUpload' => [ 'base' => '

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.

', 'refs' => [ 'LifecycleRule$AbortIncompleteMultipartUpload' => NULL, 'Rule$AbortIncompleteMultipartUpload' => NULL, ], ], 'AbortMultipartUploadOutput' => [ 'base' => NULL, 'refs' => [], ], 'AbortMultipartUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'AbortRuleId' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartUploadOutput$AbortRuleId' => '

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.

This functionality is not supported for directory buckets.

', 'ListPartsOutput$AbortRuleId' => '

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.

This functionality is not supported for directory buckets.

', ], ], 'AccelerateConfiguration' => [ 'base' => '

Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide.

', 'refs' => [ 'PutBucketAccelerateConfigurationRequest$AccelerateConfiguration' => '

Container for setting the transfer acceleration state.

', ], ], 'AcceptRanges' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$AcceptRanges' => '

Indicates that a range of bytes was specified in the request.

', 'HeadObjectOutput$AcceptRanges' => '

Indicates that a range of bytes was specified.

', 'WriteGetObjectResponseRequest$AcceptRanges' => '

Indicates that a range of bytes was specified.

', ], ], 'AccessControlPolicy' => [ 'base' => '

Contains the elements that set the ACL permissions for an object per grantee.

', 'refs' => [ 'PutBucketAclRequest$AccessControlPolicy' => '

Contains the elements that set the ACL permissions for an object per grantee.

', 'PutObjectAclRequest$AccessControlPolicy' => '

Contains the elements that set the ACL permissions for an object per grantee.

', ], ], 'AccessControlTranslation' => [ 'base' => '

A container for information about access control for replicas.

', 'refs' => [ 'Destination$AccessControlTranslation' => '

Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the Amazon Web Services account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same Amazon Web Services account that owns the source object.

', ], ], 'AccessKeyIdValue' => [ 'base' => NULL, 'refs' => [ 'SessionCredentials$AccessKeyId' => '

A unique identifier that\'s associated with a secret access key. The access key ID and the secret access key are used together to sign programmatic Amazon Web Services requests cryptographically.

', ], ], 'AccessPointAlias' => [ 'base' => NULL, 'refs' => [ 'HeadBucketOutput$AccessPointAlias' => '

Indicates whether the bucket name used in the request is an access point alias.

For directory buckets, the value of this field is false.

', ], ], 'AccessPointArn' => [ 'base' => NULL, 'refs' => [ 'MetricsAndOperator$AccessPointArn' => '

The access point ARN used when evaluating an AND predicate.

', 'MetricsFilter$AccessPointArn' => '

The access point ARN used when evaluating a metrics filter.

', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartUploadRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'AnalyticsS3BucketDestination$BucketAccountId' => '

The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

', 'CompleteMultipartUploadRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'CopyObjectRequest$ExpectedBucketOwner' => '

The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'CopyObjectRequest$ExpectedSourceBucketOwner' => '

The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'CreateMultipartUploadRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketAnalyticsConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketCorsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketEncryptionRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'DeleteBucketInventoryConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketLifecycleRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'DeleteBucketMetricsConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketOwnershipControlsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketPolicyRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'DeleteBucketReplicationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'DeleteBucketTaggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketWebsiteRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteObjectRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteObjectTaggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteObjectsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeletePublicAccessBlockRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'Destination$Account' => '

Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the Amazon Web Services 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 S3 User Guide.

', 'GetBucketAccelerateConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketAclRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketAnalyticsConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketCorsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketEncryptionRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'GetBucketInventoryConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketLifecycleConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'GetBucketLifecycleRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketLocationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketLoggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketMetricsConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketNotificationConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketOwnershipControlsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketPolicyRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'GetBucketPolicyStatusRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketReplicationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketRequestPaymentRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketTaggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketVersioningRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketWebsiteRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectAclRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectAttributesRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectLegalHoldRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectLockConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectRetentionRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectTaggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectTorrentRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetPublicAccessBlockRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'HeadBucketRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'HeadObjectRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'InventoryS3BucketDestination$AccountId' => '

The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

', 'ListBucketAnalyticsConfigurationsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListBucketInventoryConfigurationsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListBucketMetricsConfigurationsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListMultipartUploadsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListObjectVersionsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListObjectsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListObjectsV2Request$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListPartsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketAccelerateConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketAclRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketAnalyticsConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketCorsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketEncryptionRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'PutBucketInventoryConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketLifecycleConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'PutBucketLifecycleRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketLoggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketMetricsConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketNotificationConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketNotificationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketOwnershipControlsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketPolicyRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'PutBucketReplicationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketRequestPaymentRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketTaggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketVersioningRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketWebsiteRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutObjectAclRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutObjectLegalHoldRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutObjectLockConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutObjectRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutObjectRetentionRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutObjectTaggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutPublicAccessBlockRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'RestoreObjectRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'SelectObjectContentRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'UploadPartCopyRequest$ExpectedBucketOwner' => '

The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'UploadPartCopyRequest$ExpectedSourceBucketOwner' => '

The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'UploadPartRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', ], ], 'AllowQuotedRecordDelimiter' => [ 'base' => NULL, 'refs' => [ 'CSVInput$AllowQuotedRecordDelimiter' => '

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.

', ], ], 'AllowedHeader' => [ 'base' => NULL, 'refs' => [ 'AllowedHeaders$member' => NULL, ], ], 'AllowedHeaders' => [ 'base' => NULL, 'refs' => [ 'CORSRule$AllowedHeaders' => '

Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

', ], ], 'AllowedMethod' => [ 'base' => NULL, 'refs' => [ 'AllowedMethods$member' => NULL, ], ], 'AllowedMethods' => [ 'base' => NULL, 'refs' => [ 'CORSRule$AllowedMethods' => '

An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.

', ], ], 'AllowedOrigin' => [ 'base' => NULL, 'refs' => [ 'AllowedOrigins$member' => NULL, ], ], 'AllowedOrigins' => [ 'base' => NULL, 'refs' => [ 'CORSRule$AllowedOrigins' => '

One or more origins you want customers to be able to access the bucket from.

', ], ], 'AnalyticsAndOperator' => [ 'base' => '

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates in any combination, and an object must match all of the predicates for the filter to apply.

', 'refs' => [ 'AnalyticsFilter$And' => '

A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

', ], ], 'AnalyticsConfiguration' => [ 'base' => '

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

', 'refs' => [ 'AnalyticsConfigurationList$member' => NULL, 'GetBucketAnalyticsConfigurationOutput$AnalyticsConfiguration' => '

The configuration and any analyses for the analytics filter.

', 'PutBucketAnalyticsConfigurationRequest$AnalyticsConfiguration' => '

The configuration and any analyses for the analytics filter.

', ], ], 'AnalyticsConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListBucketAnalyticsConfigurationsOutput$AnalyticsConfigurationList' => '

The list of analytics configurations for a bucket.

', ], ], 'AnalyticsExportDestination' => [ 'base' => '

Where to publish the analytics results.

', 'refs' => [ 'StorageClassAnalysisDataExport$Destination' => '

The place to store the data for an analysis.

', ], ], 'AnalyticsFilter' => [ 'base' => '

The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

', 'refs' => [ 'AnalyticsConfiguration$Filter' => '

The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

', ], ], 'AnalyticsId' => [ 'base' => NULL, 'refs' => [ 'AnalyticsConfiguration$Id' => '

The ID that identifies the analytics configuration.

', 'DeleteBucketAnalyticsConfigurationRequest$Id' => '

The ID that identifies the analytics configuration.

', 'GetBucketAnalyticsConfigurationRequest$Id' => '

The ID that identifies the analytics configuration.

', 'PutBucketAnalyticsConfigurationRequest$Id' => '

The ID that identifies the analytics configuration.

', ], ], 'AnalyticsS3BucketDestination' => [ 'base' => '

Contains information about where to publish the analytics results.

', 'refs' => [ 'AnalyticsExportDestination$S3BucketDestination' => '

A destination signifying output to an S3 bucket.

', ], ], 'AnalyticsS3ExportFileFormat' => [ 'base' => NULL, 'refs' => [ 'AnalyticsS3BucketDestination$Format' => '

Specifies the file format used when exporting data to Amazon S3.

', ], ], 'ArchiveStatus' => [ 'base' => NULL, 'refs' => [ 'HeadObjectOutput$ArchiveStatus' => '

The archive state of the head object.

This functionality is not supported for directory buckets.

', ], ], 'Body' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$Body' => '

Object data.

', 'GetObjectTorrentOutput$Body' => '

A Bencoded dictionary as defined by the BitTorrent specification

', 'PutObjectRequest$Body' => '

Object data.

', 'RecordsEvent$Payload' => '

The byte array of partial, one or more result records. S3 Select doesn\'t guarantee that a record will be self-contained in one record frame. To ensure continuous streaming of data, S3 Select might split the same record across multiple record frames instead of aggregating the results in memory. Some S3 clients (for example, the SDK for Java) handle this behavior by creating a ByteStream out of the response by default. Other clients might not handle this behavior by default. In those cases, you must aggregate the results on the client side and parse the response.

', 'UploadPartRequest$Body' => '

Object data.

', 'WriteGetObjectResponseRequest$Body' => '

The object data.

', ], ], 'Bucket' => [ 'base' => '

In terms of implementation, a Bucket is a resource.

', 'refs' => [ 'Buckets$member' => NULL, ], ], 'BucketAccelerateStatus' => [ 'base' => NULL, 'refs' => [ 'AccelerateConfiguration$Status' => '

Specifies the transfer acceleration status of the bucket.

', 'GetBucketAccelerateConfigurationOutput$Status' => '

The accelerate configuration of the bucket.

', ], ], 'BucketAlreadyExists' => [ 'base' => '

The requested bucket name is not available. The bucket namespace is shared by all users of the system. Select a different name and try again.

', 'refs' => [], ], 'BucketAlreadyOwnedByYou' => [ 'base' => '

The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services 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).

', 'refs' => [], ], 'BucketCannedACL' => [ 'base' => NULL, 'refs' => [ 'CreateBucketRequest$ACL' => '

The canned ACL to apply to the bucket.

This functionality is not supported for directory buckets.

', 'PutBucketAclRequest$ACL' => '

The canned ACL to apply to the bucket.

', ], ], 'BucketInfo' => [ 'base' => '

Specifies the information about the bucket that will be created. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

This functionality is only supported by directory buckets.

', 'refs' => [ 'CreateBucketConfiguration$Bucket' => '

Specifies the information about the bucket that will be created.

This functionality is only supported by directory buckets.

', ], ], 'BucketKeyEnabled' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$BucketKeyEnabled' => '

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'CopyObjectOutput$BucketKeyEnabled' => '

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'CopyObjectRequest$BucketKeyEnabled' => '

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object.

Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

Directory buckets - S3 Bucket Keys aren\'t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

', 'CreateMultipartUploadOutput$BucketKeyEnabled' => '

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'CreateMultipartUploadRequest$BucketKeyEnabled' => '

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).

General purpose buckets - Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn\'t affect bucket-level settings for S3 Bucket Key.

Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren\'t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

', 'CreateSessionOutput$BucketKeyEnabled' => '

Indicates whether to use an S3 Bucket Key for server-side encryption with KMS keys (SSE-KMS).

', 'CreateSessionRequest$BucketKeyEnabled' => '

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using KMS keys (SSE-KMS).

S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren\'t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

', 'GetObjectOutput$BucketKeyEnabled' => '

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'HeadObjectOutput$BucketKeyEnabled' => '

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'PutObjectOutput$BucketKeyEnabled' => '

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'PutObjectRequest$BucketKeyEnabled' => '

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).

General purpose buckets - Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn\'t affect bucket-level settings for S3 Bucket Key.

Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren\'t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

', 'ServerSideEncryptionRule$BucketKeyEnabled' => '

Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key.

', 'UploadPartCopyOutput$BucketKeyEnabled' => '

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'UploadPartOutput$BucketKeyEnabled' => '

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'WriteGetObjectResponseRequest$BucketKeyEnabled' => '

Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

', ], ], 'BucketLifecycleConfiguration' => [ 'base' => '

Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management in the Amazon S3 User Guide.

', 'refs' => [ 'PutBucketLifecycleConfigurationRequest$LifecycleConfiguration' => '

Container for lifecycle rules. You can add as many as 1,000 rules.

', ], ], 'BucketLocationConstraint' => [ 'base' => NULL, 'refs' => [ 'CreateBucketConfiguration$LocationConstraint' => '

Specifies the Region where the bucket will be created. 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 Europe (Ireland) Region. For more information, see Accessing a bucket in the Amazon S3 User Guide.

If you don\'t specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1) by default.

This functionality is not supported for directory buckets.

', 'GetBucketLocationOutput$LocationConstraint' => '

Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see Regions and Endpoints. Buckets in Region us-east-1 have a LocationConstraint of null.

', ], ], 'BucketLocationName' => [ 'base' => NULL, 'refs' => [ 'HeadBucketOutput$BucketLocationName' => '

The name of the location where the bucket will be created.

For directory buckets, the AZ ID of the Availability Zone where the bucket is created. An example AZ ID value is usw2-az1.

This functionality is only supported by directory buckets.

', ], ], 'BucketLoggingStatus' => [ 'base' => '

Container for logging status information.

', 'refs' => [ 'PutBucketLoggingRequest$BucketLoggingStatus' => '

Container for logging status information.

', ], ], 'BucketLogsPermission' => [ 'base' => NULL, 'refs' => [ 'TargetGrant$Permission' => '

Logging permissions assigned to the grantee for the bucket.

', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartUploadRequest$Bucket' => '

The bucket name to which the upload was taking place.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'AnalyticsS3BucketDestination$Bucket' => '

The Amazon Resource Name (ARN) of the bucket to which data is exported.

', 'Bucket$Name' => '

The name of the bucket.

', 'CompleteMultipartUploadOutput$Bucket' => '

The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.

Access points are not supported by directory buckets.

', 'CompleteMultipartUploadRequest$Bucket' => '

Name of the bucket to which the multipart upload was initiated.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'CopyObjectRequest$Bucket' => '

The name of the destination bucket.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'CreateBucketRequest$Bucket' => '

The name of the bucket to create.

General purpose buckets - For information about bucket naming restrictions, see Bucket naming rules in the Amazon S3 User Guide.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'CreateMultipartUploadOutput$Bucket' => '

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

Access points are not supported by directory buckets.

', 'CreateMultipartUploadRequest$Bucket' => '

The name of the bucket where the multipart upload is initiated and where the object is uploaded.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'CreateSessionRequest$Bucket' => '

The name of the bucket that you create a session for.

', 'DeleteBucketAnalyticsConfigurationRequest$Bucket' => '

The name of the bucket from which an analytics configuration is deleted.

', 'DeleteBucketCorsRequest$Bucket' => '

Specifies the bucket whose cors configuration is being deleted.

', 'DeleteBucketEncryptionRequest$Bucket' => '

The name of the bucket containing the server-side encryption configuration to delete.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'DeleteBucketIntelligentTieringConfigurationRequest$Bucket' => '

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

', 'DeleteBucketInventoryConfigurationRequest$Bucket' => '

The name of the bucket containing the inventory configuration to delete.

', 'DeleteBucketLifecycleRequest$Bucket' => '

The bucket name of the lifecycle to delete.

', 'DeleteBucketMetricsConfigurationRequest$Bucket' => '

The name of the bucket containing the metrics configuration to delete.

', 'DeleteBucketOwnershipControlsRequest$Bucket' => '

The Amazon S3 bucket whose OwnershipControls you want to delete.

', 'DeleteBucketPolicyRequest$Bucket' => '

The bucket name.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'DeleteBucketReplicationRequest$Bucket' => '

The bucket name.

', 'DeleteBucketRequest$Bucket' => '

Specifies the bucket being deleted.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'DeleteBucketTaggingRequest$Bucket' => '

The bucket that has the tag set to be removed.

', 'DeleteBucketWebsiteRequest$Bucket' => '

The bucket name for which you want to remove the website configuration.

', 'DeleteObjectRequest$Bucket' => '

The bucket name of the bucket containing the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'DeleteObjectTaggingRequest$Bucket' => '

The bucket name containing the objects from which to remove the tags.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'DeleteObjectsRequest$Bucket' => '

The bucket name containing the objects to delete.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'DeletePublicAccessBlockRequest$Bucket' => '

The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.

', 'Destination$Bucket' => '

The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.

', 'GetBucketAccelerateConfigurationRequest$Bucket' => '

The name of the bucket for which the accelerate configuration is retrieved.

', 'GetBucketAclRequest$Bucket' => '

Specifies the S3 bucket whose ACL is being requested.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

', 'GetBucketAnalyticsConfigurationRequest$Bucket' => '

The name of the bucket from which an analytics configuration is retrieved.

', 'GetBucketCorsRequest$Bucket' => '

The bucket name for which to get the cors configuration.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

', 'GetBucketEncryptionRequest$Bucket' => '

The name of the bucket from which the server-side encryption configuration is retrieved.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'GetBucketIntelligentTieringConfigurationRequest$Bucket' => '

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

', 'GetBucketInventoryConfigurationRequest$Bucket' => '

The name of the bucket containing the inventory configuration to retrieve.

', 'GetBucketLifecycleConfigurationRequest$Bucket' => '

The name of the bucket for which to get the lifecycle information.

', 'GetBucketLifecycleRequest$Bucket' => '

The name of the bucket for which to get the lifecycle information.

', 'GetBucketLocationRequest$Bucket' => '

The name of the bucket for which to get the location.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

', 'GetBucketLoggingRequest$Bucket' => '

The bucket name for which to get the logging information.

', 'GetBucketMetricsConfigurationRequest$Bucket' => '

The name of the bucket containing the metrics configuration to retrieve.

', 'GetBucketNotificationConfigurationRequest$Bucket' => '

The name of the bucket for which to get the notification configuration.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

', 'GetBucketOwnershipControlsRequest$Bucket' => '

The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.

', 'GetBucketPolicyRequest$Bucket' => '

The bucket name to get the bucket policy for.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

Access points - When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

Access points and Object Lambda access points are not supported by directory buckets.

', 'GetBucketPolicyStatusRequest$Bucket' => '

The name of the Amazon S3 bucket whose policy status you want to retrieve.

', 'GetBucketReplicationRequest$Bucket' => '

The bucket name for which to get the replication information.

', 'GetBucketRequestPaymentRequest$Bucket' => '

The name of the bucket for which to get the payment request configuration

', 'GetBucketTaggingRequest$Bucket' => '

The name of the bucket for which to get the tagging information.

', 'GetBucketVersioningRequest$Bucket' => '

The name of the bucket for which to get the versioning information.

', 'GetBucketWebsiteRequest$Bucket' => '

The bucket name for which to get the website configuration.

', 'GetObjectAclRequest$Bucket' => '

The bucket name that contains the object for which to get the ACL information.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

', 'GetObjectAttributesRequest$Bucket' => '

The name of the bucket that contains the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'GetObjectLegalHoldRequest$Bucket' => '

The bucket name containing the object whose legal hold status you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

', 'GetObjectLockConfigurationRequest$Bucket' => '

The bucket whose Object Lock configuration you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

', 'GetObjectRequest$Bucket' => '

The bucket name containing the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Object Lambda access points - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'GetObjectRetentionRequest$Bucket' => '

The bucket name containing the object whose retention settings you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

', 'GetObjectTaggingRequest$Bucket' => '

The bucket name containing the object for which to get the tagging information.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'GetObjectTorrentRequest$Bucket' => '

The name of the bucket containing the object for which to get the torrent files.

', 'GetPublicAccessBlockRequest$Bucket' => '

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.

', 'HeadBucketRequest$Bucket' => '

The bucket name.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'HeadObjectRequest$Bucket' => '

The name of the bucket that contains the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'InventoryS3BucketDestination$Bucket' => '

The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

', 'ListBucketAnalyticsConfigurationsRequest$Bucket' => '

The name of the bucket from which analytics configurations are retrieved.

', 'ListBucketIntelligentTieringConfigurationsRequest$Bucket' => '

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

', 'ListBucketInventoryConfigurationsRequest$Bucket' => '

The name of the bucket containing the inventory configurations to retrieve.

', 'ListBucketMetricsConfigurationsRequest$Bucket' => '

The name of the bucket containing the metrics configurations to retrieve.

', 'ListMultipartUploadsOutput$Bucket' => '

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

', 'ListMultipartUploadsRequest$Bucket' => '

The name of the bucket to which the multipart upload was initiated.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'ListObjectVersionsOutput$Name' => '

The bucket name.

', 'ListObjectVersionsRequest$Bucket' => '

The bucket name that contains the objects.

', 'ListObjectsOutput$Name' => '

The bucket name.

', 'ListObjectsRequest$Bucket' => '

The name of the bucket containing the objects.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'ListObjectsV2Output$Name' => '

The bucket name.

', 'ListObjectsV2Request$Bucket' => '

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'ListPartsOutput$Bucket' => '

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

', 'ListPartsRequest$Bucket' => '

The name of the bucket to which the parts are being uploaded.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'PutBucketAccelerateConfigurationRequest$Bucket' => '

The name of the bucket for which the accelerate configuration is set.

', 'PutBucketAclRequest$Bucket' => '

The bucket to which to apply the ACL.

', 'PutBucketAnalyticsConfigurationRequest$Bucket' => '

The name of the bucket to which an analytics configuration is stored.

', 'PutBucketCorsRequest$Bucket' => '

Specifies the bucket impacted by the corsconfiguration.

', 'PutBucketEncryptionRequest$Bucket' => '

Specifies default encryption for a bucket using server-side encryption with different key options.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'PutBucketIntelligentTieringConfigurationRequest$Bucket' => '

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

', 'PutBucketInventoryConfigurationRequest$Bucket' => '

The name of the bucket where the inventory configuration will be stored.

', 'PutBucketLifecycleConfigurationRequest$Bucket' => '

The name of the bucket for which to set the configuration.

', 'PutBucketLifecycleRequest$Bucket' => '

', 'PutBucketLoggingRequest$Bucket' => '

The name of the bucket for which to set the logging parameters.

', 'PutBucketMetricsConfigurationRequest$Bucket' => '

The name of the bucket for which the metrics configuration is set.

', 'PutBucketNotificationConfigurationRequest$Bucket' => '

The name of the bucket.

', 'PutBucketNotificationRequest$Bucket' => '

The name of the bucket.

', 'PutBucketOwnershipControlsRequest$Bucket' => '

The name of the Amazon S3 bucket whose OwnershipControls you want to set.

', 'PutBucketPolicyRequest$Bucket' => '

The name of the bucket.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'PutBucketReplicationRequest$Bucket' => '

The name of the bucket

', 'PutBucketRequestPaymentRequest$Bucket' => '

The bucket name.

', 'PutBucketTaggingRequest$Bucket' => '

The bucket name.

', 'PutBucketVersioningRequest$Bucket' => '

The bucket name.

', 'PutBucketWebsiteRequest$Bucket' => '

The bucket name.

', 'PutObjectAclRequest$Bucket' => '

The bucket name that contains the object to which you want to attach the ACL.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'PutObjectLegalHoldRequest$Bucket' => '

The bucket name containing the object that you want to place a legal hold on.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

', 'PutObjectLockConfigurationRequest$Bucket' => '

The bucket whose Object Lock configuration you want to create or replace.

', 'PutObjectRequest$Bucket' => '

The bucket name to which the PUT action was initiated.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'PutObjectRetentionRequest$Bucket' => '

The bucket name that contains the object you want to apply this Object Retention configuration to.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

', 'PutObjectTaggingRequest$Bucket' => '

The bucket name containing the object.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'PutPublicAccessBlockRequest$Bucket' => '

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.

', 'RestoreObjectRequest$Bucket' => '

The bucket name containing the object to restore.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'S3Location$BucketName' => '

The name of the bucket where the restore results will be placed.

', 'SelectObjectContentRequest$Bucket' => '

The S3 bucket.

', 'UploadPartCopyRequest$Bucket' => '

The bucket name.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'UploadPartRequest$Bucket' => '

The name of the bucket to which the multipart upload was initiated.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', ], ], 'BucketRegion' => [ 'base' => NULL, 'refs' => [ 'Bucket$BucketRegion' => '

BucketRegion indicates the Amazon Web Services region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.

', 'ListBucketsRequest$BucketRegion' => '

Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services Region must be expressed according to the Amazon Web Services Region code, such as us-west-2 for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.

Requests made to a Regional endpoint that is different from the bucket-region parameter are not supported. For example, if you want to limit the response to your buckets in Region us-west-2, the request must be made to an endpoint in Region us-west-2.

', ], ], 'BucketType' => [ 'base' => NULL, 'refs' => [ 'BucketInfo$Type' => '

The type of bucket.

', ], ], 'BucketVersioningStatus' => [ 'base' => NULL, 'refs' => [ 'GetBucketVersioningOutput$Status' => '

The versioning state of the bucket.

', 'VersioningConfiguration$Status' => '

The versioning state of the bucket.

', ], ], 'Buckets' => [ 'base' => NULL, 'refs' => [ 'ListBucketsOutput$Buckets' => '

The list of buckets owned by the requester.

', 'ListDirectoryBucketsOutput$Buckets' => '

The list of buckets owned by the requester.

', ], ], 'BypassGovernanceRetention' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectRequest$BypassGovernanceRetention' => '

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:BypassGovernanceRetention permission.

This functionality is not supported for directory buckets.

', 'DeleteObjectsRequest$BypassGovernanceRetention' => '

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the s3:BypassGovernanceRetention permission.

This functionality is not supported for directory buckets.

', 'PutObjectRetentionRequest$BypassGovernanceRetention' => '

Indicates whether this action should bypass Governance-mode restrictions.

', ], ], 'BytesProcessed' => [ 'base' => NULL, 'refs' => [ 'Progress$BytesProcessed' => '

The current number of uncompressed object bytes processed.

', 'Stats$BytesProcessed' => '

The total number of uncompressed object bytes processed.

', ], ], 'BytesReturned' => [ 'base' => NULL, 'refs' => [ 'Progress$BytesReturned' => '

The current number of bytes of records payload data returned.

', 'Stats$BytesReturned' => '

The total number of bytes of records payload data returned.

', ], ], 'BytesScanned' => [ 'base' => NULL, 'refs' => [ 'Progress$BytesScanned' => '

The current number of object bytes scanned.

', 'Stats$BytesScanned' => '

The total number of object bytes scanned.

', ], ], 'CORSConfiguration' => [ 'base' => '

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 S3 User Guide.

', 'refs' => [ 'PutBucketCorsRequest$CORSConfiguration' => '

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 S3 User Guide.

', ], ], 'CORSRule' => [ 'base' => '

Specifies a cross-origin access rule for an Amazon S3 bucket.

', 'refs' => [ 'CORSRules$member' => NULL, ], ], 'CORSRules' => [ 'base' => NULL, 'refs' => [ 'CORSConfiguration$CORSRules' => '

A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.

', 'GetBucketCorsOutput$CORSRules' => '

A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.

', ], ], 'CSVInput' => [ 'base' => '

Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.

', 'refs' => [ 'InputSerialization$CSV' => '

Describes the serialization of a CSV-encoded object.

', ], ], 'CSVOutput' => [ 'base' => '

Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.

', 'refs' => [ 'OutputSerialization$CSV' => '

Describes the serialization of CSV-encoded Select results.

', ], ], 'CacheControl' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CacheControl' => '

Specifies the caching behavior along the request/reply chain.

', 'CreateMultipartUploadRequest$CacheControl' => '

Specifies caching behavior along the request/reply chain.

', 'GetObjectOutput$CacheControl' => '

Specifies caching behavior along the request/reply chain.

', 'HeadObjectOutput$CacheControl' => '

Specifies caching behavior along the request/reply chain.

', 'PutObjectRequest$CacheControl' => '

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

', 'WriteGetObjectResponseRequest$CacheControl' => '

Specifies caching behavior along the request/reply chain.

', ], ], 'Checksum' => [ 'base' => '

Contains all the possible checksum or digest values for an object.

', 'refs' => [ 'GetObjectAttributesOutput$Checksum' => '

The checksum or digest of the object.

', ], ], 'ChecksumAlgorithm' => [ 'base' => NULL, 'refs' => [ 'ChecksumAlgorithmList$member' => NULL, 'CopyObjectRequest$ChecksumAlgorithm' => '

Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

When you copy an object, if the source object has a checksum, that checksum value will be copied to the new object by default. If the CopyObject request does not include this x-amz-checksum-algorithm header, the checksum algorithm will be copied from the source object to the destination object (if it\'s present on the source object). You can optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm header. Unrecognized or unsupported values will respond with the HTTP status code 400 Bad Request.

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that\'s used for performance.

', 'CreateMultipartUploadOutput$ChecksumAlgorithm' => '

The algorithm that was used to create a checksum of the object.

', 'CreateMultipartUploadRequest$ChecksumAlgorithm' => '

Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'DeleteObjectsRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:

For more information, see Checking object integrity in the Amazon S3 User Guide.

If the individual checksum value you provide through x-amz-checksum-algorithm doesn\'t match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'ListPartsOutput$ChecksumAlgorithm' => '

The algorithm that was used to create a checksum of the object.

', 'MultipartUpload$ChecksumAlgorithm' => '

The algorithm that was used to create a checksum of the object.

', 'PutBucketAccelerateConfigurationRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketAclRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketCorsRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketEncryptionRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that\'s used for performance.

', 'PutBucketLifecycleConfigurationRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketLifecycleRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketLoggingRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketNotificationRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketPolicyRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:

For more information, see Checking object integrity in the Amazon S3 User Guide.

If the individual checksum value you provide through x-amz-checksum-algorithm doesn\'t match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that\'s used for performance.

', 'PutBucketReplicationRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketRequestPaymentRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketTaggingRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketVersioningRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketWebsiteRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutObjectAclRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutObjectLegalHoldRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutObjectLockConfigurationRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutObjectRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:

For more information, see Checking object integrity in the Amazon S3 User Guide.

If the individual checksum value you provide through x-amz-checksum-algorithm doesn\'t match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .

The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that\'s used for performance.

', 'PutObjectRetentionRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutObjectTaggingRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutPublicAccessBlockRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'RestoreObjectRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'UploadPartRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

', ], ], 'ChecksumAlgorithmList' => [ 'base' => NULL, 'refs' => [ 'Object$ChecksumAlgorithm' => '

The algorithm that was used to create a checksum of the object.

', 'ObjectVersion$ChecksumAlgorithm' => '

The algorithm that was used to create a checksum of the object.

', ], ], 'ChecksumCRC32' => [ 'base' => NULL, 'refs' => [ 'Checksum$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadOutput$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadRequest$ChecksumCRC32' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CompletedPart$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyObjectResult$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyPartResult$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'GetObjectOutput$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'HeadObjectOutput$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'ObjectPart$ChecksumCRC32' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'Part$ChecksumCRC32' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectOutput$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectRequest$ChecksumCRC32' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartOutput$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartRequest$ChecksumCRC32' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'WriteGetObjectResponseRequest$ChecksumCRC32' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

', ], ], 'ChecksumCRC32C' => [ 'base' => NULL, 'refs' => [ 'Checksum$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadOutput$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadRequest$ChecksumCRC32C' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CompletedPart$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyObjectResult$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyPartResult$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'GetObjectOutput$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'HeadObjectOutput$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'ObjectPart$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'Part$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectOutput$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectRequest$ChecksumCRC32C' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartOutput$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartRequest$ChecksumCRC32C' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'WriteGetObjectResponseRequest$ChecksumCRC32C' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

', ], ], 'ChecksumMode' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ChecksumMode' => '

To retrieve the checksum, this mode must be enabled.

General purpose buckets - In addition, if you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.

', 'HeadObjectRequest$ChecksumMode' => '

To retrieve the checksum, this parameter must be enabled.

General purpose buckets - If you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.

Directory buckets - If you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

', ], ], 'ChecksumSHA1' => [ 'base' => NULL, 'refs' => [ 'Checksum$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadOutput$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadRequest$ChecksumSHA1' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CompletedPart$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyObjectResult$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyPartResult$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'GetObjectOutput$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'HeadObjectOutput$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'ObjectPart$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'Part$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectOutput$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectRequest$ChecksumSHA1' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartOutput$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartRequest$ChecksumSHA1' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'WriteGetObjectResponseRequest$ChecksumSHA1' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

', ], ], 'ChecksumSHA256' => [ 'base' => NULL, 'refs' => [ 'Checksum$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadOutput$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadRequest$ChecksumSHA256' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CompletedPart$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyObjectResult$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyPartResult$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'GetObjectOutput$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'HeadObjectOutput$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'ObjectPart$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'Part$ChecksumSHA256' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectOutput$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectRequest$ChecksumSHA256' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartOutput$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartRequest$ChecksumSHA256' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'WriteGetObjectResponseRequest$ChecksumSHA256' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

', ], ], 'CloudFunction' => [ 'base' => NULL, 'refs' => [ 'CloudFunctionConfiguration$CloudFunction' => '

Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.

', ], ], 'CloudFunctionConfiguration' => [ 'base' => '

Container for specifying the Lambda notification configuration.

', 'refs' => [ 'NotificationConfigurationDeprecated$CloudFunctionConfiguration' => '

Container for specifying the Lambda notification configuration.

', ], ], 'CloudFunctionInvocationRole' => [ 'base' => NULL, 'refs' => [ 'CloudFunctionConfiguration$InvocationRole' => '

The role supporting the invocation of the Lambda function

', ], ], 'Code' => [ 'base' => NULL, 'refs' => [ 'Error$Code' => '

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. The following is a list of Amazon S3 error codes. For more information, see Error responses.

', ], ], 'Comments' => [ 'base' => NULL, 'refs' => [ 'CSVInput$Comments' => '

A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is #.

Default: #

', ], ], 'CommonPrefix' => [ 'base' => '

Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.

', 'refs' => [ 'CommonPrefixList$member' => NULL, ], ], 'CommonPrefixList' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$CommonPrefixes' => '

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.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

', 'ListObjectVersionsOutput$CommonPrefixes' => '

All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

', 'ListObjectsOutput$CommonPrefixes' => '

All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by the delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/), as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

', 'ListObjectsV2Output$CommonPrefixes' => '

All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

', ], ], 'CompleteMultipartUploadOutput' => [ 'base' => NULL, 'refs' => [], ], 'CompleteMultipartUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'CompletedMultipartUpload' => [ 'base' => '

The container for the completed multipart upload details.

', 'refs' => [ 'CompleteMultipartUploadRequest$MultipartUpload' => '

The container for the multipart upload request information.

', ], ], 'CompletedPart' => [ 'base' => '

Details of the parts that were uploaded.

', 'refs' => [ 'CompletedPartList$member' => NULL, ], ], 'CompletedPartList' => [ 'base' => NULL, 'refs' => [ 'CompletedMultipartUpload$Parts' => '

Array of CompletedPart data types.

If you do not supply a valid Part with your request, the service sends back an HTTP 400 response.

', ], ], 'CompressionType' => [ 'base' => NULL, 'refs' => [ 'InputSerialization$CompressionType' => '

Specifies object\'s compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.

', ], ], 'Condition' => [ 'base' => '

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.

', 'refs' => [ 'RoutingRule$Condition' => '

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.

', ], ], 'ConfirmRemoveSelfBucketAccess' => [ 'base' => NULL, 'refs' => [ 'PutBucketPolicyRequest$ConfirmRemoveSelfBucketAccess' => '

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

This functionality is not supported for directory buckets.

', ], ], 'ContentDisposition' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ContentDisposition' => '

Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.

', 'CreateMultipartUploadRequest$ContentDisposition' => '

Specifies presentational information for the object.

', 'GetObjectOutput$ContentDisposition' => '

Specifies presentational information for the object.

', 'HeadObjectOutput$ContentDisposition' => '

Specifies presentational information for the object.

', 'PutObjectRequest$ContentDisposition' => '

Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.

', 'WriteGetObjectResponseRequest$ContentDisposition' => '

Specifies presentational information for the object.

', ], ], 'ContentEncoding' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ContentEncoding' => '

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

For directory buckets, only the aws-chunked value is supported in this header field.

', 'CreateMultipartUploadRequest$ContentEncoding' => '

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

For directory buckets, only the aws-chunked value is supported in this header field.

', 'GetObjectOutput$ContentEncoding' => '

Indicates what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

', 'HeadObjectOutput$ContentEncoding' => '

Indicates what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

', 'PutObjectRequest$ContentEncoding' => '

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding.

', 'WriteGetObjectResponseRequest$ContentEncoding' => '

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

', ], ], 'ContentLanguage' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ContentLanguage' => '

The language the content is in.

', 'CreateMultipartUploadRequest$ContentLanguage' => '

The language that the content is in.

', 'GetObjectOutput$ContentLanguage' => '

The language the content is in.

', 'HeadObjectOutput$ContentLanguage' => '

The language the content is in.

', 'PutObjectRequest$ContentLanguage' => '

The language the content is in.

', 'WriteGetObjectResponseRequest$ContentLanguage' => '

The language the content is in.

', ], ], 'ContentLength' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$ContentLength' => '

Size of the body in bytes.

', 'HeadObjectOutput$ContentLength' => '

Size of the body in bytes.

', 'PutObjectRequest$ContentLength' => '

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.

', 'UploadPartRequest$ContentLength' => '

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

', 'WriteGetObjectResponseRequest$ContentLength' => '

The size of the content body in bytes.

', ], ], 'ContentMD5' => [ 'base' => NULL, 'refs' => [ 'PutBucketAclRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketCorsRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketEncryptionRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

This functionality is not supported for directory buckets.

', 'PutBucketLifecycleRequest$ContentMD5' => '

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketLoggingRequest$ContentMD5' => '

The MD5 hash of the PutBucketLogging request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketNotificationRequest$ContentMD5' => '

The MD5 hash of the PutPublicAccessBlock request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketOwnershipControlsRequest$ContentMD5' => '

The MD5 hash of the OwnershipControls request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketPolicyRequest$ContentMD5' => '

The MD5 hash of the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

This functionality is not supported for directory buckets.

', 'PutBucketReplicationRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketRequestPaymentRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketTaggingRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketVersioningRequest$ContentMD5' => '

>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketWebsiteRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutObjectAclRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.>

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutObjectLegalHoldRequest$ContentMD5' => '

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutObjectLockConfigurationRequest$ContentMD5' => '

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutObjectRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'PutObjectRetentionRequest$ContentMD5' => '

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutObjectTaggingRequest$ContentMD5' => '

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutPublicAccessBlockRequest$ContentMD5' => '

The MD5 hash of the PutPublicAccessBlock request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'UploadPartRequest$ContentMD5' => '

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.

This functionality is not supported for directory buckets.

', ], ], 'ContentRange' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$ContentRange' => '

The portion of the object returned in the response.

', 'WriteGetObjectResponseRequest$ContentRange' => '

The portion of the object returned in the response.

', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ContentType' => '

A standard MIME type that describes the format of the object data.

', 'CreateMultipartUploadRequest$ContentType' => '

A standard MIME type describing the format of the object data.

', 'GetObjectOutput$ContentType' => '

A standard MIME type describing the format of the object data.

', 'HeadObjectOutput$ContentType' => '

A standard MIME type describing the format of the object data.

', 'PutObjectRequest$ContentType' => '

A standard MIME type describing the format of the contents. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.

', 'WriteGetObjectResponseRequest$ContentType' => '

A standard MIME type describing the format of the object data.

', ], ], 'ContinuationEvent' => [ 'base' => '

', 'refs' => [ 'SelectObjectContentEventStream$Cont' => '

The Continuation Event.

', ], ], 'CopyObjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'CopyObjectRequest' => [ 'base' => NULL, 'refs' => [], ], 'CopyObjectResult' => [ 'base' => '

Container for all response elements.

', 'refs' => [ 'CopyObjectOutput$CopyObjectResult' => '

Container for all response elements.

', ], ], 'CopyPartResult' => [ 'base' => '

Container for all response elements.

', 'refs' => [ 'UploadPartCopyOutput$CopyPartResult' => '

Container for all response elements.

', ], ], 'CopySource' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySource' => '

Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket.

You specify the value of the copy source in one of two formats, depending on whether you want to access the source object through an access point:

If your source bucket versioning is enabled, the x-amz-copy-source header by default 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 query parameter. Specifically, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don\'t specify a version ID, Amazon S3 copies the latest version of the source object.

If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the copied object. 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 destination bucket, the version ID that Amazon S3 generates in the x-amz-version-id response header is always null.

Directory buckets - S3 Versioning isn\'t enabled and supported for directory buckets.

', 'UploadPartCopyRequest$CopySource' => '

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

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 source object to copy. To copy a specific version of the source object to copy, append ?versionId=<version-id> to the x-amz-copy-source request header (for example, x-amz-copy-source: /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).

If the current version is a delete marker and you don\'t specify a versionId in the x-amz-copy-source request header, Amazon S3 returns a 404 Not Found 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 Bad Request error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source.

Directory buckets - S3 Versioning isn\'t enabled and supported for directory buckets.

', ], ], 'CopySourceIfMatch' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceIfMatch' => '

Copies the object if its entity tag (ETag) matches the specified tag.

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:

', 'UploadPartCopyRequest$CopySourceIfMatch' => '

Copies the object if its entity tag (ETag) matches the specified tag.

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.

', ], ], 'CopySourceIfModifiedSince' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceIfModifiedSince' => '

Copies the object if it has been modified since the specified time.

If both 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:

', 'UploadPartCopyRequest$CopySourceIfModifiedSince' => '

Copies the object if it has been modified since the specified time.

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.

', ], ], 'CopySourceIfNoneMatch' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceIfNoneMatch' => '

Copies the object if its entity tag (ETag) is different than the specified ETag.

If both 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:

', 'UploadPartCopyRequest$CopySourceIfNoneMatch' => '

Copies the object if its entity tag (ETag) is different than the specified ETag.

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.

', ], ], 'CopySourceIfUnmodifiedSince' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceIfUnmodifiedSince' => '

Copies the object if it hasn\'t been modified since the specified time.

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:

', 'UploadPartCopyRequest$CopySourceIfUnmodifiedSince' => '

Copies the object if it hasn\'t been modified since the specified time.

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.

', ], ], 'CopySourceRange' => [ 'base' => NULL, 'refs' => [ 'UploadPartCopyRequest$CopySourceRange' => '

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.

', ], ], 'CopySourceSSECustomerAlgorithm' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceSSECustomerAlgorithm' => '

Specifies the algorithm to use when decrypting the source object (for example, AES256).

If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

This functionality is not supported when the source object is in a directory bucket.

', 'UploadPartCopyRequest$CopySourceSSECustomerAlgorithm' => '

Specifies the algorithm to use when decrypting the source object (for example, AES256).

This functionality is not supported when the source object is in a directory bucket.

', ], ], 'CopySourceSSECustomerKey' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceSSECustomerKey' => '

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be the same one that was used when the source object was created.

If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

This functionality is not supported when the source object is in a directory bucket.

', 'UploadPartCopyRequest$CopySourceSSECustomerKey' => '

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

This functionality is not supported when the source object is in a directory bucket.

', ], ], 'CopySourceSSECustomerKeyMD5' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceSSECustomerKeyMD5' => '

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.

If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

This functionality is not supported when the source object is in a directory bucket.

', 'UploadPartCopyRequest$CopySourceSSECustomerKeyMD5' => '

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.

This functionality is not supported when the source object is in a directory bucket.

', ], ], 'CopySourceVersionId' => [ 'base' => NULL, 'refs' => [ 'CopyObjectOutput$CopySourceVersionId' => '

Version ID of the source object that was copied.

This functionality is not supported when the source object is in a directory bucket.

', 'UploadPartCopyOutput$CopySourceVersionId' => '

The version of the source object that was copied, if you have enabled versioning on the source bucket.

This functionality is not supported when the source object is in a directory bucket.

', ], ], 'CreateBucketConfiguration' => [ 'base' => '

The configuration information for the bucket.

', 'refs' => [ 'CreateBucketRequest$CreateBucketConfiguration' => '

The configuration information for the bucket.

', ], ], 'CreateBucketOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMultipartUploadOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateMultipartUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSessionOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreationDate' => [ 'base' => NULL, 'refs' => [ 'Bucket$CreationDate' => '

Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.

', ], ], 'DataRedundancy' => [ 'base' => NULL, 'refs' => [ 'BucketInfo$DataRedundancy' => '

The number of Availability Zone that\'s used for redundancy for the bucket.

', ], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'LifecycleExpiration$Date' => '

Indicates at what date the object is to be moved or deleted. The date value must conform to the ISO 8601 format. The time is always midnight UTC.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'ObjectLockRetention$RetainUntilDate' => '

The date on which this Object Lock Retention will expire.

', 'Transition$Date' => '

Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

', ], ], 'Days' => [ 'base' => NULL, 'refs' => [ 'DefaultRetention$Days' => '

The number of days that you want to specify for the default retention period. Must be used with Mode.

', 'LifecycleExpiration$Days' => '

Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

', 'NoncurrentVersionExpiration$NoncurrentDays' => '

Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'NoncurrentVersionTransition$NoncurrentDays' => '

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 S3 User Guide.

', 'RestoreRequest$Days' => '

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

', 'Transition$Days' => '

Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

', ], ], 'DaysAfterInitiation' => [ 'base' => NULL, 'refs' => [ 'AbortIncompleteMultipartUpload$DaysAfterInitiation' => '

Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.

', ], ], 'DefaultRetention' => [ 'base' => '

The container element for optionally specifying the default Object Lock retention settings for new objects placed in the specified bucket.

', 'refs' => [ 'ObjectLockRule$DefaultRetention' => '

The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

', ], ], 'Delete' => [ 'base' => '

Container for the objects to delete.

', 'refs' => [ 'DeleteObjectsRequest$Delete' => '

Container for the request.

', ], ], 'DeleteBucketAnalyticsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketCorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketEncryptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketIntelligentTieringConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketInventoryConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketLifecycleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketMetricsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketOwnershipControlsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketReplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketTaggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketWebsiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMarker' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectOutput$DeleteMarker' => '

Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.

This functionality is not supported for directory buckets.

', 'DeletedObject$DeleteMarker' => '

Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.

This functionality is not supported for directory buckets.

', 'GetObjectAttributesOutput$DeleteMarker' => '

Specifies whether the object retrieved was (true) or was not (false) a delete marker. If false, this response header does not appear in the response.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$DeleteMarker' => '

Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

', 'HeadObjectOutput$DeleteMarker' => '

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$DeleteMarker' => '

Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.

', ], ], 'DeleteMarkerEntry' => [ 'base' => '

Information about the delete marker.

', 'refs' => [ 'DeleteMarkers$member' => NULL, ], ], 'DeleteMarkerReplication' => [ 'base' => '

Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

For more information about delete marker replication, see Basic Rule Configuration.

If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.

', 'refs' => [ 'ReplicationRule$DeleteMarkerReplication' => NULL, ], ], 'DeleteMarkerReplicationStatus' => [ 'base' => NULL, 'refs' => [ 'DeleteMarkerReplication$Status' => '

Indicates whether to replicate delete markers.

Indicates whether to replicate delete markers.

', ], ], 'DeleteMarkerVersionId' => [ 'base' => NULL, 'refs' => [ 'DeletedObject$DeleteMarkerVersionId' => '

The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.

This functionality is not supported for directory buckets.

', ], ], 'DeleteMarkers' => [ 'base' => NULL, 'refs' => [ 'ListObjectVersionsOutput$DeleteMarkers' => '

Container for an object that is a delete marker.

', ], ], 'DeleteObjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteObjectRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteObjectTaggingOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteObjectTaggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteObjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteObjectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePublicAccessBlockRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletedObject' => [ 'base' => '

Information about the deleted object.

', 'refs' => [ 'DeletedObjects$member' => NULL, ], ], 'DeletedObjects' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectsOutput$Deleted' => '

Container element for a successful delete. It identifies the object that was successfully deleted.

', ], ], 'Delimiter' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$Delimiter' => '

Contains the delimiter you specified in the request. If you don\'t specify a delimiter in your request, this element is absent from the response.

Directory buckets - For directory buckets, / is the only supported delimiter.

', 'ListMultipartUploadsRequest$Delimiter' => '

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don\'t specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

Directory buckets - For directory buckets, / is the only supported delimiter.

', 'ListObjectVersionsOutput$Delimiter' => '

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.

', 'ListObjectVersionsRequest$Delimiter' => '

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.

', 'ListObjectsOutput$Delimiter' => '

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.

', 'ListObjectsRequest$Delimiter' => '

A delimiter is a character that you use to group keys.

', 'ListObjectsV2Output$Delimiter' => '

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.

Directory buckets - For directory buckets, / is the only supported delimiter.

', 'ListObjectsV2Request$Delimiter' => '

A delimiter is a character that you use to group keys.

', ], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'RestoreRequest$Description' => '

The optional description for the job.

', ], ], 'Destination' => [ 'base' => '

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).

', 'refs' => [ 'ReplicationRule$Destination' => '

A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).

', ], ], 'DirectoryBucketToken' => [ 'base' => NULL, 'refs' => [ 'ListDirectoryBucketsOutput$ContinuationToken' => '

If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response.

', 'ListDirectoryBucketsRequest$ContinuationToken' => '

ContinuationToken indicates to Amazon S3 that the list is being continued on buckets in this account with a token. ContinuationToken is obfuscated and is not a real bucket name. You can use this ContinuationToken for the pagination of the list results.

', ], ], 'DisplayName' => [ 'base' => NULL, 'refs' => [ 'Grantee$DisplayName' => '

Screen name of the grantee.

', 'Initiator$DisplayName' => '

Name of the Principal.

This functionality is not supported for directory buckets.

', 'Owner$DisplayName' => '

Container for the display name of the owner. This value is only supported in the following Amazon Web Services Regions:

This functionality is not supported for directory buckets.

', ], ], 'ETag' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$ETag' => '

Entity tag that identifies the newly created object\'s data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits. For more information about how the entity tag is calculated, see Checking object integrity in the Amazon S3 User Guide.

', 'CompletedPart$ETag' => '

Entity tag returned when the part was uploaded.

', 'CopyObjectResult$ETag' => '

Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata.

', 'CopyPartResult$ETag' => '

Entity tag of the object.

', 'GetObjectAttributesOutput$ETag' => '

An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

', 'GetObjectOutput$ETag' => '

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

', 'HeadObjectOutput$ETag' => '

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

', 'Object$ETag' => '

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

Directory buckets - MD5 is not supported by directory buckets.

', 'ObjectIdentifier$ETag' => '

An entity tag (ETag) is an identifier assigned by a web server to a specific version of a resource found at a URL. This header field makes the request method conditional on ETags.

Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings unique to the object.

', 'ObjectVersion$ETag' => '

The entity tag is an MD5 hash of that version of the object.

', 'Part$ETag' => '

Entity tag returned when the part was uploaded.

', 'PutObjectOutput$ETag' => '

Entity tag for the uploaded object.

General purpose buckets - To ensure that data is not corrupted traversing the network, for objects where the ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

Directory buckets - The ETag for the object in a directory bucket isn\'t the MD5 digest of the object.

', 'UploadPartOutput$ETag' => '

Entity tag for the uploaded object.

', 'WriteGetObjectResponseRequest$ETag' => '

An opaque identifier assigned by a web server to a specific version of a resource found at a URL.

', ], ], 'EmailAddress' => [ 'base' => NULL, 'refs' => [ 'Grantee$EmailAddress' => '

Email address of the grantee.

Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

', ], ], 'EnableRequestProgress' => [ 'base' => NULL, 'refs' => [ 'RequestProgress$Enabled' => '

Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE.

', ], ], 'EncodingType' => [ 'base' => '

Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can\'t parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren\'t supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.

When using the URL encoding type, non-ASCII characters that are used in an object\'s key name will be percent-encoded according to UTF-8 code values. For example, the object test_file(3).png will appear as test_file%283%29.png.

', 'refs' => [ 'ListMultipartUploadsOutput$EncodingType' => '

Encoding type used by Amazon S3 to encode object keys in the response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

', 'ListMultipartUploadsRequest$EncodingType' => NULL, 'ListObjectVersionsOutput$EncodingType' => '

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

', 'ListObjectVersionsRequest$EncodingType' => NULL, 'ListObjectsOutput$EncodingType' => '

Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can\'t parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren\'t supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.

When using the URL encoding type, non-ASCII characters that are used in an object\'s key name will be percent-encoded according to UTF-8 code values. For example, the object test_file(3).png will appear as test_file%283%29.png.

', 'ListObjectsRequest$EncodingType' => NULL, 'ListObjectsV2Output$EncodingType' => '

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, Prefix, Key, and StartAfter.

', 'ListObjectsV2Request$EncodingType' => '

Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can\'t parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren\'t supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.

When using the URL encoding type, non-ASCII characters that are used in an object\'s key name will be percent-encoded according to UTF-8 code values. For example, the object test_file(3).png will appear as test_file%283%29.png.

', ], ], 'Encryption' => [ 'base' => '

Contains the type of server-side encryption used.

', 'refs' => [ 'S3Location$Encryption' => NULL, ], ], 'EncryptionConfiguration' => [ 'base' => '

Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.

If you\'re specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that\'s encrypted with a KMS key that belongs to the requester, and not the bucket owner.

', 'refs' => [ 'Destination$EncryptionConfiguration' => '

A container that provides information about encryption. If SourceSelectionCriteria is specified, you must specify this element.

', ], ], 'EncryptionTypeMismatch' => [ 'base' => '

The existing object was created with a different encryption type. Subsequent write requests must include the appropriate encryption parameters in the request or while creating the session.

', 'refs' => [], ], 'End' => [ 'base' => NULL, 'refs' => [ 'ScanRange$End' => '

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.

', ], ], 'EndEvent' => [ 'base' => '

A message that indicates the request is complete and no more messages will be sent. You should not assume that the request is complete until the client receives an EndEvent.

', 'refs' => [ 'SelectObjectContentEventStream$End' => '

The End Event.

', ], ], 'Error' => [ 'base' => '

Container for all error elements.

', 'refs' => [ 'Errors$member' => NULL, ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'WriteGetObjectResponseRequest$ErrorCode' => '

A string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. The regular expression (regex) value is "^[A-Z][a-zA-Z]+$".

', ], ], 'ErrorDocument' => [ 'base' => '

The error information.

', 'refs' => [ 'GetBucketWebsiteOutput$ErrorDocument' => '

The object key name of the website error document to use for 4XX class errors.

', 'WebsiteConfiguration$ErrorDocument' => '

The name of the error document for the website.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'WriteGetObjectResponseRequest$ErrorMessage' => '

Contains a generic description of the error condition. Returned in the <Message> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.

', ], ], 'Errors' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectsOutput$Errors' => '

Container for a failed delete action that describes the object that Amazon S3 attempted to delete and the error it encountered.

', ], ], 'Event' => [ 'base' => '

The bucket event for which to send notifications.

', 'refs' => [ 'CloudFunctionConfiguration$Event' => NULL, 'EventList$member' => NULL, 'QueueConfigurationDeprecated$Event' => NULL, 'TopicConfigurationDeprecated$Event' => '

Bucket event for which to send notifications.

', ], ], 'EventBridgeConfiguration' => [ 'base' => '

A container for specifying the configuration for Amazon EventBridge.

', 'refs' => [ 'NotificationConfiguration$EventBridgeConfiguration' => '

Enables delivery of events to Amazon EventBridge.

', ], ], 'EventList' => [ 'base' => NULL, 'refs' => [ 'CloudFunctionConfiguration$Events' => '

Bucket events for which to send notifications.

', 'LambdaFunctionConfiguration$Events' => '

The Amazon S3 bucket event for which to invoke the Lambda function. For more information, see Supported Event Types in the Amazon S3 User Guide.

', 'QueueConfiguration$Events' => '

A collection of bucket events for which to send notifications

', 'QueueConfigurationDeprecated$Events' => '

A collection of bucket events for which to send notifications.

', 'TopicConfiguration$Events' => '

The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon S3 User Guide.

', 'TopicConfigurationDeprecated$Events' => '

A collection of events related to objects

', ], ], 'ExistingObjectReplication' => [ 'base' => '

Optional configuration to replicate existing source bucket objects.

This parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the Amazon S3 User Guide.

', 'refs' => [ 'ReplicationRule$ExistingObjectReplication' => '

Optional configuration to replicate existing source bucket objects.

This parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the Amazon S3 User Guide.

', ], ], 'ExistingObjectReplicationStatus' => [ 'base' => NULL, 'refs' => [ 'ExistingObjectReplication$Status' => '

Specifies whether Amazon S3 replicates existing source bucket objects.

', ], ], 'Expiration' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$Expiration' => '

If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL-encoded.

This functionality is not supported for directory buckets.

', 'CopyObjectOutput$Expiration' => '

If the object expiration is configured, the response includes this header.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$Expiration' => '

If the object expiration is configured (see PutBucketLifecycleConfiguration ), 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.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$Expiration' => '

If the object expiration is configured (see PutBucketLifecycleConfiguration ), 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.

This functionality is not supported for directory buckets.

', 'PutObjectOutput$Expiration' => '

If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$Expiration' => '

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 that provide the object expiration information. The value of the rule-id is URL-encoded.

', ], ], 'ExpirationStatus' => [ 'base' => NULL, 'refs' => [ 'LifecycleRule$Status' => '

If \'Enabled\', the rule is currently being applied. If \'Disabled\', the rule is not currently being applied.

', 'Rule$Status' => '

If Enabled, the rule is currently being applied. If Disabled, the rule is not currently being applied.

', ], ], 'ExpiredObjectDeleteMarker' => [ 'base' => NULL, 'refs' => [ 'LifecycleExpiration$ExpiredObjectDeleteMarker' => '

Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', ], ], 'Expires' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$Expires' => '

The date and time at which the object is no longer cacheable.

', 'CreateMultipartUploadRequest$Expires' => '

The date and time at which the object is no longer cacheable.

', 'GetObjectOutput$Expires' => '

The date and time at which the object is no longer cacheable.

', 'HeadObjectOutput$Expires' => '

The date and time at which the object is no longer cacheable.

', 'PutObjectRequest$Expires' => '

The date and time at which the object is no longer cacheable. For more information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3.

', 'WriteGetObjectResponseRequest$Expires' => '

The date and time at which the object is no longer cacheable.

', ], ], 'ExposeHeader' => [ 'base' => NULL, 'refs' => [ 'ExposeHeaders$member' => NULL, ], ], 'ExposeHeaders' => [ 'base' => NULL, 'refs' => [ 'CORSRule$ExposeHeaders' => '

One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

', ], ], 'Expression' => [ 'base' => NULL, 'refs' => [ 'SelectObjectContentRequest$Expression' => '

The expression that is used to query the object.

', 'SelectParameters$Expression' => '

The expression that is used to query the object.

', ], ], 'ExpressionType' => [ 'base' => NULL, 'refs' => [ 'SelectObjectContentRequest$ExpressionType' => '

The type of the provided expression (for example, SQL).

', 'SelectParameters$ExpressionType' => '

The type of the provided expression (for example, SQL).

', ], ], 'FetchOwner' => [ 'base' => NULL, 'refs' => [ 'ListObjectsV2Request$FetchOwner' => '

The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.

', ], ], 'FieldDelimiter' => [ 'base' => NULL, 'refs' => [ 'CSVInput$FieldDelimiter' => '

A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

', 'CSVOutput$FieldDelimiter' => '

The value used to separate individual fields in a record. You can specify an arbitrary delimiter.

', ], ], 'FileHeaderInfo' => [ 'base' => NULL, 'refs' => [ 'CSVInput$FileHeaderInfo' => '

Describes the first line of input. Valid values are:

', ], ], 'FilterRule' => [ 'base' => '

Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as 2023- or engineering/. Then, you can use FilterRule to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.

', 'refs' => [ 'FilterRuleList$member' => NULL, ], ], 'FilterRuleList' => [ 'base' => '

A list of containers for the key-value pair that defines the criteria for the filter rule.

', 'refs' => [ 'S3KeyFilter$FilterRules' => NULL, ], ], 'FilterRuleName' => [ 'base' => NULL, 'refs' => [ 'FilterRule$Name' => '

The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.

', ], ], 'FilterRuleValue' => [ 'base' => NULL, 'refs' => [ 'FilterRule$Value' => '

The value that the filter searches for in object key names.

', ], ], 'GetBucketAccelerateConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAccelerateConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAclOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAclRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAnalyticsConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAnalyticsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketCorsOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketCorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketEncryptionOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketEncryptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketIntelligentTieringConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketIntelligentTieringConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketInventoryConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketInventoryConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLifecycleConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLifecycleConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLifecycleOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLifecycleRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLocationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLocationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLoggingOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLoggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketMetricsConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketMetricsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketNotificationConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketOwnershipControlsOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketOwnershipControlsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketPolicyStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketPolicyStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketReplicationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketReplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketRequestPaymentOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketRequestPaymentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketTaggingOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketTaggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketVersioningOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketVersioningRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketWebsiteOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketWebsiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectAclOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectAclRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectAttributesOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectAttributesParts' => [ 'base' => '

A collection of parts associated with a multipart upload.

', 'refs' => [ 'GetObjectAttributesOutput$ObjectParts' => '

A collection of parts associated with a multipart upload.

', ], ], 'GetObjectAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectLegalHoldOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectLegalHoldRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectLockConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectLockConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectResponseStatusCode' => [ 'base' => NULL, 'refs' => [ 'WriteGetObjectResponseRequest$StatusCode' => '

The integer status code for an HTTP response of a corresponding GetObject request. The following is a list of status codes.

', ], ], 'GetObjectRetentionOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectRetentionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectTaggingOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectTaggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectTorrentOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectTorrentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPublicAccessBlockOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetPublicAccessBlockRequest' => [ 'base' => NULL, 'refs' => [], ], 'GlacierJobParameters' => [ 'base' => '

Container for S3 Glacier job parameters.

', 'refs' => [ 'RestoreRequest$GlacierJobParameters' => '

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

', ], ], 'Grant' => [ 'base' => '

Container for grant information.

', 'refs' => [ 'Grants$member' => NULL, ], ], 'GrantFullControl' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$GrantFullControl' => '

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

', 'CreateBucketRequest$GrantFullControl' => '

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$GrantFullControl' => '

Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

You specify each grantee as a type=value pair, where the type is one of the following:

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

x-amz-grant-read: id="11112222333", id="444455556666"

', 'PutBucketAclRequest$GrantFullControl' => '

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

', 'PutObjectAclRequest$GrantFullControl' => '

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

This functionality is not supported for Amazon S3 on Outposts.

', 'PutObjectRequest$GrantFullControl' => '

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

', ], ], 'GrantRead' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$GrantRead' => '

Allows grantee to read the object data and its metadata.

', 'CreateBucketRequest$GrantRead' => '

Allows grantee to list the objects in the bucket.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$GrantRead' => '

Specify access permissions explicitly to allow grantee to read the object data and its metadata.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

You specify each grantee as a type=value pair, where the type is one of the following:

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

x-amz-grant-read: id="11112222333", id="444455556666"

', 'PutBucketAclRequest$GrantRead' => '

Allows grantee to list the objects in the bucket.

', 'PutObjectAclRequest$GrantRead' => '

Allows grantee to list the objects in the bucket.

This functionality is not supported for Amazon S3 on Outposts.

', 'PutObjectRequest$GrantRead' => '

Allows grantee to read the object data and its metadata.

', ], ], 'GrantReadACP' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$GrantReadACP' => '

Allows grantee to read the object ACL.

', 'CreateBucketRequest$GrantReadACP' => '

Allows grantee to read the bucket ACL.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$GrantReadACP' => '

Specify access permissions explicitly to allows grantee to read the object ACL.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

You specify each grantee as a type=value pair, where the type is one of the following:

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

x-amz-grant-read: id="11112222333", id="444455556666"

', 'PutBucketAclRequest$GrantReadACP' => '

Allows grantee to read the bucket ACL.

', 'PutObjectAclRequest$GrantReadACP' => '

Allows grantee to read the bucket ACL.

This functionality is not supported for Amazon S3 on Outposts.

', 'PutObjectRequest$GrantReadACP' => '

Allows grantee to read the object ACL.

', ], ], 'GrantWrite' => [ 'base' => NULL, 'refs' => [ 'CreateBucketRequest$GrantWrite' => '

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

This functionality is not supported for directory buckets.

', 'PutBucketAclRequest$GrantWrite' => '

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

', 'PutObjectAclRequest$GrantWrite' => '

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

', ], ], 'GrantWriteACP' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$GrantWriteACP' => '

Allows grantee to write the ACL for the applicable object.

', 'CreateBucketRequest$GrantWriteACP' => '

Allows grantee to write the ACL for the applicable bucket.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$GrantWriteACP' => '

Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

You specify each grantee as a type=value pair, where the type is one of the following:

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

x-amz-grant-read: id="11112222333", id="444455556666"

', 'PutBucketAclRequest$GrantWriteACP' => '

Allows grantee to write the ACL for the applicable bucket.

', 'PutObjectAclRequest$GrantWriteACP' => '

Allows grantee to write the ACL for the applicable bucket.

This functionality is not supported for Amazon S3 on Outposts.

', 'PutObjectRequest$GrantWriteACP' => '

Allows grantee to write the ACL for the applicable object.

', ], ], 'Grantee' => [ 'base' => '

Container for the person being granted permissions.

', 'refs' => [ 'Grant$Grantee' => '

The person being granted permissions.

', 'TargetGrant$Grantee' => '

Container for the person being granted permissions.

', ], ], 'Grants' => [ 'base' => NULL, 'refs' => [ 'AccessControlPolicy$Grants' => '

A list of grants.

', 'GetBucketAclOutput$Grants' => '

A list of grants.

', 'GetObjectAclOutput$Grants' => '

A list of grants.

', 'S3Location$AccessControlList' => '

A list of grants that control access to the staged results.

', ], ], 'HeadBucketOutput' => [ 'base' => NULL, 'refs' => [], ], 'HeadBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'HeadObjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'HeadObjectRequest' => [ 'base' => NULL, 'refs' => [], ], 'HostName' => [ 'base' => NULL, 'refs' => [ 'Redirect$HostName' => '

The host name to use in the redirect request.

', 'RedirectAllRequestsTo$HostName' => '

Name of the host where requests are redirected.

', ], ], 'HttpErrorCodeReturnedEquals' => [ 'base' => NULL, 'refs' => [ 'Condition$HttpErrorCodeReturnedEquals' => '

The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.

', ], ], 'HttpRedirectCode' => [ 'base' => NULL, 'refs' => [ 'Redirect$HttpRedirectCode' => '

The HTTP redirect code to use on the response. Not required if one of the siblings is present.

', ], ], 'ID' => [ 'base' => NULL, 'refs' => [ 'CORSRule$ID' => '

Unique identifier for the rule. The value cannot be longer than 255 characters.

', 'Grantee$ID' => '

The canonical user ID of the grantee.

', 'Initiator$ID' => '

If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.

Directory buckets - If the principal is an Amazon Web Services account, it provides the Amazon Web Services account ID. If the principal is an IAM User, it provides a user ARN value.

', 'LifecycleRule$ID' => '

Unique identifier for the rule. The value cannot be longer than 255 characters.

', 'Owner$ID' => '

Container for the ID of the owner.

', 'ReplicationRule$ID' => '

A unique identifier for the rule. The maximum value is 255 characters.

', 'Rule$ID' => '

Unique identifier for the rule. The value can\'t be longer than 255 characters.

', ], ], 'IfMatch' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectRequest$IfMatch' => '

The If-Match header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns a 412 Precondition Failed error. If the ETag matches or if the object doesn\'t exist, the operation will return a 204 Success (No Content) response.

For more information about conditional requests, see RFC 7232.

This functionality is only supported for directory buckets.

', 'GetObjectRequest$IfMatch' => '

Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a 412 Precondition Failed error.

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.

For more information about conditional requests, see RFC 7232.

', 'HeadObjectRequest$IfMatch' => '

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

', ], ], 'IfMatchInitiatedTime' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartUploadRequest$IfMatchInitiatedTime' => '

If present, this header aborts an in progress multipart upload only if it was initiated on the provided timestamp. If the initiated timestamp of the multipart upload does not match the provided value, the operation returns a 412 Precondition Failed error. If the initiated timestamp matches or if the multipart upload doesn’t exist, the operation returns a 204 Success (No Content) response.

This functionality is only supported for directory buckets.

', ], ], 'IfMatchLastModifiedTime' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectRequest$IfMatchLastModifiedTime' => '

If present, the object is deleted only if its modification times matches the provided Timestamp. If the Timestamp values do not match, the operation returns a 412 Precondition Failed error. If the Timestamp matches or if the object doesn’t exist, the operation returns a 204 Success (No Content) response.

This functionality is only supported for directory buckets.

', ], ], 'IfMatchSize' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectRequest$IfMatchSize' => '

If present, the object is deleted only if its size matches the provided size in bytes. If the Size value does not match, the operation returns a 412 Precondition Failed error. If the Size matches or if the object doesn’t exist, the operation returns a 204 Success (No Content) response.

This functionality is only supported for directory buckets.

You can use the If-Match, x-amz-if-match-last-modified-time and x-amz-if-match-size conditional headers in conjunction with each-other or individually.

', ], ], 'IfModifiedSince' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$IfModifiedSince' => '

Return the object only if it has been modified since the specified time; otherwise, return a 304 Not Modified error.

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 status code.

For more information about conditional requests, see RFC 7232.

', 'HeadObjectRequest$IfModifiedSince' => '

Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

', ], ], 'IfNoneMatch' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadRequest$IfNoneMatch' => '

Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should re-initiate the multipart upload with CreateMultipartUpload and re-upload each part.

Expects the \'*\' (asterisk) character.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

', 'GetObjectRequest$IfNoneMatch' => '

Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a 304 Not Modified error.

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 HTTP status code.

For more information about conditional requests, see RFC 7232.

', 'HeadObjectRequest$IfNoneMatch' => '

Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

', 'PutObjectRequest$IfNoneMatch' => '

Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should retry the upload.

Expects the \'*\' (asterisk) character.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

', ], ], 'IfUnmodifiedSince' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$IfUnmodifiedSince' => '

Return the object only if it has not been modified since the specified time; otherwise, return a 412 Precondition Failed error.

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.

For more information about conditional requests, see RFC 7232.

', 'HeadObjectRequest$IfUnmodifiedSince' => '

Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

', ], ], 'IndexDocument' => [ 'base' => '

Container for the Suffix element.

', 'refs' => [ 'GetBucketWebsiteOutput$IndexDocument' => '

The name of the index document for the website (for example index.html).

', 'WebsiteConfiguration$IndexDocument' => '

The name of the index document for the website.

', ], ], 'Initiated' => [ 'base' => NULL, 'refs' => [ 'MultipartUpload$Initiated' => '

Date and time at which the multipart upload was initiated.

', ], ], 'Initiator' => [ 'base' => '

Container element that identifies who initiated the multipart upload.

', 'refs' => [ 'ListPartsOutput$Initiator' => '

Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services 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.

', 'MultipartUpload$Initiator' => '

Identifies who initiated the multipart upload.

', ], ], 'InputSerialization' => [ 'base' => '

Describes the serialization format of the object.

', 'refs' => [ 'SelectObjectContentRequest$InputSerialization' => '

Describes the format of the data in the object that is being queried.

', 'SelectParameters$InputSerialization' => '

Describes the serialization format of the object.

', ], ], 'IntelligentTieringAccessTier' => [ 'base' => NULL, 'refs' => [ 'InvalidObjectState$AccessTier' => NULL, 'Tiering$AccessTier' => '

S3 Intelligent-Tiering access tier. See Storage class for automatically optimizing frequently and infrequently accessed objects for a list of access tiers in the S3 Intelligent-Tiering storage class.

', ], ], 'IntelligentTieringAndOperator' => [ 'base' => '

A container for specifying S3 Intelligent-Tiering filters. The filters determine the subset of objects to which the rule applies.

', 'refs' => [ 'IntelligentTieringFilter$And' => '

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

', ], ], 'IntelligentTieringConfiguration' => [ 'base' => '

Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.

For information about the S3 Intelligent-Tiering storage class, see Storage class for automatically optimizing frequently and infrequently accessed objects.

', 'refs' => [ 'GetBucketIntelligentTieringConfigurationOutput$IntelligentTieringConfiguration' => '

Container for S3 Intelligent-Tiering configuration.

', 'IntelligentTieringConfigurationList$member' => NULL, 'PutBucketIntelligentTieringConfigurationRequest$IntelligentTieringConfiguration' => '

Container for S3 Intelligent-Tiering configuration.

', ], ], 'IntelligentTieringConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListBucketIntelligentTieringConfigurationsOutput$IntelligentTieringConfigurationList' => '

The list of S3 Intelligent-Tiering configurations for a bucket.

', ], ], 'IntelligentTieringDays' => [ 'base' => NULL, 'refs' => [ 'Tiering$Days' => '

The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).

', ], ], 'IntelligentTieringFilter' => [ 'base' => '

The Filter is used to identify objects that the S3 Intelligent-Tiering configuration applies to.

', 'refs' => [ 'IntelligentTieringConfiguration$Filter' => '

Specifies a bucket filter. The configuration only includes objects that meet the filter\'s criteria.

', ], ], 'IntelligentTieringId' => [ 'base' => NULL, 'refs' => [ 'DeleteBucketIntelligentTieringConfigurationRequest$Id' => '

The ID used to identify the S3 Intelligent-Tiering configuration.

', 'GetBucketIntelligentTieringConfigurationRequest$Id' => '

The ID used to identify the S3 Intelligent-Tiering configuration.

', 'IntelligentTieringConfiguration$Id' => '

The ID used to identify the S3 Intelligent-Tiering configuration.

', 'PutBucketIntelligentTieringConfigurationRequest$Id' => '

The ID used to identify the S3 Intelligent-Tiering configuration.

', ], ], 'IntelligentTieringStatus' => [ 'base' => NULL, 'refs' => [ 'IntelligentTieringConfiguration$Status' => '

Specifies the status of the configuration.

', ], ], 'InvalidObjectState' => [ 'base' => '

Object is archived and inaccessible until restored.

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects in the Amazon S3 User Guide.

', 'refs' => [], ], 'InvalidRequest' => [ 'base' => '

You may receive this error in multiple cases. Depending on the reason for the error, you may receive one of the messages below:

', 'refs' => [], ], 'InvalidWriteOffset' => [ 'base' => '

The write offset value that you specified does not match the current object size.

', 'refs' => [], ], 'InventoryConfiguration' => [ 'base' => '

Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.

', 'refs' => [ 'GetBucketInventoryConfigurationOutput$InventoryConfiguration' => '

Specifies the inventory configuration.

', 'InventoryConfigurationList$member' => NULL, 'PutBucketInventoryConfigurationRequest$InventoryConfiguration' => '

Specifies the inventory configuration.

', ], ], 'InventoryConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListBucketInventoryConfigurationsOutput$InventoryConfigurationList' => '

The list of inventory configurations for a bucket.

', ], ], 'InventoryDestination' => [ 'base' => '

Specifies the inventory configuration for an Amazon S3 bucket.

', 'refs' => [ 'InventoryConfiguration$Destination' => '

Contains information about where to publish the inventory results.

', ], ], 'InventoryEncryption' => [ 'base' => '

Contains the type of server-side encryption used to encrypt the inventory results.

', 'refs' => [ 'InventoryS3BucketDestination$Encryption' => '

Contains the type of server-side encryption used to encrypt the inventory results.

', ], ], 'InventoryFilter' => [ 'base' => '

Specifies an inventory filter. The inventory only includes objects that meet the filter\'s criteria.

', 'refs' => [ 'InventoryConfiguration$Filter' => '

Specifies an inventory filter. The inventory only includes objects that meet the filter\'s criteria.

', ], ], 'InventoryFormat' => [ 'base' => NULL, 'refs' => [ 'InventoryS3BucketDestination$Format' => '

Specifies the output format of the inventory results.

', ], ], 'InventoryFrequency' => [ 'base' => NULL, 'refs' => [ 'InventorySchedule$Frequency' => '

Specifies how frequently inventory results are produced.

', ], ], 'InventoryId' => [ 'base' => NULL, 'refs' => [ 'DeleteBucketInventoryConfigurationRequest$Id' => '

The ID used to identify the inventory configuration.

', 'GetBucketInventoryConfigurationRequest$Id' => '

The ID used to identify the inventory configuration.

', 'InventoryConfiguration$Id' => '

The ID used to identify the inventory configuration.

', 'PutBucketInventoryConfigurationRequest$Id' => '

The ID used to identify the inventory configuration.

', ], ], 'InventoryIncludedObjectVersions' => [ 'base' => NULL, 'refs' => [ 'InventoryConfiguration$IncludedObjectVersions' => '

Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

', ], ], 'InventoryOptionalField' => [ 'base' => NULL, 'refs' => [ 'InventoryOptionalFields$member' => NULL, ], ], 'InventoryOptionalFields' => [ 'base' => NULL, 'refs' => [ 'InventoryConfiguration$OptionalFields' => '

Contains the optional fields that are included in the inventory results.

', ], ], 'InventoryS3BucketDestination' => [ 'base' => '

Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

', 'refs' => [ 'InventoryDestination$S3BucketDestination' => '

Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

', ], ], 'InventorySchedule' => [ 'base' => '

Specifies the schedule for generating inventory results.

', 'refs' => [ 'InventoryConfiguration$Schedule' => '

Specifies the schedule for generating inventory results.

', ], ], 'IsEnabled' => [ 'base' => NULL, 'refs' => [ 'InventoryConfiguration$IsEnabled' => '

Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

', ], ], 'IsLatest' => [ 'base' => NULL, 'refs' => [ 'DeleteMarkerEntry$IsLatest' => '

Specifies whether the object is (true) or is not (false) the latest version of an object.

', 'ObjectVersion$IsLatest' => '

Specifies whether the object is (true) or is not (false) the latest version of an object.

', ], ], 'IsPublic' => [ 'base' => NULL, 'refs' => [ 'PolicyStatus$IsPublic' => '

The policy status for this bucket. TRUE indicates that this bucket is public. FALSE indicates that the bucket is not public.

', ], ], 'IsRestoreInProgress' => [ 'base' => NULL, 'refs' => [ 'RestoreStatus$IsRestoreInProgress' => '

Specifies whether the object is currently being restored. If the object restoration is in progress, the header returns the value TRUE. For example:

x-amz-optional-object-attributes: IsRestoreInProgress="true"

If the object restoration has completed, the header returns the value FALSE. For example:

x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

If the object hasn\'t been restored, there is no header response.

', ], ], 'IsTruncated' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesParts$IsTruncated' => '

Indicates whether the returned list of parts is truncated. A value of true indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

', 'ListBucketAnalyticsConfigurationsOutput$IsTruncated' => '

Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

', 'ListBucketIntelligentTieringConfigurationsOutput$IsTruncated' => '

Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

', 'ListBucketInventoryConfigurationsOutput$IsTruncated' => '

Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.

', 'ListBucketMetricsConfigurationsOutput$IsTruncated' => '

Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

', 'ListMultipartUploadsOutput$IsTruncated' => '

Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

', 'ListObjectVersionsOutput$IsTruncated' => '

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 by using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

', 'ListObjectsOutput$IsTruncated' => '

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.

', 'ListObjectsV2Output$IsTruncated' => '

Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

', 'ListPartsOutput$IsTruncated' => '

Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

', ], ], 'JSONInput' => [ 'base' => '

Specifies JSON as object\'s input serialization format.

', 'refs' => [ 'InputSerialization$JSON' => '

Specifies JSON as object\'s input serialization format.

', ], ], 'JSONOutput' => [ 'base' => '

Specifies JSON as request\'s output serialization format.

', 'refs' => [ 'OutputSerialization$JSON' => '

Specifies JSON as request\'s output serialization format.

', ], ], 'JSONType' => [ 'base' => NULL, 'refs' => [ 'JSONInput$Type' => '

The type of JSON. Valid values: Document, Lines.

', ], ], 'KMSContext' => [ 'base' => NULL, 'refs' => [ 'Encryption$KMSContext' => '

If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

', ], ], 'KeyCount' => [ 'base' => NULL, 'refs' => [ 'ListObjectsV2Output$KeyCount' => '

KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.

', ], ], 'KeyMarker' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$KeyMarker' => '

The key at or after which the listing began.

', 'ListMultipartUploadsRequest$KeyMarker' => '

Specifies the multipart upload after which listing should begin.

', 'ListObjectVersionsOutput$KeyMarker' => '

Marks the last key returned in a truncated response.

', 'ListObjectVersionsRequest$KeyMarker' => '

Specifies the key to start with when listing objects in a bucket.

', ], ], 'KeyPrefixEquals' => [ 'base' => NULL, 'refs' => [ 'Condition$KeyPrefixEquals' => '

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.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', ], ], 'LambdaFunctionArn' => [ 'base' => NULL, 'refs' => [ 'LambdaFunctionConfiguration$LambdaFunctionArn' => '

The Amazon Resource Name (ARN) of the Lambda function that Amazon S3 invokes when the specified event type occurs.

', ], ], 'LambdaFunctionConfiguration' => [ 'base' => '

A container for specifying the configuration for Lambda notifications.

', 'refs' => [ 'LambdaFunctionConfigurationList$member' => NULL, ], ], 'LambdaFunctionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'NotificationConfiguration$LambdaFunctionConfigurations' => '

Describes the Lambda functions to invoke and the events for which to invoke them.

', ], ], 'LastModified' => [ 'base' => NULL, 'refs' => [ 'CopyObjectResult$LastModified' => '

Creation date of the object.

', 'CopyPartResult$LastModified' => '

Date and time at which the object was uploaded.

', 'DeleteMarkerEntry$LastModified' => '

Date and time when the object was last modified.

', 'GetObjectAttributesOutput$LastModified' => '

Date and time when the object was last modified.

', 'GetObjectOutput$LastModified' => '

Date and time when the object was last modified.

General purpose buckets - When you specify a versionId of the object in your request, if the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

', 'HeadObjectOutput$LastModified' => '

Date and time when the object was last modified.

', 'Object$LastModified' => '

Creation date of the object.

', 'ObjectVersion$LastModified' => '

Date and time when the object was last modified.

', 'Part$LastModified' => '

Date and time at which the part was uploaded.

', 'WriteGetObjectResponseRequest$LastModified' => '

The date and time that the object was last modified.

', ], ], 'LastModifiedTime' => [ 'base' => NULL, 'refs' => [ 'ObjectIdentifier$LastModifiedTime' => '

If present, the objects are deleted only if its modification times matches the provided Timestamp.

This functionality is only supported for directory buckets.

', ], ], 'LifecycleConfiguration' => [ 'base' => '

Container for lifecycle rules. You can add as many as 1000 rules.

For more information see, Managing your storage lifecycle in the Amazon S3 User Guide.

', 'refs' => [ 'PutBucketLifecycleRequest$LifecycleConfiguration' => '

', ], ], 'LifecycleExpiration' => [ 'base' => '

Container for the expiration for the lifecycle of the object.

For more information see, Managing your storage lifecycle in the Amazon S3 User Guide.

', 'refs' => [ 'LifecycleRule$Expiration' => '

Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

', 'Rule$Expiration' => '

Specifies the expiration for the lifecycle of the object.

', ], ], 'LifecycleRule' => [ 'base' => '

A lifecycle rule for individual objects in an Amazon S3 bucket.

For more information see, Managing your storage lifecycle in the Amazon S3 User Guide.

', 'refs' => [ 'LifecycleRules$member' => NULL, ], ], 'LifecycleRuleAndOperator' => [ 'base' => '

This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.

', 'refs' => [ 'LifecycleRuleFilter$And' => NULL, ], ], 'LifecycleRuleFilter' => [ 'base' => '

The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter can have exactly one of Prefix, Tag, ObjectSizeGreaterThan, ObjectSizeLessThan, or And specified. If the Filter element is left empty, the Lifecycle Rule applies to all objects in the bucket.

', 'refs' => [ 'LifecycleRule$Filter' => '

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. Filter is required if the LifecycleRule does not contain a Prefix element.

Tag filters are not supported for directory buckets.

', ], ], 'LifecycleRules' => [ 'base' => NULL, 'refs' => [ 'BucketLifecycleConfiguration$Rules' => '

A lifecycle rule for individual objects in an Amazon S3 bucket.

', 'GetBucketLifecycleConfigurationOutput$Rules' => '

Container for a lifecycle rule.

', ], ], 'ListBucketAnalyticsConfigurationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketAnalyticsConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketIntelligentTieringConfigurationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketIntelligentTieringConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketInventoryConfigurationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketInventoryConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketMetricsConfigurationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketMetricsConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDirectoryBucketsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListDirectoryBucketsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMultipartUploadsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListMultipartUploadsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListObjectVersionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListObjectVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListObjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListObjectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListObjectsV2Output' => [ 'base' => NULL, 'refs' => [], ], 'ListObjectsV2Request' => [ 'base' => NULL, 'refs' => [], ], 'ListPartsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPartsRequest' => [ 'base' => NULL, 'refs' => [], ], 'Location' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$Location' => '

The URI that identifies the newly created object.

', 'CreateBucketOutput$Location' => '

A forward slash followed by the name of the bucket.

', ], ], 'LocationInfo' => [ 'base' => '

Specifies the location where the bucket will be created.

For directory buckets, the location type is Availability Zone. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

This functionality is only supported by directory buckets.

', 'refs' => [ 'CreateBucketConfiguration$Location' => '

Specifies the location where the bucket will be created.

For directory buckets, the location type is Availability Zone.

This functionality is only supported by directory buckets.

', ], ], 'LocationNameAsString' => [ 'base' => NULL, 'refs' => [ 'LocationInfo$Name' => '

The name of the location where the bucket will be created.

For directory buckets, the name of the location is the AZ ID of the Availability Zone where the bucket will be created. An example AZ ID value is usw2-az1.

', ], ], 'LocationPrefix' => [ 'base' => NULL, 'refs' => [ 'S3Location$Prefix' => '

The prefix that is prepended to the restore results for this request.

', ], ], 'LocationType' => [ 'base' => NULL, 'refs' => [ 'HeadBucketOutput$BucketLocationType' => '

The type of location where the bucket is created.

This functionality is only supported by directory buckets.

', 'LocationInfo$Type' => '

The type of location where the bucket will be created.

', ], ], 'LoggingEnabled' => [ 'base' => '

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon S3 API Reference.

', 'refs' => [ 'BucketLoggingStatus$LoggingEnabled' => NULL, 'GetBucketLoggingOutput$LoggingEnabled' => NULL, ], ], 'MFA' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectRequest$MFA' => '

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.

This functionality is not supported for directory buckets.

', 'DeleteObjectsRequest$MFA' => '

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.

When performing the DeleteObjects operation on an MFA delete enabled bucket, which attempts to delete the specified versioned objects, you must include an MFA token. If you don\'t provide an MFA token, the entire request will fail, even if there are non-versioned objects that you are trying to delete. If you provide an invalid token, whether there are versioned object keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'PutBucketVersioningRequest$MFA' => '

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

', ], ], 'MFADelete' => [ 'base' => NULL, 'refs' => [ 'VersioningConfiguration$MFADelete' => '

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

', ], ], 'MFADeleteStatus' => [ 'base' => NULL, 'refs' => [ 'GetBucketVersioningOutput$MFADelete' => '

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

', ], ], 'Marker' => [ 'base' => NULL, 'refs' => [ 'ListObjectsOutput$Marker' => '

Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.

', 'ListObjectsRequest$Marker' => '

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

', ], ], 'MaxAgeSeconds' => [ 'base' => NULL, 'refs' => [ 'CORSRule$MaxAgeSeconds' => '

The time in seconds that your browser is to cache the preflight response for the specified resource.

', ], ], 'MaxBuckets' => [ 'base' => NULL, 'refs' => [ 'ListBucketsRequest$MaxBuckets' => '

Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.

', ], ], 'MaxDirectoryBuckets' => [ 'base' => NULL, 'refs' => [ 'ListDirectoryBucketsRequest$MaxDirectoryBuckets' => '

Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.

', ], ], 'MaxKeys' => [ 'base' => NULL, 'refs' => [ 'ListObjectVersionsOutput$MaxKeys' => '

Specifies the maximum number of objects to return.

', 'ListObjectVersionsRequest$MaxKeys' => '

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

', 'ListObjectsOutput$MaxKeys' => '

The maximum number of keys returned in the response body.

', 'ListObjectsRequest$MaxKeys' => '

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

', 'ListObjectsV2Output$MaxKeys' => '

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

', 'ListObjectsV2Request$MaxKeys' => '

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

', ], ], 'MaxParts' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesParts$MaxParts' => '

The maximum number of parts allowed in the response.

', 'GetObjectAttributesRequest$MaxParts' => '

Sets the maximum number of parts to return.

', 'ListPartsOutput$MaxParts' => '

Maximum number of parts that were allowed in the response.

', 'ListPartsRequest$MaxParts' => '

Sets the maximum number of parts to return.

', ], ], 'MaxUploads' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$MaxUploads' => '

Maximum number of multipart uploads that could have been included in the response.

', 'ListMultipartUploadsRequest$MaxUploads' => '

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'Error$Message' => '

The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don\'t know how or don\'t care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.

', ], ], 'Metadata' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$Metadata' => '

A map of metadata to store with the object in S3.

', 'CreateMultipartUploadRequest$Metadata' => '

A map of metadata to store with the object in S3.

', 'GetObjectOutput$Metadata' => '

A map of metadata to store with the object in S3.

', 'HeadObjectOutput$Metadata' => '

A map of metadata to store with the object in S3.

', 'PutObjectRequest$Metadata' => '

A map of metadata to store with the object in S3.

', 'WriteGetObjectResponseRequest$Metadata' => '

A map of metadata to store with the object in S3.

', ], ], 'MetadataDirective' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$MetadataDirective' => '

Specifies whether the metadata is copied from the source object or replaced with metadata that\'s provided in the request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If this header isn’t specified, COPY is the default behavior.

General purpose bucket - For general purpose buckets, when you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Amazon S3 condition key examples in the Amazon S3 User Guide.

x-amz-website-redirect-location is unique to each object and is not copied when using the x-amz-metadata-directive header. To copy the value, you must specify x-amz-website-redirect-location in the request header.

', ], ], 'MetadataEntry' => [ 'base' => '

A metadata key-value pair to store with an object.

', 'refs' => [ 'UserMetadata$member' => NULL, ], ], 'MetadataKey' => [ 'base' => NULL, 'refs' => [ 'Metadata$key' => NULL, 'MetadataEntry$Name' => '

Name of the object.

', ], ], 'MetadataValue' => [ 'base' => NULL, 'refs' => [ 'Metadata$value' => NULL, 'MetadataEntry$Value' => '

Value of the object.

', ], ], 'Metrics' => [ 'base' => '

A container specifying replication metrics-related settings enabling replication metrics and events.

', 'refs' => [ 'Destination$Metrics' => '

A container specifying replication metrics-related settings enabling replication metrics and events.

', ], ], 'MetricsAndOperator' => [ 'base' => '

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

', 'refs' => [ 'MetricsFilter$And' => '

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

', ], ], 'MetricsConfiguration' => [ 'base' => '

Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you\'re updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don\'t include the elements you want to keep, they are erased. For more information, see PutBucketMetricsConfiguration.

', 'refs' => [ 'GetBucketMetricsConfigurationOutput$MetricsConfiguration' => '

Specifies the metrics configuration.

', 'MetricsConfigurationList$member' => NULL, 'PutBucketMetricsConfigurationRequest$MetricsConfiguration' => '

Specifies the metrics configuration.

', ], ], 'MetricsConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListBucketMetricsConfigurationsOutput$MetricsConfigurationList' => '

The list of metrics configurations for a bucket.

', ], ], 'MetricsFilter' => [ 'base' => '

Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter\'s criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more information, see PutBucketMetricsConfiguration.

', 'refs' => [ 'MetricsConfiguration$Filter' => '

Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter\'s criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).

', ], ], 'MetricsId' => [ 'base' => NULL, 'refs' => [ 'DeleteBucketMetricsConfigurationRequest$Id' => '

The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

', 'GetBucketMetricsConfigurationRequest$Id' => '

The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

', 'MetricsConfiguration$Id' => '

The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

', 'PutBucketMetricsConfigurationRequest$Id' => '

The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

', ], ], 'MetricsStatus' => [ 'base' => NULL, 'refs' => [ 'Metrics$Status' => '

Specifies whether the replication metrics are enabled.

', ], ], 'Minutes' => [ 'base' => NULL, 'refs' => [ 'ReplicationTimeValue$Minutes' => '

Contains an integer specifying time in minutes.

Valid value: 15

', ], ], 'MissingMeta' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$MissingMeta' => '

This is set to the number of metadata entries not returned in the headers that are prefixed with x-amz-meta-. 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.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$MissingMeta' => '

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.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$MissingMeta' => '

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.

', ], ], 'MultipartUpload' => [ 'base' => '

Container for the MultipartUpload for the Amazon S3 object.

', 'refs' => [ 'MultipartUploadList$member' => NULL, ], ], 'MultipartUploadId' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartUploadRequest$UploadId' => '

Upload ID that identifies the multipart upload.

', 'CompleteMultipartUploadRequest$UploadId' => '

ID for the initiated multipart upload.

', 'CreateMultipartUploadOutput$UploadId' => '

ID for the initiated multipart upload.

', 'ListPartsOutput$UploadId' => '

Upload ID identifying the multipart upload whose parts are being listed.

', 'ListPartsRequest$UploadId' => '

Upload ID identifying the multipart upload whose parts are being listed.

', 'MultipartUpload$UploadId' => '

Upload ID that identifies the multipart upload.

', 'UploadPartCopyRequest$UploadId' => '

Upload ID identifying the multipart upload whose part is being copied.

', 'UploadPartRequest$UploadId' => '

Upload ID identifying the multipart upload whose part is being uploaded.

', ], ], 'MultipartUploadList' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$Uploads' => '

Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

', ], ], 'NextKeyMarker' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$NextKeyMarker' => '

When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

', 'ListObjectVersionsOutput$NextKeyMarker' => '

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.

', ], ], 'NextMarker' => [ 'base' => NULL, 'refs' => [ 'ListObjectsOutput$NextMarker' => '

When the response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as the marker parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.

This element is returned only if you have the delimiter request parameter specified. If the response does not include the NextMarker element and it is truncated, you can use the value of the last Key element in the response as the marker parameter in the subsequent request to get the next set of object keys.

', ], ], 'NextPartNumberMarker' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesParts$NextPartNumberMarker' => '

When a list is truncated, this element specifies the last part in the list, as well as the value to use for the PartNumberMarker request parameter in a subsequent request.

', 'ListPartsOutput$NextPartNumberMarker' => '

When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListBucketAnalyticsConfigurationsOutput$NextContinuationToken' => '

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.

', 'ListBucketIntelligentTieringConfigurationsOutput$NextContinuationToken' => '

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.

', 'ListBucketInventoryConfigurationsOutput$NextContinuationToken' => '

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.

', 'ListBucketMetricsConfigurationsOutput$NextContinuationToken' => '

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.

', 'ListBucketsOutput$ContinuationToken' => '

ContinuationToken is included in the response when there are more buckets that can be listed with pagination. The next ListBuckets request to Amazon S3 can be continued with this ContinuationToken. ContinuationToken is obfuscated and is not a real bucket.

', 'ListObjectsV2Output$NextContinuationToken' => '

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

', ], ], 'NextUploadIdMarker' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$NextUploadIdMarker' => '

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.

This functionality is not supported for directory buckets.

', ], ], 'NextVersionIdMarker' => [ 'base' => NULL, 'refs' => [ 'ListObjectVersionsOutput$NextVersionIdMarker' => '

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.

', ], ], 'NoSuchBucket' => [ 'base' => '

The specified bucket does not exist.

', 'refs' => [], ], 'NoSuchKey' => [ 'base' => '

The specified key does not exist.

', 'refs' => [], ], 'NoSuchUpload' => [ 'base' => '

The specified multipart upload does not exist.

', 'refs' => [], ], 'NoncurrentVersionExpiration' => [ 'base' => '

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.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'refs' => [ 'LifecycleRule$NoncurrentVersionExpiration' => NULL, 'Rule$NoncurrentVersionExpiration' => NULL, ], ], 'NoncurrentVersionTransition' => [ 'base' => '

Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object\'s lifetime.

', 'refs' => [ 'NoncurrentVersionTransitionList$member' => NULL, 'Rule$NoncurrentVersionTransition' => NULL, ], ], 'NoncurrentVersionTransitionList' => [ 'base' => NULL, 'refs' => [ 'LifecycleRule$NoncurrentVersionTransitions' => '

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.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', ], ], 'NotificationConfiguration' => [ 'base' => '

A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

', 'refs' => [ 'PutBucketNotificationConfigurationRequest$NotificationConfiguration' => NULL, ], ], 'NotificationConfigurationDeprecated' => [ 'base' => NULL, 'refs' => [ 'PutBucketNotificationRequest$NotificationConfiguration' => '

The container for the configuration.

', ], ], 'NotificationConfigurationFilter' => [ 'base' => '

Specifies object key name filtering rules. For information about key name filtering, see Configuring event notifications using object key name filtering in the Amazon S3 User Guide.

', 'refs' => [ 'LambdaFunctionConfiguration$Filter' => NULL, 'QueueConfiguration$Filter' => NULL, 'TopicConfiguration$Filter' => NULL, ], ], 'NotificationId' => [ 'base' => '

An optional unique identifier for configurations in a notification configuration. If you don\'t provide one, Amazon S3 will assign an ID.

', 'refs' => [ 'CloudFunctionConfiguration$Id' => NULL, 'LambdaFunctionConfiguration$Id' => NULL, 'QueueConfiguration$Id' => NULL, 'QueueConfigurationDeprecated$Id' => NULL, 'TopicConfiguration$Id' => NULL, 'TopicConfigurationDeprecated$Id' => NULL, ], ], 'Object' => [ 'base' => '

An object consists of data and its descriptive metadata.

', 'refs' => [ 'ObjectList$member' => NULL, ], ], 'ObjectAlreadyInActiveTierError' => [ 'base' => '

This action is not allowed against this storage tier.

', 'refs' => [], ], 'ObjectAttributes' => [ 'base' => NULL, 'refs' => [ 'ObjectAttributesList$member' => NULL, ], ], 'ObjectAttributesList' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesRequest$ObjectAttributes' => '

Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

', ], ], 'ObjectCannedACL' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ACL' => '

The canned access control list (ACL) to apply to the object.

When you copy an object, the ACL metadata is not preserved and is set to private by default. Only the owner has full access control. To override the default ACL setting, specify a new ACL when you generate a copy request. For more information, see Using ACLs.

If the destination bucket that you\'re copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don\'t specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.

', 'CreateMultipartUploadRequest$ACL' => '

The canned ACL to apply to the object. 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 in the Amazon S3 User Guide.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can grant access permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the new object. For more information, see Using ACLs. One way to grant the permissions using the request headers is to specify a canned ACL with the x-amz-acl request header.

', 'PutObjectAclRequest$ACL' => '

The canned ACL to apply to the object. For more information, see Canned ACL.

', 'PutObjectRequest$ACL' => '

The canned ACL to apply to the object. For more information, see Canned ACL in the Amazon S3 User Guide.

When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API in the Amazon S3 User Guide.

If the bucket that you\'re uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don\'t specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a 400 error with the error code AccessControlListNotSupported. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.

', 'S3Location$CannedACL' => '

The canned ACL to apply to the restore results.

', ], ], 'ObjectIdentifier' => [ 'base' => '

Object Identifier is unique value to identify objects.

', 'refs' => [ 'ObjectIdentifierList$member' => NULL, ], ], 'ObjectIdentifierList' => [ 'base' => NULL, 'refs' => [ 'Delete$Objects' => '

The object to delete.

Directory buckets - For directory buckets, an object that\'s composed entirely of whitespace characters is not supported by the DeleteObjects API operation. The request will receive a 400 Bad Request error and none of the objects in the request will be deleted.

', ], ], 'ObjectKey' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartUploadRequest$Key' => '

Key of the object for which the multipart upload was initiated.

', 'CompleteMultipartUploadOutput$Key' => '

The object key of the newly created object.

', 'CompleteMultipartUploadRequest$Key' => '

Object key for which the multipart upload was initiated.

', 'CopyObjectRequest$Key' => '

The key of the destination object.

', 'CreateMultipartUploadOutput$Key' => '

Object key for which the multipart upload was initiated.

', 'CreateMultipartUploadRequest$Key' => '

Object key for which the multipart upload is to be initiated.

', 'DeleteMarkerEntry$Key' => '

The object key.

', 'DeleteObjectRequest$Key' => '

Key name of the object to delete.

', 'DeleteObjectTaggingRequest$Key' => '

The key that identifies the object in the bucket from which to remove all tags.

', 'DeletedObject$Key' => '

The name of the deleted object.

', 'Error$Key' => '

The error key.

', 'ErrorDocument$Key' => '

The object key name to use when a 4XX class error occurs.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'GetObjectAclRequest$Key' => '

The key of the object for which to get the ACL information.

', 'GetObjectAttributesRequest$Key' => '

The object key.

', 'GetObjectLegalHoldRequest$Key' => '

The key name for the object whose legal hold status you want to retrieve.

', 'GetObjectRequest$Key' => '

Key of the object to get.

', 'GetObjectRetentionRequest$Key' => '

The key name for the object whose retention settings you want to retrieve.

', 'GetObjectTaggingRequest$Key' => '

Object key for which to get the tagging information.

', 'GetObjectTorrentRequest$Key' => '

The object key for which to get the information.

', 'HeadObjectRequest$Key' => '

The object key.

', 'ListPartsOutput$Key' => '

Object key for which the multipart upload was initiated.

', 'ListPartsRequest$Key' => '

Object key for which the multipart upload was initiated.

', 'MultipartUpload$Key' => '

Key of the object for which the multipart upload was initiated.

', 'Object$Key' => '

The name that you assign to an object. You use the object key to retrieve the object.

', 'ObjectIdentifier$Key' => '

Key name of the object.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'ObjectVersion$Key' => '

The object key.

', 'PutObjectAclRequest$Key' => '

Key for which the PUT action was initiated.

', 'PutObjectLegalHoldRequest$Key' => '

The key name for the object that you want to place a legal hold on.

', 'PutObjectRequest$Key' => '

Object key for which the PUT action was initiated.

', 'PutObjectRetentionRequest$Key' => '

The key name for the object that you want to apply this Object Retention configuration to.

', 'PutObjectTaggingRequest$Key' => '

Name of the object key.

', 'RestoreObjectRequest$Key' => '

Object key for which the action was initiated.

', 'SelectObjectContentRequest$Key' => '

The object key.

', 'Tag$Key' => '

Name of the object key.

', 'UploadPartCopyRequest$Key' => '

Object key for which the multipart upload was initiated.

', 'UploadPartRequest$Key' => '

Object key for which the multipart upload was initiated.

', ], ], 'ObjectList' => [ 'base' => NULL, 'refs' => [ 'ListObjectsOutput$Contents' => '

Metadata about each object returned.

', 'ListObjectsV2Output$Contents' => '

Metadata about each object returned.

', ], ], 'ObjectLockConfiguration' => [ 'base' => '

The container element for Object Lock configuration parameters.

', 'refs' => [ 'GetObjectLockConfigurationOutput$ObjectLockConfiguration' => '

The specified bucket\'s Object Lock configuration.

', 'PutObjectLockConfigurationRequest$ObjectLockConfiguration' => '

The Object Lock configuration that you want to apply to the specified bucket.

', ], ], 'ObjectLockEnabled' => [ 'base' => NULL, 'refs' => [ 'ObjectLockConfiguration$ObjectLockEnabled' => '

Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

', ], ], 'ObjectLockEnabledForBucket' => [ 'base' => NULL, 'refs' => [ 'CreateBucketRequest$ObjectLockEnabledForBucket' => '

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

This functionality is not supported for directory buckets.

', ], ], 'ObjectLockLegalHold' => [ 'base' => '

A legal hold configuration for an object.

', 'refs' => [ 'GetObjectLegalHoldOutput$LegalHold' => '

The current legal hold status for the specified object.

', 'PutObjectLegalHoldRequest$LegalHold' => '

Container element for the legal hold configuration you want to apply to the specified object.

', ], ], 'ObjectLockLegalHoldStatus' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ObjectLockLegalHoldStatus' => '

Specifies whether you want to apply a legal hold to the object copy.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$ObjectLockLegalHoldStatus' => '

Specifies whether you want to apply a legal hold to the uploaded object.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$ObjectLockLegalHoldStatus' => '

Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object\'s legal hold status.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$ObjectLockLegalHoldStatus' => '

Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

This functionality is not supported for directory buckets.

', 'ObjectLockLegalHold$Status' => '

Indicates whether the specified object has a legal hold in place.

', 'PutObjectRequest$ObjectLockLegalHoldStatus' => '

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$ObjectLockLegalHoldStatus' => '

Indicates whether an object stored in Amazon S3 has an active legal hold.

', ], ], 'ObjectLockMode' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ObjectLockMode' => '

The Object Lock mode that you want to apply to the object copy.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$ObjectLockMode' => '

Specifies the Object Lock mode that you want to apply to the uploaded object.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$ObjectLockMode' => '

The Object Lock mode that\'s currently in place for this object.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$ObjectLockMode' => '

The Object Lock mode, if any, that\'s in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$ObjectLockMode' => '

The Object Lock mode that you want to apply to this object.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$ObjectLockMode' => '

Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.

', ], ], 'ObjectLockRetainUntilDate' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ObjectLockRetainUntilDate' => '

The date and time when you want the Object Lock of the object copy to expire.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$ObjectLockRetainUntilDate' => '

Specifies the date and time when you want the Object Lock to expire.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$ObjectLockRetainUntilDate' => '

The date and time when this object\'s Object Lock will expire.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$ObjectLockRetainUntilDate' => '

The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$ObjectLockRetainUntilDate' => '

The date and time when you want this object\'s Object Lock to expire. Must be formatted as a timestamp parameter.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$ObjectLockRetainUntilDate' => '

The date and time when Object Lock is configured to expire.

', ], ], 'ObjectLockRetention' => [ 'base' => '

A Retention configuration for an object.

', 'refs' => [ 'GetObjectRetentionOutput$Retention' => '

The container element for an object\'s retention settings.

', 'PutObjectRetentionRequest$Retention' => '

The container element for the Object Retention configuration.

', ], ], 'ObjectLockRetentionMode' => [ 'base' => NULL, 'refs' => [ 'DefaultRetention$Mode' => '

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years.

', 'ObjectLockRetention$Mode' => '

Indicates the Retention mode for the specified object.

', ], ], 'ObjectLockRule' => [ 'base' => '

The container element for an Object Lock rule.

', 'refs' => [ 'ObjectLockConfiguration$Rule' => '

Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

', ], ], 'ObjectLockToken' => [ 'base' => NULL, 'refs' => [ 'PutBucketReplicationRequest$Token' => '

A token to allow Object Lock to be enabled for an existing bucket.

', 'PutObjectLockConfigurationRequest$Token' => '

A token to allow Object Lock to be enabled for an existing bucket.

', ], ], 'ObjectNotInActiveTierError' => [ 'base' => '

The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.

', 'refs' => [], ], 'ObjectOwnership' => [ 'base' => '

The container element for object ownership for a bucket\'s ownership controls.

BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL.

ObjectWriter - The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL.

BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don\'t specify an ACL or specify bucket owner full control ACLs (such as the predefined bucket-owner-full-control canned ACL or a custom ACL in XML format that grants the same permissions).

By default, ObjectOwnership is set to BucketOwnerEnforced and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.

This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.

', 'refs' => [ 'CreateBucketRequest$ObjectOwnership' => NULL, 'OwnershipControlsRule$ObjectOwnership' => NULL, ], ], 'ObjectPart' => [ 'base' => '

A container for elements related to an individual part.

', 'refs' => [ 'PartsList$member' => NULL, ], ], 'ObjectSize' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesOutput$ObjectSize' => '

The size of the object in bytes.

', ], ], 'ObjectSizeGreaterThanBytes' => [ 'base' => NULL, 'refs' => [ 'LifecycleRuleAndOperator$ObjectSizeGreaterThan' => '

Minimum object size to which the rule applies.

', 'LifecycleRuleFilter$ObjectSizeGreaterThan' => '

Minimum object size to which the rule applies.

', ], ], 'ObjectSizeLessThanBytes' => [ 'base' => NULL, 'refs' => [ 'LifecycleRuleAndOperator$ObjectSizeLessThan' => '

Maximum object size to which the rule applies.

', 'LifecycleRuleFilter$ObjectSizeLessThan' => '

Maximum object size to which the rule applies.

', ], ], 'ObjectStorageClass' => [ 'base' => NULL, 'refs' => [ 'Object$StorageClass' => '

The class of storage used to store the object.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', ], ], 'ObjectVersion' => [ 'base' => '

The version of an object.

', 'refs' => [ 'ObjectVersionList$member' => NULL, ], ], 'ObjectVersionId' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$VersionId' => '

Version ID of the newly created object, in case the bucket has versioning turned on.

This functionality is not supported for directory buckets.

', 'CopyObjectOutput$VersionId' => '

Version ID of the newly created copy.

This functionality is not supported for directory buckets.

', 'DeleteMarkerEntry$VersionId' => '

Version ID of an object.

', 'DeleteObjectOutput$VersionId' => '

Returns the version ID of the delete marker created as a result of the DELETE operation.

This functionality is not supported for directory buckets.

', 'DeleteObjectRequest$VersionId' => '

Version ID used to reference a specific version of the object.

For directory buckets in this API operation, only the null value of the version ID is supported.

', 'DeleteObjectTaggingOutput$VersionId' => '

The versionId of the object the tag-set was removed from.

', 'DeleteObjectTaggingRequest$VersionId' => '

The versionId of the object that the tag-set will be removed from.

', 'DeletedObject$VersionId' => '

The version ID of the deleted object.

This functionality is not supported for directory buckets.

', 'Error$VersionId' => '

The version ID of the error.

This functionality is not supported for directory buckets.

', 'GetObjectAclRequest$VersionId' => '

Version ID used to reference a specific version of the object.

This functionality is not supported for directory buckets.

', 'GetObjectAttributesOutput$VersionId' => '

The version ID of the object.

This functionality is not supported for directory buckets.

', 'GetObjectAttributesRequest$VersionId' => '

The version ID used to reference a specific version of the object.

S3 Versioning isn\'t enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

', 'GetObjectLegalHoldRequest$VersionId' => '

The version ID of the object whose legal hold status you want to retrieve.

', 'GetObjectOutput$VersionId' => '

Version ID of the object.

This functionality is not supported for directory buckets.

', 'GetObjectRequest$VersionId' => '

Version ID used to reference a specific version of the object.

By default, the GetObject operation returns the current version of an object. To return a different version, use the versionId subresource.

For more information about versioning, see PutBucketVersioning.

', 'GetObjectRetentionRequest$VersionId' => '

The version ID for the object whose retention settings you want to retrieve.

', 'GetObjectTaggingOutput$VersionId' => '

The versionId of the object for which you got the tagging information.

', 'GetObjectTaggingRequest$VersionId' => '

The versionId of the object for which to get the tagging information.

', 'HeadObjectOutput$VersionId' => '

Version ID of the object.

This functionality is not supported for directory buckets.

', 'HeadObjectRequest$VersionId' => '

Version ID used to reference a specific version of the object.

For directory buckets in this API operation, only the null value of the version ID is supported.

', 'ObjectIdentifier$VersionId' => '

Version ID for the specific version of the object to delete.

This functionality is not supported for directory buckets.

', 'ObjectVersion$VersionId' => '

Version ID of an object.

', 'PutObjectAclRequest$VersionId' => '

Version ID used to reference a specific version of the object.

This functionality is not supported for directory buckets.

', 'PutObjectLegalHoldRequest$VersionId' => '

The version ID of the object that you want to place a legal hold on.

', 'PutObjectOutput$VersionId' => '

Version ID of the object.

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. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets in the Amazon S3 User Guide. For information about returning the versioning state of a bucket, see GetBucketVersioning.

This functionality is not supported for directory buckets.

', 'PutObjectRetentionRequest$VersionId' => '

The version ID for the object that you want to apply this Object Retention configuration to.

', 'PutObjectTaggingOutput$VersionId' => '

The versionId of the object the tag-set was added to.

', 'PutObjectTaggingRequest$VersionId' => '

The versionId of the object that the tag-set will be added to.

', 'RestoreObjectRequest$VersionId' => '

VersionId used to reference a specific version of the object.

', 'WriteGetObjectResponseRequest$VersionId' => '

An ID used to reference a specific version of the object.

', ], ], 'ObjectVersionList' => [ 'base' => NULL, 'refs' => [ 'ListObjectVersionsOutput$Versions' => '

Container for version information.

', ], ], 'ObjectVersionStorageClass' => [ 'base' => NULL, 'refs' => [ 'ObjectVersion$StorageClass' => '

The class of storage used to store the object.

', ], ], 'OptionalObjectAttributes' => [ 'base' => NULL, 'refs' => [ 'OptionalObjectAttributesList$member' => NULL, ], ], 'OptionalObjectAttributesList' => [ 'base' => NULL, 'refs' => [ 'ListObjectVersionsRequest$OptionalObjectAttributes' => '

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

', 'ListObjectsRequest$OptionalObjectAttributes' => '

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

', 'ListObjectsV2Request$OptionalObjectAttributes' => '

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

This functionality is not supported for directory buckets.

', ], ], 'OutputLocation' => [ 'base' => '

Describes the location where the restore job\'s output is stored.

', 'refs' => [ 'RestoreRequest$OutputLocation' => '

Describes the location where the restore job\'s output is stored.

', ], ], 'OutputSerialization' => [ 'base' => '

Describes how results of the Select job are serialized.

', 'refs' => [ 'SelectObjectContentRequest$OutputSerialization' => '

Describes the format of the data that you want Amazon S3 to return in response.

', 'SelectParameters$OutputSerialization' => '

Describes how the results of the Select job are serialized.

', ], ], 'Owner' => [ 'base' => '

Container for the owner\'s display name and ID.

', 'refs' => [ 'AccessControlPolicy$Owner' => '

Container for the bucket owner\'s display name and ID.

', 'DeleteMarkerEntry$Owner' => '

The account that created the delete marker.>

', 'GetBucketAclOutput$Owner' => '

Container for the bucket owner\'s display name and ID.

', 'GetObjectAclOutput$Owner' => '

Container for the bucket owner\'s display name and ID.

', 'ListBucketsOutput$Owner' => '

The owner of the buckets listed.

', 'ListPartsOutput$Owner' => '

Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.

Directory buckets - The bucket owner is returned as the object owner for all the parts.

', 'MultipartUpload$Owner' => '

Specifies the owner of the object that is part of the multipart upload.

Directory buckets - The bucket owner is returned as the object owner for all the objects.

', 'Object$Owner' => '

The owner of the object

Directory buckets - The bucket owner is returned as the object owner.

', 'ObjectVersion$Owner' => '

Specifies the owner of the object.

', ], ], 'OwnerOverride' => [ 'base' => NULL, 'refs' => [ 'AccessControlTranslation$Owner' => '

Specifies the replica ownership. For default and valid values, see PUT bucket replication in the Amazon S3 API Reference.

', ], ], 'OwnershipControls' => [ 'base' => '

The container element for a bucket\'s ownership controls.

', 'refs' => [ 'GetBucketOwnershipControlsOutput$OwnershipControls' => '

The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in effect for this Amazon S3 bucket.

', 'PutBucketOwnershipControlsRequest$OwnershipControls' => '

The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) that you want to apply to this Amazon S3 bucket.

', ], ], 'OwnershipControlsRule' => [ 'base' => '

The container element for an ownership control rule.

', 'refs' => [ 'OwnershipControlsRules$member' => NULL, ], ], 'OwnershipControlsRules' => [ 'base' => NULL, 'refs' => [ 'OwnershipControls$Rules' => '

The container element for an ownership control rule.

', ], ], 'ParquetInput' => [ 'base' => '

Container for Parquet.

', 'refs' => [ 'InputSerialization$Parquet' => '

Specifies Parquet as object\'s input serialization format.

', ], ], 'Part' => [ 'base' => '

Container for elements related to a part.

', 'refs' => [ 'Parts$member' => NULL, ], ], 'PartNumber' => [ 'base' => NULL, 'refs' => [ 'CompletedPart$PartNumber' => '

Part number that identifies the part. This is a positive integer between 1 and 10,000.

', 'GetObjectRequest$PartNumber' => '

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a \'ranged\' GET request for the part specified. Useful for downloading just a part of an object.

', 'HeadObjectRequest$PartNumber' => '

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a \'ranged\' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

', 'ObjectPart$PartNumber' => '

The part number identifying the part. This value is a positive integer between 1 and 10,000.

', 'Part$PartNumber' => '

Part number identifying the part. This is a positive integer between 1 and 10,000.

', 'UploadPartCopyRequest$PartNumber' => '

Part number of part being copied. This is a positive integer between 1 and 10,000.

', 'UploadPartRequest$PartNumber' => '

Part number of part being uploaded. This is a positive integer between 1 and 10,000.

', ], ], 'PartNumberMarker' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesParts$PartNumberMarker' => '

The marker for the current part.

', 'GetObjectAttributesRequest$PartNumberMarker' => '

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

', 'ListPartsOutput$PartNumberMarker' => '

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

', 'ListPartsRequest$PartNumberMarker' => '

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

', ], ], 'PartitionDateSource' => [ 'base' => NULL, 'refs' => [ 'PartitionedPrefix$PartitionDateSource' => '

Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.

For DeliveryTime, the time in the log file names corresponds to the delivery time for the log files.

For EventTime, The logs delivered are for a specific day only. The year, month, and day correspond to the day on which the event occurred, and the hour, minutes and seconds are set to 00 in the key.

', ], ], 'PartitionedPrefix' => [ 'base' => '

Amazon S3 keys for log objects are partitioned in the following format:

[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]

PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.

', 'refs' => [ 'TargetObjectKeyFormat$PartitionedPrefix' => '

Partitioned S3 key for log objects.

', ], ], 'Parts' => [ 'base' => NULL, 'refs' => [ 'ListPartsOutput$Parts' => '

Container for elements related to a particular part. A response can contain zero or more Part elements.

', ], ], 'PartsCount' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesParts$TotalPartsCount' => '

The total number of parts.

', 'GetObjectOutput$PartsCount' => '

The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

', 'HeadObjectOutput$PartsCount' => '

The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

', 'WriteGetObjectResponseRequest$PartsCount' => '

The count of parts this object has.

', ], ], 'PartsList' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesParts$Parts' => '

A container for elements related to a particular part. A response can contain zero or more Parts elements.

', ], ], 'Payer' => [ 'base' => NULL, 'refs' => [ 'GetBucketRequestPaymentOutput$Payer' => '

Specifies who pays for the download and request fees.

', 'RequestPaymentConfiguration$Payer' => '

Specifies who pays for the download and request fees.

', ], ], 'Permission' => [ 'base' => NULL, 'refs' => [ 'Grant$Permission' => '

Specifies the permission given to the grantee.

', ], ], 'Policy' => [ 'base' => NULL, 'refs' => [ 'GetBucketPolicyOutput$Policy' => '

The bucket policy as a JSON document.

', 'PutBucketPolicyRequest$Policy' => '

The bucket policy as a JSON document.

For directory buckets, the only IAM action supported in the bucket policy is s3express:CreateSession.

', ], ], 'PolicyStatus' => [ 'base' => '

The container element for a bucket\'s policy status.

', 'refs' => [ 'GetBucketPolicyStatusOutput$PolicyStatus' => '

The policy status for the specified bucket.

', ], ], 'Prefix' => [ 'base' => NULL, 'refs' => [ 'AnalyticsAndOperator$Prefix' => '

The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.

', 'AnalyticsFilter$Prefix' => '

The prefix to use when evaluating an analytics filter.

', 'AnalyticsS3BucketDestination$Prefix' => '

The prefix to use when exporting data. The prefix is prepended to all results.

', 'CommonPrefix$Prefix' => '

Container for the specified common prefix.

', 'IntelligentTieringAndOperator$Prefix' => '

An object key name prefix that identifies the subset of objects to which the configuration applies.

', 'IntelligentTieringFilter$Prefix' => '

An object key name prefix that identifies the subset of objects to which the rule applies.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'InventoryFilter$Prefix' => '

The prefix that an object must have to be included in the inventory results.

', 'InventoryS3BucketDestination$Prefix' => '

The prefix that is prepended to all inventory results.

', 'LifecycleRule$Prefix' => '

Prefix identifying one or more objects to which the rule applies. This is no longer used; use Filter instead.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'LifecycleRuleAndOperator$Prefix' => '

Prefix identifying one or more objects to which the rule applies.

', 'LifecycleRuleFilter$Prefix' => '

Prefix identifying one or more objects to which the rule applies.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'ListBucketsOutput$Prefix' => '

If Prefix was sent with the request, it is included in the response.

All bucket names in the response begin with the specified bucket name prefix.

', 'ListBucketsRequest$Prefix' => '

Limits the response to bucket names that begin with the specified bucket name prefix.

', 'ListMultipartUploadsOutput$Prefix' => '

When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

', 'ListMultipartUploadsRequest$Prefix' => '

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way that you\'d use a folder in a file system.)

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

', 'ListObjectVersionsOutput$Prefix' => '

Selects objects that start with the value supplied by this parameter.

', 'ListObjectVersionsRequest$Prefix' => '

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way that you\'d use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

', 'ListObjectsOutput$Prefix' => '

Keys that begin with the indicated prefix.

', 'ListObjectsRequest$Prefix' => '

Limits the response to keys that begin with the specified prefix.

', 'ListObjectsV2Output$Prefix' => '

Keys that begin with the indicated prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

', 'ListObjectsV2Request$Prefix' => '

Limits the response to keys that begin with the specified prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

', 'MetricsAndOperator$Prefix' => '

The prefix used when evaluating an AND predicate.

', 'MetricsFilter$Prefix' => '

The prefix used when evaluating a metrics filter.

', 'ReplicationRule$Prefix' => '

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.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'ReplicationRuleAndOperator$Prefix' => '

An object key name prefix that identifies the subset of objects to which the rule applies.

', 'ReplicationRuleFilter$Prefix' => '

An object key name prefix that identifies the subset of objects to which the rule applies.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'Rule$Prefix' => '

Object key prefix that identifies one or more objects to which this rule applies.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', ], ], 'Priority' => [ 'base' => NULL, 'refs' => [ 'ReplicationRule$Priority' => '

The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

For more information, see Replication in the Amazon S3 User Guide.

', ], ], 'Progress' => [ 'base' => '

This data type contains information about progress of an operation.

', 'refs' => [ 'ProgressEvent$Details' => '

The Progress event details.

', ], ], 'ProgressEvent' => [ 'base' => '

This data type contains information about the progress event of an operation.

', 'refs' => [ 'SelectObjectContentEventStream$Progress' => '

The Progress Event.

', ], ], 'Protocol' => [ 'base' => NULL, 'refs' => [ 'Redirect$Protocol' => '

Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

', 'RedirectAllRequestsTo$Protocol' => '

Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

', ], ], 'PublicAccessBlockConfiguration' => [ 'base' => '

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 S3 User Guide.

', 'refs' => [ 'GetPublicAccessBlockOutput$PublicAccessBlockConfiguration' => '

The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.

', 'PutPublicAccessBlockRequest$PublicAccessBlockConfiguration' => '

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 S3 User Guide.

', ], ], 'PutBucketAccelerateConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketAclRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketAnalyticsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketCorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketEncryptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketIntelligentTieringConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketInventoryConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketLifecycleConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketLifecycleConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketLifecycleRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketLoggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketMetricsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketNotificationConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketNotificationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketOwnershipControlsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketReplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketRequestPaymentRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketTaggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketVersioningRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketWebsiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectAclOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectAclRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectLegalHoldOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectLegalHoldRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectLockConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectLockConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectRetentionOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectRetentionRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectTaggingOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectTaggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutPublicAccessBlockRequest' => [ 'base' => NULL, 'refs' => [], ], 'QueueArn' => [ 'base' => NULL, 'refs' => [ 'QueueConfiguration$QueueArn' => '

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.

', 'QueueConfigurationDeprecated$Queue' => '

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.

', ], ], 'QueueConfiguration' => [ 'base' => '

Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

', 'refs' => [ 'QueueConfigurationList$member' => NULL, ], ], 'QueueConfigurationDeprecated' => [ 'base' => '

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.

', 'refs' => [ 'NotificationConfigurationDeprecated$QueueConfiguration' => '

This data type is deprecated. 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' => [ 'base' => NULL, 'refs' => [ 'NotificationConfiguration$QueueConfigurations' => '

The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.

', ], ], 'Quiet' => [ 'base' => NULL, 'refs' => [ 'Delete$Quiet' => '

Element to enable quiet mode for the request. When you add this element, you must set its value to true.

', ], ], 'QuoteCharacter' => [ 'base' => NULL, 'refs' => [ 'CSVInput$QuoteCharacter' => '

A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

Type: String

Default: "

Ancestors: CSV

', 'CSVOutput$QuoteCharacter' => '

A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

', ], ], 'QuoteEscapeCharacter' => [ 'base' => NULL, 'refs' => [ 'CSVInput$QuoteEscapeCharacter' => '

A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

', 'CSVOutput$QuoteEscapeCharacter' => '

The single character used for escaping the quote character inside an already escaped value.

', ], ], 'QuoteFields' => [ 'base' => NULL, 'refs' => [ 'CSVOutput$QuoteFields' => '

Indicates whether to use quotation marks around output fields.

', ], ], 'Range' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$Range' => '

Downloads the specified byte range of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.

Amazon S3 doesn\'t support retrieving multiple ranges of data per GET request.

', 'HeadObjectRequest$Range' => '

HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

', ], ], 'RecordDelimiter' => [ 'base' => NULL, 'refs' => [ 'CSVInput$RecordDelimiter' => '

A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

', 'CSVOutput$RecordDelimiter' => '

A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.

', 'JSONOutput$RecordDelimiter' => '

The value used to separate individual records in the output. If no value is specified, Amazon S3 uses a newline character (\'\\n\').

', ], ], 'RecordsEvent' => [ 'base' => '

The container for the records event.

', 'refs' => [ 'SelectObjectContentEventStream$Records' => '

The Records Event.

', ], ], 'Redirect' => [ 'base' => '

Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.

', 'refs' => [ 'RoutingRule$Redirect' => '

Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.

', ], ], 'RedirectAllRequestsTo' => [ 'base' => '

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

', 'refs' => [ 'GetBucketWebsiteOutput$RedirectAllRequestsTo' => '

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

', 'WebsiteConfiguration$RedirectAllRequestsTo' => '

The redirect behavior for every request to this bucket\'s website endpoint.

If you specify this property, you can\'t specify any other property.

', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'HeadBucketOutput$BucketRegion' => '

The Region that the bucket is located.

', ], ], 'ReplaceKeyPrefixWith' => [ 'base' => NULL, 'refs' => [ 'Redirect$ReplaceKeyPrefixWith' => '

The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', ], ], 'ReplaceKeyWith' => [ 'base' => NULL, 'refs' => [ 'Redirect$ReplaceKeyWith' => '

The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', ], ], 'ReplicaKmsKeyID' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$ReplicaKmsKeyID' => '

Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key stored in Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', ], ], 'ReplicaModifications' => [ 'base' => '

A filter that you can specify for selection for modifications on replicas. Amazon S3 doesn\'t replicate replica modifications by default. In the latest version of replication configuration (when Filter is specified), you can specify this element and set the status to Enabled to replicate modifications on replicas.

If you don\'t specify the Filter element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, this element is not allowed.

', 'refs' => [ 'SourceSelectionCriteria$ReplicaModifications' => '

A filter that you can specify for selections for modifications on replicas. Amazon S3 doesn\'t replicate replica modifications by default. In the latest version of replication configuration (when Filter is specified), you can specify this element and set the status to Enabled to replicate modifications on replicas.

If you don\'t specify the Filter element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, this element is not allowed

', ], ], 'ReplicaModificationsStatus' => [ 'base' => NULL, 'refs' => [ 'ReplicaModifications$Status' => '

Specifies whether Amazon S3 replicates modifications on replicas.

', ], ], 'ReplicationConfiguration' => [ 'base' => '

A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

', 'refs' => [ 'GetBucketReplicationOutput$ReplicationConfiguration' => NULL, 'PutBucketReplicationRequest$ReplicationConfiguration' => NULL, ], ], 'ReplicationRule' => [ 'base' => '

Specifies which Amazon S3 objects to replicate and where to store the replicas.

', 'refs' => [ 'ReplicationRules$member' => NULL, ], ], 'ReplicationRuleAndOperator' => [ 'base' => '

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:

', 'refs' => [ 'ReplicationRuleFilter$And' => '

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:

', ], ], 'ReplicationRuleFilter' => [ 'base' => '

A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix, Tag, or an And child element.

', 'refs' => [ 'ReplicationRule$Filter' => NULL, ], ], 'ReplicationRuleStatus' => [ 'base' => NULL, 'refs' => [ 'ReplicationRule$Status' => '

Specifies whether the rule is enabled.

', ], ], 'ReplicationRules' => [ 'base' => NULL, 'refs' => [ 'ReplicationConfiguration$Rules' => '

A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.

', ], ], 'ReplicationStatus' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$ReplicationStatus' => '

Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$ReplicationStatus' => '

Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

In replication, you have a source bucket on which you configure replication and destination bucket or buckets 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:

For more information, see Replication.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$ReplicationStatus' => '

Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.

', ], ], 'ReplicationTime' => [ 'base' => '

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.

', 'refs' => [ 'Destination$ReplicationTime' => '

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.

', ], ], 'ReplicationTimeStatus' => [ 'base' => NULL, 'refs' => [ 'ReplicationTime$Status' => '

Specifies whether the replication time is enabled.

', ], ], 'ReplicationTimeValue' => [ 'base' => '

A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics EventThreshold.

', 'refs' => [ 'Metrics$EventThreshold' => '

A container specifying the time threshold for emitting the s3:Replication:OperationMissedThreshold event.

', 'ReplicationTime$Time' => '

A container specifying the time by which replication should be complete for all objects and operations on objects.

', ], ], 'RequestCharged' => [ 'base' => '

If present, indicates that the requester was successfully charged for the request.

This functionality is not supported for directory buckets.

', 'refs' => [ 'AbortMultipartUploadOutput$RequestCharged' => NULL, 'CompleteMultipartUploadOutput$RequestCharged' => NULL, 'CopyObjectOutput$RequestCharged' => NULL, 'CreateMultipartUploadOutput$RequestCharged' => NULL, 'DeleteObjectOutput$RequestCharged' => NULL, 'DeleteObjectsOutput$RequestCharged' => NULL, 'GetBucketAccelerateConfigurationOutput$RequestCharged' => NULL, 'GetObjectAclOutput$RequestCharged' => NULL, 'GetObjectAttributesOutput$RequestCharged' => NULL, 'GetObjectOutput$RequestCharged' => NULL, 'GetObjectTorrentOutput$RequestCharged' => NULL, 'HeadObjectOutput$RequestCharged' => NULL, 'ListMultipartUploadsOutput$RequestCharged' => NULL, 'ListObjectVersionsOutput$RequestCharged' => NULL, 'ListObjectsOutput$RequestCharged' => NULL, 'ListObjectsV2Output$RequestCharged' => NULL, 'ListPartsOutput$RequestCharged' => NULL, 'PutObjectAclOutput$RequestCharged' => NULL, 'PutObjectLegalHoldOutput$RequestCharged' => NULL, 'PutObjectLockConfigurationOutput$RequestCharged' => NULL, 'PutObjectOutput$RequestCharged' => NULL, 'PutObjectRetentionOutput$RequestCharged' => NULL, 'RestoreObjectOutput$RequestCharged' => NULL, 'UploadPartCopyOutput$RequestCharged' => NULL, 'UploadPartOutput$RequestCharged' => NULL, 'WriteGetObjectResponseRequest$RequestCharged' => NULL, ], ], 'RequestPayer' => [ 'base' => '

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'refs' => [ 'AbortMultipartUploadRequest$RequestPayer' => NULL, 'CompleteMultipartUploadRequest$RequestPayer' => NULL, 'CopyObjectRequest$RequestPayer' => NULL, 'CreateMultipartUploadRequest$RequestPayer' => NULL, 'DeleteObjectRequest$RequestPayer' => NULL, 'DeleteObjectsRequest$RequestPayer' => NULL, 'GetBucketAccelerateConfigurationRequest$RequestPayer' => NULL, 'GetObjectAclRequest$RequestPayer' => NULL, 'GetObjectAttributesRequest$RequestPayer' => NULL, 'GetObjectLegalHoldRequest$RequestPayer' => NULL, 'GetObjectRequest$RequestPayer' => NULL, 'GetObjectRetentionRequest$RequestPayer' => NULL, 'GetObjectTaggingRequest$RequestPayer' => NULL, 'GetObjectTorrentRequest$RequestPayer' => NULL, 'HeadObjectRequest$RequestPayer' => NULL, 'ListMultipartUploadsRequest$RequestPayer' => NULL, 'ListObjectVersionsRequest$RequestPayer' => NULL, 'ListObjectsRequest$RequestPayer' => '

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

', 'ListObjectsV2Request$RequestPayer' => '

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

This functionality is not supported for directory buckets.

', 'ListPartsRequest$RequestPayer' => NULL, 'PutObjectAclRequest$RequestPayer' => NULL, 'PutObjectLegalHoldRequest$RequestPayer' => NULL, 'PutObjectLockConfigurationRequest$RequestPayer' => NULL, 'PutObjectRequest$RequestPayer' => NULL, 'PutObjectRetentionRequest$RequestPayer' => NULL, 'PutObjectTaggingRequest$RequestPayer' => NULL, 'RestoreObjectRequest$RequestPayer' => NULL, 'UploadPartCopyRequest$RequestPayer' => NULL, 'UploadPartRequest$RequestPayer' => NULL, ], ], 'RequestPaymentConfiguration' => [ 'base' => '

Container for Payer.

', 'refs' => [ 'PutBucketRequestPaymentRequest$RequestPaymentConfiguration' => '

Container for Payer.

', ], ], 'RequestProgress' => [ 'base' => '

Container for specifying if periodic QueryProgress messages should be sent.

', 'refs' => [ 'SelectObjectContentRequest$RequestProgress' => '

Specifies if periodic request progress information should be enabled.

', ], ], 'RequestRoute' => [ 'base' => NULL, 'refs' => [ 'WriteGetObjectResponseRequest$RequestRoute' => '

Route prefix to the HTTP URL generated.

', ], ], 'RequestToken' => [ 'base' => NULL, 'refs' => [ 'WriteGetObjectResponseRequest$RequestToken' => '

A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.

', ], ], 'ResponseCacheControl' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ResponseCacheControl' => '

Sets the Cache-Control header of the response.

', 'HeadObjectRequest$ResponseCacheControl' => '

Sets the Cache-Control header of the response.

', ], ], 'ResponseContentDisposition' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ResponseContentDisposition' => '

Sets the Content-Disposition header of the response.

', 'HeadObjectRequest$ResponseContentDisposition' => '

Sets the Content-Disposition header of the response.

', ], ], 'ResponseContentEncoding' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ResponseContentEncoding' => '

Sets the Content-Encoding header of the response.

', 'HeadObjectRequest$ResponseContentEncoding' => '

Sets the Content-Encoding header of the response.

', ], ], 'ResponseContentLanguage' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ResponseContentLanguage' => '

Sets the Content-Language header of the response.

', 'HeadObjectRequest$ResponseContentLanguage' => '

Sets the Content-Language header of the response.

', ], ], 'ResponseContentType' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ResponseContentType' => '

Sets the Content-Type header of the response.

', 'HeadObjectRequest$ResponseContentType' => '

Sets the Content-Type header of the response.

', ], ], 'ResponseExpires' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ResponseExpires' => '

Sets the Expires header of the response.

', 'HeadObjectRequest$ResponseExpires' => '

Sets the Expires header of the response.

', ], ], 'Restore' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$Restore' => '

Provides information about object restoration action and expiration time of the restored object copy.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'HeadObjectOutput$Restore' => '

If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object restoration is in progress, the header returns the value ongoing-request="true".

For more information about archiving objects, see Transitioning Objects: General Considerations.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'WriteGetObjectResponseRequest$Restore' => '

Provides information about object restoration operation and expiration time of the restored object copy.

', ], ], 'RestoreExpiryDate' => [ 'base' => NULL, 'refs' => [ 'RestoreStatus$RestoreExpiryDate' => '

Indicates when the restored copy will expire. This value is populated only if the object has already been restored. For example:

x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

', ], ], 'RestoreObjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'RestoreObjectRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestoreOutputPath' => [ 'base' => NULL, 'refs' => [ 'RestoreObjectOutput$RestoreOutputPath' => '

Indicates the path in the provided S3 output location where Select results will be restored to.

', ], ], 'RestoreRequest' => [ 'base' => '

Container for restore job parameters.

', 'refs' => [ 'RestoreObjectRequest$RestoreRequest' => NULL, ], ], 'RestoreRequestType' => [ 'base' => NULL, 'refs' => [ 'RestoreRequest$Type' => '

Type of restore request.

', ], ], 'RestoreStatus' => [ 'base' => '

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'refs' => [ 'Object$RestoreStatus' => '

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'ObjectVersion$RestoreStatus' => '

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

', ], ], 'Role' => [ 'base' => NULL, 'refs' => [ 'ReplicationConfiguration$Role' => '

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Replication in the Amazon S3 User Guide.

', ], ], 'RoutingRule' => [ 'base' => '

Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see Configuring advanced conditional redirects in the Amazon S3 User Guide.

', 'refs' => [ 'RoutingRules$member' => NULL, ], ], 'RoutingRules' => [ 'base' => NULL, 'refs' => [ 'GetBucketWebsiteOutput$RoutingRules' => '

Rules that define when a redirect is applied and the redirect behavior.

', 'WebsiteConfiguration$RoutingRules' => '

Rules that define when a redirect is applied and the redirect behavior.

', ], ], 'Rule' => [ 'base' => '

Specifies lifecycle rules for an Amazon S3 bucket. For more information, see Put Bucket Lifecycle Configuration in the Amazon S3 API Reference. For examples, see Put Bucket Lifecycle Configuration Examples.

', 'refs' => [ 'Rules$member' => NULL, ], ], 'Rules' => [ 'base' => NULL, 'refs' => [ 'GetBucketLifecycleOutput$Rules' => '

Container for a lifecycle rule.

', 'LifecycleConfiguration$Rules' => '

Specifies lifecycle configuration rules for an Amazon S3 bucket.

', ], ], 'S3KeyFilter' => [ 'base' => '

A container for object key name prefix and suffix filtering rules.

', 'refs' => [ 'NotificationConfigurationFilter$Key' => NULL, ], ], 'S3Location' => [ 'base' => '

Describes an Amazon S3 location that will receive the results of the restore request.

', 'refs' => [ 'OutputLocation$S3' => '

Describes an S3 location that will receive the results of the restore request.

', ], ], 'SSECustomerAlgorithm' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadRequest$SSECustomerAlgorithm' => '

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is required only when the object was created using a checksum algorithm or if your bucket policy requires the use of SSE-C. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'CopyObjectOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'CopyObjectRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

When you perform a CopyObject operation, if you want to use a different type of encryption setting for the target object, you can specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence.

This functionality is not supported when the destination bucket is a directory bucket.

', 'CreateMultipartUploadOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

', 'GetObjectAttributesRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

', 'GetObjectOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'GetObjectRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when decrypting the object (for example, AES256).

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:

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'HeadObjectRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

', 'ListPartsRequest$SSECustomerAlgorithm' => '

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'PutObjectOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

', 'SelectObjectContentRequest$SSECustomerAlgorithm' => '

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

', 'UploadPartCopyOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'UploadPartCopyRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported when the destination bucket is a directory bucket.

', 'UploadPartOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'UploadPartRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$SSECustomerAlgorithm' => '

Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.

', ], ], 'SSECustomerKey' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadRequest$SSECustomerKey' => '

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'CopyObjectRequest$SSECustomerKey' => '

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 functionality is not supported when the destination bucket is a directory bucket.

', 'CreateMultipartUploadRequest$SSECustomerKey' => '

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 functionality is not supported for directory buckets.

', 'GetObjectAttributesRequest$SSECustomerKey' => '

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 functionality is not supported for directory buckets.

', 'GetObjectRequest$SSECustomerKey' => '

Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

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:

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'HeadObjectRequest$SSECustomerKey' => '

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 functionality is not supported for directory buckets.

', 'ListPartsRequest$SSECustomerKey' => '

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$SSECustomerKey' => '

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 functionality is not supported for directory buckets.

', 'SelectObjectContentRequest$SSECustomerKey' => '

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

', 'UploadPartCopyRequest$SSECustomerKey' => '

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.

This functionality is not supported when the destination bucket is a directory bucket.

', 'UploadPartRequest$SSECustomerKey' => '

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.

This functionality is not supported for directory buckets.

', ], ], 'SSECustomerKeyMD5' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadRequest$SSECustomerKeyMD5' => '

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'CopyObjectOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'CopyObjectRequest$SSECustomerKeyMD5' => '

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.

This functionality is not supported when the destination bucket is a directory bucket.

', 'CreateMultipartUploadOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$SSECustomerKeyMD5' => '

Specifies the 128-bit MD5 digest of the customer-provided 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.

This functionality is not supported for directory buckets.

', 'GetObjectAttributesRequest$SSECustomerKeyMD5' => '

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.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'GetObjectRequest$SSECustomerKeyMD5' => '

Specifies the 128-bit MD5 digest of the customer-provided 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.

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:

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'HeadObjectRequest$SSECustomerKeyMD5' => '

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.

This functionality is not supported for directory buckets.

', 'ListPartsRequest$SSECustomerKeyMD5' => '

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'PutObjectOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$SSECustomerKeyMD5' => '

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.

This functionality is not supported for directory buckets.

', 'SelectObjectContentRequest$SSECustomerKeyMD5' => '

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

', 'UploadPartCopyOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'UploadPartCopyRequest$SSECustomerKeyMD5' => '

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.

This functionality is not supported when the destination bucket is a directory bucket.

', 'UploadPartOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'UploadPartRequest$SSECustomerKeyMD5' => '

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.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$SSECustomerKeyMD5' => '

128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).

', ], ], 'SSEKMS' => [ 'base' => '

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

', 'refs' => [ 'InventoryEncryption$SSEKMS' => '

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

', ], ], 'SSEKMSEncryptionContext' => [ 'base' => NULL, 'refs' => [ 'CopyObjectOutput$SSEKMSEncryptionContext' => '

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

', 'CopyObjectRequest$SSEKMSEncryptionContext' => '

Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for the destination object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

General purpose buckets - This value must be explicitly added to specify encryption context for CopyObject requests if you want an additional encryption context for your destination object. The additional encryption context of the source object won\'t be copied to the destination object. For more information, see Encryption context in the Amazon S3 User Guide.

Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

', 'CreateMultipartUploadOutput$SSEKMSEncryptionContext' => '

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.

', 'CreateMultipartUploadRequest$SSEKMSEncryptionContext' => '

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.

Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

', 'CreateSessionOutput$SSEKMSEncryptionContext' => '

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.

', 'CreateSessionRequest$SSEKMSEncryptionContext' => '

Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.

General purpose buckets - This value must be explicitly added during CopyObject operations if you want an additional encryption context for your object. For more information, see Encryption context in the Amazon S3 User Guide.

Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

', 'PutObjectOutput$SSEKMSEncryptionContext' => '

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.

', 'PutObjectRequest$SSEKMSEncryptionContext' => '

Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.

General purpose buckets - This value must be explicitly added during CopyObject operations if you want an additional encryption context for your object. For more information, see Encryption context in the Amazon S3 User Guide.

Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

', ], ], 'SSEKMSKeyId' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'CopyObjectOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'CopyObjectRequest$SSEKMSKeyId' => '

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they\'re not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, the x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that\'s configured for your directory bucket\'s default encryption setting. If you want to specify the x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that\'s configured for your directory bucket\'s default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn\'t supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn\'t supported.

', 'CreateMultipartUploadOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'CreateMultipartUploadRequest$SSEKMSKeyId' => '

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn\'t exist in the same account that\'s issuing the command, you must use the full Key ARN not the Key ID.

General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify x-amz-server-side-encryption:aws:kms or x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3) to protect the data.

Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, the x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that\'s configured for your directory bucket\'s default encryption setting. If you want to specify the x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that\'s configured for your directory bucket\'s default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn\'t supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn\'t supported.

', 'CreateSessionOutput$SSEKMSKeyId' => '

If you specify x-amz-server-side-encryption with aws:kms, this header indicates the ID of the KMS symmetric encryption customer managed key that was used for object encryption.

', 'CreateSessionRequest$SSEKMSKeyId' => '

If you specify x-amz-server-side-encryption with aws:kms, you must specify the x-amz-server-side-encryption-aws-kms-key-id header with the ID (Key ID or Key ARN) of the KMS symmetric encryption customer managed key to use. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn\'t supported. Also, if the KMS key doesn\'t exist in the same account that\'t issuing the command, you must use the full Key ARN not the Key ID.

Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn\'t supported.

', 'Encryption$KMSKeyId' => '

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'GetObjectOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'HeadObjectOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'PutObjectOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'PutObjectRequest$SSEKMSKeyId' => '

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn\'t exist in the same account that\'s issuing the command, you must use the full Key ARN not the Key ID.

General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify x-amz-server-side-encryption:aws:kms or x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3) to protect the data.

Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, the x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that\'s configured for your directory bucket\'s default encryption setting. If you want to specify the x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that\'s configured for your directory bucket\'s default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn\'t supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn\'t supported.

', 'SSEKMS$KeyId' => '

Specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key to use for encrypting inventory reports.

', 'ServerSideEncryptionByDefault$KMSMasterKeyID' => '

Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the default encryption.

You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.

If you are using encryption with cross-account or Amazon Web Services service operations, you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'UploadPartCopyOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'UploadPartOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'WriteGetObjectResponseRequest$SSEKMSKeyId' => '

If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in Amazon S3 object.

', ], ], 'SSES3' => [ 'base' => '

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

', 'refs' => [ 'InventoryEncryption$SSES3' => '

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

', ], ], 'ScanRange' => [ 'base' => '

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.

', 'refs' => [ 'SelectObjectContentRequest$ScanRange' => '

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.

ScanRangemay be used in the following ways:

', ], ], 'SelectObjectContentEventStream' => [ 'base' => '

The container for selecting objects from a content event stream.

', 'refs' => [ 'SelectObjectContentOutput$Payload' => '

The array of results.

', ], ], 'SelectObjectContentOutput' => [ 'base' => NULL, 'refs' => [], ], 'SelectObjectContentRequest' => [ 'base' => '

Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records. It returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, see S3Select API Documentation.

', 'refs' => [], ], 'SelectParameters' => [ 'base' => '

Describes the parameters for Select job types.

', 'refs' => [ 'RestoreRequest$SelectParameters' => '

Describes the parameters for Select job types.

', ], ], 'ServerSideEncryption' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

', 'CopyObjectOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

', 'CopyObjectRequest$ServerSideEncryption' => '

The server-side encryption algorithm used when storing this object in Amazon S3. Unrecognized or unsupported values won’t write a destination object and will receive a 400 Bad Request response.

Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if you don\'t specify encryption information in your copy request, the encryption setting of the target object is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a different default encryption configuration, Amazon S3 uses the corresponding encryption key to encrypt the target object copy.

With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side Encryption in the Amazon S3 User Guide.

General purpose buckets

Directory buckets

', 'CreateMultipartUploadOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

', 'CreateMultipartUploadRequest$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

', 'CreateSessionOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store objects in the directory bucket.

', 'CreateSessionRequest$ServerSideEncryption' => '

The server-side encryption algorithm to use when you store objects in the directory bucket.

For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). By default, Amazon S3 encrypts data with SSE-S3. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

', 'Encryption$EncryptionType' => '

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

', 'GetObjectOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3.

', 'HeadObjectOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

', 'PutObjectOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3.

', 'PutObjectRequest$ServerSideEncryption' => '

The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

', 'ServerSideEncryptionByDefault$SSEAlgorithm' => '

Server-side encryption algorithm to use for the default encryption.

For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms.

', 'UploadPartCopyOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

', 'UploadPartOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

', 'WriteGetObjectResponseRequest$ServerSideEncryption' => '

The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).

', ], ], 'ServerSideEncryptionByDefault' => [ 'base' => '

Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn\'t specify any server-side encryption, this default encryption will be applied. For more information, see PutBucketEncryption.

', 'refs' => [ 'ServerSideEncryptionRule$ApplyServerSideEncryptionByDefault' => '

Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn\'t specify any server-side encryption, this default encryption will be applied.

', ], ], 'ServerSideEncryptionConfiguration' => [ 'base' => '

Specifies the default server-side-encryption configuration.

', 'refs' => [ 'GetBucketEncryptionOutput$ServerSideEncryptionConfiguration' => NULL, 'PutBucketEncryptionRequest$ServerSideEncryptionConfiguration' => NULL, ], ], 'ServerSideEncryptionRule' => [ 'base' => '

Specifies the default server-side encryption configuration.

', 'refs' => [ 'ServerSideEncryptionRules$member' => NULL, ], ], 'ServerSideEncryptionRules' => [ 'base' => NULL, 'refs' => [ 'ServerSideEncryptionConfiguration$Rules' => '

Container for information about a particular server-side encryption configuration rule.

', ], ], 'SessionCredentialValue' => [ 'base' => NULL, 'refs' => [ 'SessionCredentials$SecretAccessKey' => '

A key that\'s used with the access key ID to cryptographically sign programmatic Amazon Web Services requests. Signing a request identifies the sender and prevents the request from being altered.

', 'SessionCredentials$SessionToken' => '

A part of the temporary security credentials. The session token is used to validate the temporary security credentials.

', ], ], 'SessionCredentials' => [ 'base' => '

The established temporary security credentials of the session.

Directory buckets - These session credentials are only supported for the authentication and authorization of Zonal endpoint API operations on directory buckets.

', 'refs' => [ 'CreateSessionOutput$Credentials' => '

The established temporary security credentials for the created session.

', ], ], 'SessionExpiration' => [ 'base' => NULL, 'refs' => [ 'SessionCredentials$Expiration' => '

Temporary security credentials expire after a specified interval. After temporary credentials expire, any calls that you make with those credentials will fail. So you must generate a new set of temporary credentials. Temporary credentials cannot be extended or refreshed beyond the original specified interval.

', ], ], 'SessionMode' => [ 'base' => NULL, 'refs' => [ 'CreateSessionRequest$SessionMode' => '

Specifies the mode of the session that will be created, either ReadWrite or ReadOnly. By default, a ReadWrite session is created. A ReadWrite session is capable of executing all the Zonal endpoint API operations on a directory bucket. A ReadOnly session is constrained to execute the following Zonal endpoint API operations: GetObject, HeadObject, ListObjectsV2, GetObjectAttributes, ListParts, and ListMultipartUploads.

', ], ], 'Setting' => [ 'base' => NULL, 'refs' => [ 'PublicAccessBlockConfiguration$BlockPublicAcls' => '

Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior:

Enabling this setting doesn\'t affect existing policies or ACLs.

', 'PublicAccessBlockConfiguration$IgnorePublicAcls' => '

Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.

Enabling this setting doesn\'t affect the persistence of any existing ACLs and doesn\'t prevent new public ACLs from being set.

', 'PublicAccessBlockConfiguration$BlockPublicPolicy' => '

Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

Enabling this setting doesn\'t affect existing bucket policies.

', 'PublicAccessBlockConfiguration$RestrictPublicBuckets' => '

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only Amazon Web Services service principals and authorized users within this account if the bucket has a public policy.

Enabling this setting doesn\'t affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

', ], ], 'SimplePrefix' => [ 'base' => '

To use simple format for S3 keys for log objects, set SimplePrefix to an empty object.

[DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]

', 'refs' => [ 'TargetObjectKeyFormat$SimplePrefix' => '

To use the simple format for S3 keys for log objects. To specify SimplePrefix format, set SimplePrefix to {}.

', ], ], 'Size' => [ 'base' => NULL, 'refs' => [ 'Object$Size' => '

Size in bytes of the object

', 'ObjectIdentifier$Size' => '

If present, the objects are deleted only if its size matches the provided size in bytes.

This functionality is only supported for directory buckets.

', 'ObjectPart$Size' => '

The size of the uploaded part in bytes.

', 'ObjectVersion$Size' => '

Size in bytes of the object.

', 'Part$Size' => '

Size in bytes of the uploaded part data.

', 'PutObjectOutput$Size' => '

The size of the object in bytes. This will only be present if you append to an object.

This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.

', ], ], 'SkipValidation' => [ 'base' => NULL, 'refs' => [ 'PutBucketNotificationConfigurationRequest$SkipDestinationValidation' => '

Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. True or false value.

', ], ], 'SourceSelectionCriteria' => [ 'base' => '

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

', 'refs' => [ 'ReplicationRule$SourceSelectionCriteria' => '

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

', ], ], 'SseKmsEncryptedObjects' => [ 'base' => '

A container for filter information for the selection of S3 objects encrypted with Amazon Web Services KMS.

', 'refs' => [ 'SourceSelectionCriteria$SseKmsEncryptedObjects' => '

A container for filter information for the selection of Amazon S3 objects encrypted with Amazon Web Services KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required.

', ], ], 'SseKmsEncryptedObjectsStatus' => [ 'base' => NULL, 'refs' => [ 'SseKmsEncryptedObjects$Status' => '

Specifies whether Amazon S3 replicates objects created with server-side encryption using an Amazon Web Services KMS key stored in Amazon Web Services Key Management Service.

', ], ], 'Start' => [ 'base' => NULL, 'refs' => [ 'ScanRange$Start' => '

Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only start is supplied, it means scan from that point to the end of the file. For example, <scanrange><start>50</start></scanrange> means scan from byte 50 until the end of the file.

', ], ], 'StartAfter' => [ 'base' => NULL, 'refs' => [ 'ListObjectsV2Output$StartAfter' => '

If StartAfter was sent with the request, it is included in the response.

This functionality is not supported for directory buckets.

', 'ListObjectsV2Request$StartAfter' => '

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

This functionality is not supported for directory buckets.

', ], ], 'Stats' => [ 'base' => '

Container for the stats details.

', 'refs' => [ 'StatsEvent$Details' => '

The Stats event details.

', ], ], 'StatsEvent' => [ 'base' => '

Container for the Stats Event.

', 'refs' => [ 'SelectObjectContentEventStream$Stats' => '

The Stats Event.

', ], ], 'StorageClass' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$StorageClass' => '

If the x-amz-storage-class header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class.

You can use the CopyObject action to change the storage class of an object that is already stored in Amazon S3 by using the x-amz-storage-class header. For more information, see Storage Classes in the Amazon S3 User Guide.

Before using an object as a source object for the copy operation, you must restore a copy of it if it meets any of the following conditions:

For more information, see RestoreObject and Copying Objects in the Amazon S3 User Guide.

', 'CreateMultipartUploadRequest$StorageClass' => '

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

', 'Destination$StorageClass' => '

The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.

For valid values, see the StorageClass element of the PUT Bucket replication action in the Amazon S3 API Reference.

', 'GetObjectAttributesOutput$StorageClass' => '

Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'GetObjectOutput$StorageClass' => '

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'HeadObjectOutput$StorageClass' => '

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'InvalidObjectState$StorageClass' => NULL, 'ListPartsOutput$StorageClass' => '

The class of storage used to store the uploaded object.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'MultipartUpload$StorageClass' => '

The class of storage used to store the object.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'PutObjectRequest$StorageClass' => '

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

', 'S3Location$StorageClass' => '

The class of storage used to store the restore results.

', 'WriteGetObjectResponseRequest$StorageClass' => '

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

', ], ], 'StorageClassAnalysis' => [ 'base' => '

Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.

', 'refs' => [ 'AnalyticsConfiguration$StorageClassAnalysis' => '

Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.

', ], ], 'StorageClassAnalysisDataExport' => [ 'base' => '

Container for data related to the storage class analysis for an Amazon S3 bucket for export.

', 'refs' => [ 'StorageClassAnalysis$DataExport' => '

Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.

', ], ], 'StorageClassAnalysisSchemaVersion' => [ 'base' => NULL, 'refs' => [ 'StorageClassAnalysisDataExport$OutputSchemaVersion' => '

The version of the output schema to use when exporting data. Must be V_1.

', ], ], 'Suffix' => [ 'base' => NULL, 'refs' => [ 'IndexDocument$Suffix' => '

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.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', ], ], 'Tag' => [ 'base' => '

A container of a key value name pair.

', 'refs' => [ 'AnalyticsFilter$Tag' => '

The tag to use when evaluating an analytics filter.

', 'IntelligentTieringFilter$Tag' => NULL, 'LifecycleRuleFilter$Tag' => '

This tag must exist in the object\'s tag set in order for the rule to apply.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'MetricsFilter$Tag' => '

The tag used when evaluating a metrics filter.

', 'ReplicationRuleFilter$Tag' => '

A container for specifying a tag key and value.

The rule applies only to objects that have the tag in their tag set.

', 'TagSet$member' => NULL, ], ], 'TagCount' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$TagCount' => '

The number of tags, if any, on the object, when you have the relevant permission to read object tags.

You can use GetObjectTagging to retrieve the tag set associated with an object.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$TagCount' => '

The number of tags, if any, on the object.

', ], ], 'TagSet' => [ 'base' => NULL, 'refs' => [ 'AnalyticsAndOperator$Tags' => '

The list of tags to use when evaluating an AND predicate.

', 'GetBucketTaggingOutput$TagSet' => '

Contains the tag set.

', 'GetObjectTaggingOutput$TagSet' => '

Contains the tag set.

', 'IntelligentTieringAndOperator$Tags' => '

All of these tags must exist in the object\'s tag set in order for the configuration to apply.

', 'LifecycleRuleAndOperator$Tags' => '

All of these tags must exist in the object\'s tag set in order for the rule to apply.

', 'MetricsAndOperator$Tags' => '

The list of tags used when evaluating an AND predicate.

', 'ReplicationRuleAndOperator$Tags' => '

An array of tags containing key and value pairs.

', 'Tagging$TagSet' => '

A collection for a set of tags

', ], ], 'Tagging' => [ 'base' => '

Container for TagSet elements.

', 'refs' => [ 'PutBucketTaggingRequest$Tagging' => '

Container for the TagSet and Tag elements.

', 'PutObjectTaggingRequest$Tagging' => '

Container for the TagSet and Tag elements

', 'S3Location$Tagging' => '

The tag-set that is applied to the restore results.

', ], ], 'TaggingDirective' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$TaggingDirective' => '

Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that\'s provided in the request.

The default value is COPY.

Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the following situations:

Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the following situations are allowed:

', ], ], 'TaggingHeader' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$Tagging' => '

The tag-set for the object copy in the destination bucket. This value must be used in conjunction with the x-amz-tagging-directive if you choose REPLACE for the x-amz-tagging-directive. If you choose COPY for the x-amz-tagging-directive, you don\'t need to set the x-amz-tagging header, because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query parameters.

The default value is the empty value.

Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the following situations:

Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the following situations are allowed:

', 'CreateMultipartUploadRequest$Tagging' => '

The tag-set for the object. The tag-set must be encoded as URL Query parameters.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$Tagging' => '

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

This functionality is not supported for directory buckets.

', ], ], 'TargetBucket' => [ 'base' => NULL, 'refs' => [ 'LoggingEnabled$TargetBucket' => '

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.

', ], ], 'TargetGrant' => [ 'base' => '

Container for granting information.

Buckets that use the bucket owner enforced setting for Object Ownership don\'t support target grants. For more information, see Permissions server access log delivery in the Amazon S3 User Guide.

', 'refs' => [ 'TargetGrants$member' => NULL, ], ], 'TargetGrants' => [ 'base' => NULL, 'refs' => [ 'LoggingEnabled$TargetGrants' => '

Container for granting information.

Buckets that use the bucket owner enforced setting for Object Ownership don\'t support target grants. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.

', ], ], 'TargetObjectKeyFormat' => [ 'base' => '

Amazon S3 key format for log objects. Only one format, PartitionedPrefix or SimplePrefix, is allowed.

', 'refs' => [ 'LoggingEnabled$TargetObjectKeyFormat' => '

Amazon S3 key format for log objects.

', ], ], 'TargetPrefix' => [ 'base' => NULL, 'refs' => [ 'LoggingEnabled$TargetPrefix' => '

A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

', ], ], 'Tier' => [ 'base' => NULL, 'refs' => [ 'GlacierJobParameters$Tier' => '

Retrieval tier at which the restore will be processed.

', 'RestoreRequest$Tier' => '

Retrieval tier at which the restore will be processed.

', ], ], 'Tiering' => [ 'base' => '

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead.

', 'refs' => [ 'TieringList$member' => NULL, ], ], 'TieringList' => [ 'base' => NULL, 'refs' => [ 'IntelligentTieringConfiguration$Tierings' => '

Specifies the S3 Intelligent-Tiering storage class tier of the configuration.

', ], ], 'Token' => [ 'base' => NULL, 'refs' => [ 'ListBucketAnalyticsConfigurationsOutput$ContinuationToken' => '

The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.

', 'ListBucketAnalyticsConfigurationsRequest$ContinuationToken' => '

The ContinuationToken that represents a placeholder from where this request should begin.

', 'ListBucketIntelligentTieringConfigurationsOutput$ContinuationToken' => '

The ContinuationToken that represents a placeholder from where this request should begin.

', 'ListBucketIntelligentTieringConfigurationsRequest$ContinuationToken' => '

The ContinuationToken that represents a placeholder from where this request should begin.

', 'ListBucketInventoryConfigurationsOutput$ContinuationToken' => '

If sent in the request, the marker that is used as a starting point for this inventory configuration list response.

', 'ListBucketInventoryConfigurationsRequest$ContinuationToken' => '

The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

', 'ListBucketMetricsConfigurationsOutput$ContinuationToken' => '

The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.

', 'ListBucketMetricsConfigurationsRequest$ContinuationToken' => '

The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

', 'ListBucketsRequest$ContinuationToken' => '

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No.

If you specify the bucket-region, prefix, or continuation-token query parameters without using max-buckets to set the maximum number of buckets returned in the response, Amazon S3 applies a default page size of 10,000 and provides a continuation token if there are more buckets.

', 'ListObjectsV2Output$ContinuationToken' => '

If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response. You can use this ContinuationToken for pagination of the list results.

', 'ListObjectsV2Request$ContinuationToken' => '

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

', ], ], 'TooManyParts' => [ 'base' => '

You have attempted to add more parts than the maximum of 10000 that are allowed for this object. You can use the CopyObject operation to copy this object to another and then add more data to the newly copied object.

', 'refs' => [], ], 'TopicArn' => [ 'base' => NULL, 'refs' => [ 'TopicConfiguration$TopicArn' => '

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.

', 'TopicConfigurationDeprecated$Topic' => '

Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.

', ], ], 'TopicConfiguration' => [ 'base' => '

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.

', 'refs' => [ 'TopicConfigurationList$member' => NULL, ], ], 'TopicConfigurationDeprecated' => [ 'base' => '

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.

', 'refs' => [ 'NotificationConfigurationDeprecated$TopicConfiguration' => '

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.

', ], ], 'TopicConfigurationList' => [ 'base' => NULL, 'refs' => [ 'NotificationConfiguration$TopicConfigurations' => '

The topic to which notifications are sent and the events for which notifications are generated.

', ], ], 'Transition' => [ 'base' => '

Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.

', 'refs' => [ 'Rule$Transition' => '

Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.

', 'TransitionList$member' => NULL, ], ], 'TransitionDefaultMinimumObjectSize' => [ 'base' => NULL, 'refs' => [ 'GetBucketLifecycleConfigurationOutput$TransitionDefaultMinimumObjectSize' => '

Indicates which default minimum object size behavior is applied to the lifecycle configuration.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

', 'PutBucketLifecycleConfigurationOutput$TransitionDefaultMinimumObjectSize' => '

Indicates which default minimum object size behavior is applied to the lifecycle configuration.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

', 'PutBucketLifecycleConfigurationRequest$TransitionDefaultMinimumObjectSize' => '

Indicates which default minimum object size behavior is applied to the lifecycle configuration.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

', ], ], 'TransitionList' => [ 'base' => NULL, 'refs' => [ 'LifecycleRule$Transitions' => '

Specifies when an Amazon S3 object transitions to a specified storage class.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', ], ], 'TransitionStorageClass' => [ 'base' => NULL, 'refs' => [ 'NoncurrentVersionTransition$StorageClass' => '

The class of storage used to store the object.

', 'Transition$StorageClass' => '

The storage class to which you want the object to transition.

', ], ], 'Type' => [ 'base' => NULL, 'refs' => [ 'Grantee$Type' => '

Type of grantee

', ], ], 'URI' => [ 'base' => NULL, 'refs' => [ 'Grantee$URI' => '

URI of the grantee group.

', ], ], 'UploadIdMarker' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$UploadIdMarker' => '

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.

This functionality is not supported for directory buckets.

', 'ListMultipartUploadsRequest$UploadIdMarker' => '

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.

This functionality is not supported for directory buckets.

', ], ], 'UploadPartCopyOutput' => [ 'base' => NULL, 'refs' => [], ], 'UploadPartCopyRequest' => [ 'base' => NULL, 'refs' => [], ], 'UploadPartOutput' => [ 'base' => NULL, 'refs' => [], ], 'UploadPartRequest' => [ 'base' => NULL, 'refs' => [], ], 'UserMetadata' => [ 'base' => NULL, 'refs' => [ 'S3Location$UserMetadata' => '

A list of metadata to store with the restore results in S3.

', ], ], 'Value' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

Value of the tag.

', ], ], 'VersionCount' => [ 'base' => NULL, 'refs' => [ 'NoncurrentVersionExpiration$NewerNoncurrentVersions' => '

Specifies how many noncurrent versions Amazon S3 will retain. You can specify up to 100 noncurrent versions to retain. Amazon S3 will permanently delete any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'NoncurrentVersionTransition$NewerNoncurrentVersions' => '

Specifies how many noncurrent versions Amazon S3 will retain in the same storage class before transitioning objects. You can specify up to 100 noncurrent versions to retain. Amazon S3 will transition any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.

', ], ], 'VersionIdMarker' => [ 'base' => NULL, 'refs' => [ 'ListObjectVersionsOutput$VersionIdMarker' => '

Marks the last version of the key returned in a truncated response.

', 'ListObjectVersionsRequest$VersionIdMarker' => '

Specifies the object version you want to start listing from.

', ], ], 'VersioningConfiguration' => [ 'base' => '

Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning in the Amazon S3 API Reference.

', 'refs' => [ 'PutBucketVersioningRequest$VersioningConfiguration' => '

Container for setting the versioning state.

', ], ], 'WebsiteConfiguration' => [ 'base' => '

Specifies website configuration parameters for an Amazon S3 bucket.

', 'refs' => [ 'PutBucketWebsiteRequest$WebsiteConfiguration' => '

Container for the request.

', ], ], 'WebsiteRedirectLocation' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$WebsiteRedirectLocation' => '

If the destination bucket is configured as a website, redirects requests for this object copy to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the x-amz-metadata-directive header. Instead, you may opt to provide this header in combination with the x-amz-metadata-directive header.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$WebsiteRedirectLocation' => '

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.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$WebsiteRedirectLocation' => '

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.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$WebsiteRedirectLocation' => '

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.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$WebsiteRedirectLocation' => '

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 Amazon S3 User Guide.

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 in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', ], ], 'WriteGetObjectResponseRequest' => [ 'base' => NULL, 'refs' => [], ], 'WriteOffsetBytes' => [ 'base' => NULL, 'refs' => [ 'PutObjectRequest$WriteOffsetBytes' => '

Specifies the offset for appending data to existing objects in bytes. The offset must be equal to the size of the existing object being appended to. If no object exists, setting this header to 0 will create a new object.

This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.

', ], ], 'Years' => [ 'base' => NULL, 'refs' => [ 'DefaultRetention$Years' => '

The number of years that you want to specify for the default retention period. Must be used with Mode.

', ], ], ],]; +return [ 'version' => '2.0', 'service' => '

', 'operations' => [ '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 and prevent getting charged for the part storage, you should call the ListParts API operation and ensure that the parts list is empty.

Permissions

  • General purpose bucket permissions - For information about permissions required to use the multipart upload, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to AbortMultipartUpload:

', 'CompleteMultipartUpload' => '

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the UploadPart operation or the UploadPartCopy operation. After successfully uploading all relevant parts of an upload, you call this CompleteMultipartUpload 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 CompleteMultipartUpload request, you must provide the parts list and ensure that the parts list is complete. The CompleteMultipartUpload API operation concatenates the parts that you provide in the list. For each part in the list, you must provide the PartNumber value and the ETag value that are returned after that part was uploaded.

The processing of a CompleteMultipartUpload request could take several minutes to finalize. 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. A request could fail after the initial 200 OK response has been sent. This means that a 200 OK response can contain either a success or an error. The error response might be embedded in the 200 OK response. If you call this API operation directly, make sure to design your application to parse the contents of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don\'t use exceptions, they return an error).

Note that if CompleteMultipartUpload fails, applications should be prepared to retry any failed requests (including 500 error responses). For more information, see Amazon S3 Error Best Practices.

You can\'t use Content-Type: application/x-www-form-urlencoded for the CompleteMultipartUpload requests. Also, if you don\'t provide a Content-Type header, CompleteMultipartUpload can still return a 200 OK response.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

    If you provide an additional checksum value in your MultipartUpload requests and the object is encrypted with Key Management Service, you must have permission to use the kms:Decrypt action for the CompleteMultipartUpload request to succeed.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

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.

    • HTTP Status Code: 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 ETag might not have matched the uploaded part\'s ETag.

    • HTTP Status Code: 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.

    • HTTP Status Code: 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.

    • HTTP Status Code: 404 Not Found

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to CompleteMultipartUpload:

', 'CopyObject' => '

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 action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the REST Multipart Upload API.

You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose buckets and directory buckets.

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. For more information about how to enable a Region for your account, see Enable or disable a Region for standalone accounts in the Amazon Web Services Account Management Guide.

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, see Transfer Acceleration.
Authentication and authorization

All CopyObject requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.

Directory buckets - You must use the IAM credentials to authenticate and authorize your access to the CopyObject API operation, instead of using the temporary security credentials through the CreateSession API operation.

Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.

Permissions

You must have read access to the source object and write access to the destination bucket.

  • General purpose bucket permissions - You must have permissions in an IAM policy based on the source and destination bucket types in a CopyObject operation.

    • If the source object is in a general purpose bucket, you must have s3:GetObject permission to read the source object that is being copied.

    • If the destination bucket is a general purpose bucket, you must have s3:PutObject permission to write the object copy to the destination bucket.

  • Directory bucket permissions - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in a CopyObject operation.

    • If the source object that you want to copy is in a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to read the object. By default, the session is in the ReadWrite mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode condition key to ReadOnly on the copy source bucket.

    • If the copy destination is a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to write the object to the destination. The s3express:SessionMode condition key can\'t be set to ReadOnly on the copy destination bucket.

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

    For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.

Response and special errors

When the request is an HTTP 1.1 request, the response is chunk encoded. When the request is not an HTTP 1.1 request, the response would not contain the Content-Length. You always need to read the entire response body to check if the copy succeeds.

  • If the copy is successful, you receive a response with information about the copied object.

  • A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. A 200 OK response can contain either a success or an error.

    • If the error occurs before the copy action 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. For example, in a cross-region copy, you may encounter throttling and receive a 200 OK response. For more information, see Resolve the Error 200 response when copying objects to Amazon S3. The 200 OK status code means the copy was accepted, but it doesn\'t mean the copy is complete. Another example is when you disconnect from Amazon S3 before the copy is complete, Amazon S3 might cancel the copy and you may receive a 200 OK response. You must stay connected to Amazon S3 until the entire response is successfully received and processed.

      If you call this API operation directly, make sure to design your application to parse the content of the response and handle it appropriately. If you use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error handling per your configuration settings (including automatically retrying the request as appropriate). If the condition persists, the SDKs throw an exception (or, for the SDKs that don\'t use exceptions, they return an error).

Charge

The copy request charge is based on the storage class and Region that you specify for the destination object. The request can also result in a data retrieval charge for the source if the source storage class bills for data retrieval. If the copy source is in a different region, the data transfer is billed to the copy source account. For pricing information, see Amazon S3 pricing.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to CopyObject:

', 'CreateBucket' => '

This action creates an Amazon S3 bucket. To create an Amazon S3 on Outposts bucket, see CreateBucket .

Creates a new S3 bucket. To create a bucket, you must set up Amazon S3 and have a valid Amazon Web Services Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.

There are two types of buckets: general purpose buckets and directory buckets. For more information about these bucket types, see Creating, configuring, and working with Amazon S3 buckets in the Amazon S3 User Guide.

Permissions

  • General purpose bucket permissions - In addition to the s3:CreateBucket permission, the following permissions are required in a policy when your CreateBucket request includes specific headers:

    • Access control lists (ACLs) - In your CreateBucket request, if you specify an access control list (ACL) and set it to public-read, public-read-write, authenticated-read, or if you explicitly specify any other custom ACLs, both s3:CreateBucket and s3:PutBucketAcl permissions are required. In your CreateBucket request, if you set the ACL to private, or if you don\'t specify any ACLs, only the s3:CreateBucket permission is required.

    • Object Lock - In your CreateBucket request, if you set x-amz-bucket-object-lock-enabled to true, the s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning permissions are required.

    • S3 Object Ownership - If your CreateBucket request includes the x-amz-object-ownership header, then the s3:PutBucketOwnershipControls permission is required.

      To set an ACL on a bucket as part of a CreateBucket request, you must explicitly set S3 Object Ownership for the bucket to a different value than the default, BucketOwnerEnforced. Additionally, if your desired bucket ACL grants public access, you must first create the bucket (without the bucket ACL) and then explicitly disable Block Public Access on the bucket before using PutBucketAcl to set the ACL. If you try to create a bucket with a public ACL, the request will fail.

      For the majority of modern use cases in S3, we recommend that you keep all Block Public Access settings enabled and keep ACLs disabled. If you would like to share data with users outside of your account, you can use bucket policies as needed. For more information, see Controlling ownership of objects and disabling ACLs for your bucket and Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide.

    • S3 Block Public Access - If your specific use case requires granting public access to your S3 resources, you can disable Block Public Access. Specifically, you can create a new bucket with Block Public Access enabled, then separately call the DeletePublicAccessBlock API. To use this operation, you must have the s3:PutBucketPublicAccessBlock permission. For more information about S3 Block Public Access, see Blocking public access to your Amazon S3 storage in the Amazon S3 User Guide.

  • Directory bucket permissions - You must have the s3express:CreateBucket permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    The permissions for ACLs, Object Lock, S3 Object Ownership, and S3 Block Public Access are not supported for directory buckets. For directory buckets, all Block Public Access settings are enabled at the bucket level and S3 Object Ownership is set to Bucket owner enforced (ACLs disabled). These settings can\'t be modified.

    For more information about permissions for creating and working with directory buckets, see Directory buckets in the Amazon S3 User Guide. For more information about supported S3 features for directory buckets, see Features of S3 Express One Zone in the Amazon S3 User Guide.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to CreateBucket:

', 'CreateMultipartUpload' => '

This action 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 in the Amazon S3 User Guide.

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 stops charging you for storing them only after you either complete or abort a multipart upload.

If you have configured a lifecycle rule to abort incomplete multipart uploads, the created multipart upload must be completed within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.

Request signing

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 (Amazon Web Services Signature Version 4) in the Amazon S3 User Guide.

Permissions

  • General purpose bucket permissions - To perform a multipart upload with encryption using an Key Management Service (KMS) KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey actions on the key. The requester must also have permissions for the kms:GenerateDataKey action for the CreateMultipartUpload API. Then, the requester needs permissions for the kms:Decrypt action on the UploadPart and UploadPartCopy APIs. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions and Protecting data using server-side encryption with Amazon Web Services KMS in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Encryption

  • General purpose buckets - 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. Amazon S3 automatically encrypts all new objects that are uploaded to an S3 bucket. When doing a multipart upload, if you don\'t specify encryption information in your request, the encryption setting of the uploaded parts is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with an Key Management Service (KMS) key (SSE-KMS), or a customer-provided encryption key (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the uploaded parts. When you perform a CreateMultipartUpload operation, if you want to use a different type of encryption setting for the uploaded parts, you can request that Amazon S3 encrypts the object with a different encryption key (such as an Amazon S3 managed key, a KMS key, or a customer-provided key). When the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence. 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 CreateMultipartUpload request.

    • Use KMS keys (SSE-KMS) that include the Amazon Web Services managed key (aws/s3) and KMS customer managed keys stored in Key Management Service (KMS) – If you want Amazon Web Services 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 Amazon Web Services managed key (aws/s3 key) in KMS to protect the data.

      • To perform a multipart upload with encryption by using an Amazon Web Services KMS key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey* 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. For more information, see Multipart upload API and permissions and Protecting data using server-side encryption with Amazon Web Services KMS in the Amazon S3 User Guide.

      • If your Identity and Access Management (IAM) user or role is in the same Amazon Web Services account as the KMS key, then you must have these permissions on the key policy. If your IAM user or role is in a different account from the key, then you must have the permissions on both the key policy and your IAM user or role.

      • All GET and PUT requests for an object protected by KMS fail if you don\'t make them by using Secure Sockets Layer (SSL), Transport Layer Security (TLS), or Signature Version 4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

      For more information about server-side encryption with KMS keys (SSE-KMS), see Protecting Data Using Server-Side Encryption with KMS keys in the Amazon S3 User Guide.

    • Use customer-provided encryption keys (SSE-C) – 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 customer-provided encryption keys (SSE-C), see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C) in the Amazon S3 User Guide.

  • Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket\'s default encryption uses the desired encryption configuration and you don\'t override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

    In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, the encryption request headers must match the encryption settings that are specified in the CreateSession request. You can\'t override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) that are specified in the CreateSession request. You don\'t need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket.

    When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket\'s default encryption configuration for the CreateSession request. It\'s not supported to override the encryption settings values in the CreateSession request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the encryption request headers must match the default encryption configuration of the directory bucket.

    For directory buckets, when you perform a CreateMultipartUpload operation and an UploadPartCopy operation, the request headers you provide in the CreateMultipartUpload request must match the default encryption configuration of the destination bucket.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to CreateMultipartUpload:

', 'CreateSession' => '

Creates a session that establishes temporary security credentials to support fast authentication and authorization for the Zonal endpoint API operations on directory buckets. For more information about Zonal endpoint API operations that include the Availability Zone in the request endpoint, see S3 Express One Zone APIs in the Amazon S3 User Guide.

To make Zonal endpoint API requests on a directory bucket, use the CreateSession API operation. Specifically, you grant s3express:CreateSession permission to a bucket in a bucket policy or an IAM identity-based policy. Then, you use IAM credentials to make the CreateSession API request on the bucket, which returns temporary security credentials that include the access key ID, secret access key, session token, and expiration. These credentials have associated permissions to access the Zonal endpoint API operations. After the session is created, you don’t need to use other policies to grant permissions to each Zonal endpoint API individually. Instead, in your Zonal endpoint API requests, you sign your requests by applying the temporary security credentials of the session to the request headers and following the SigV4 protocol for authentication. You also apply the session token to the x-amz-s3session-token request header for authorization. Temporary security credentials are scoped to the bucket and expire after 5 minutes. After the expiration time, any calls that you make with those credentials will fail. You must use IAM credentials again to make a CreateSession API request that generates a new set of temporary credentials for use. Temporary credentials cannot be extended or refreshed beyond the original specified interval.

If you use Amazon Web Services SDKs, SDKs handle the session token refreshes automatically to avoid service interruptions when a session expires. We recommend that you use the Amazon Web Services SDKs to initiate and manage requests to the CreateSession API. For more information, see Performance guidelines and design patterns in the Amazon S3 User Guide.

Permissions

To obtain temporary security credentials, you must create a bucket policy or an IAM identity-based policy that grants s3express:CreateSession permission to the bucket. In a policy, you can have the s3express:SessionMode condition key to control who can create a ReadWrite or ReadOnly session. For more information about ReadWrite or ReadOnly sessions, see x-amz-create-session-mode . For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.

To grant cross-account access to Zonal endpoint API operations, the bucket policy should also grant both accounts the s3express:CreateSession permission.

If you want to encrypt objects with SSE-KMS, you must also have the kms:GenerateDataKey and the kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the target KMS key.

Encryption

For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket\'s default encryption uses the desired encryption configuration and you don\'t override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.

For Zonal endpoint (object-level) API operations except CopyObject and UploadPartCopy, you authenticate and authorize requests through CreateSession for low latency. To encrypt new objects in a directory bucket with SSE-KMS, you must specify SSE-KMS as the directory bucket\'s default encryption configuration with a KMS key (specifically, a customer managed key). Then, when a session is created for Zonal endpoint API operations, new objects are automatically encrypted and decrypted with SSE-KMS and S3 Bucket Keys during the session.

Only 1 customer managed key is supported per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn\'t supported. After you specify SSE-KMS as your bucket\'s default encryption configuration with a customer managed key, you can\'t change the customer managed key for the bucket\'s SSE-KMS configuration.

In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST API, you can\'t override the values of the encryption settings (x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id, x-amz-server-side-encryption-context, and x-amz-server-side-encryption-bucket-key-enabled) from the CreateSession request. You don\'t need to explicitly specify these encryption settings values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the CreateSession request to protect new objects in the directory bucket.

When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use the bucket\'s default encryption configuration for the CreateSession request. It\'s not supported to override the encryption settings values in the CreateSession request. Also, in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), it\'s not supported to override the values of the encryption settings from the CreateSession request.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

', 'DeleteBucket' => '

Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.

Permissions

  • General purpose bucket permissions - You must have the s3:DeleteBucket permission on the specified bucket in a policy.

  • Directory bucket permissions - You must have the s3express:DeleteBucket permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to DeleteBucket:

', 'DeleteBucketAnalyticsConfiguration' => '

This operation is not supported for directory buckets.

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:

', 'DeleteBucketCors' => '

This operation is not supported for directory buckets.

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 S3 User Guide.

Related Resources

', 'DeleteBucketEncryption' => '

This implementation of the DELETE action resets the default encryption for the bucket as server-side encryption with Amazon S3 managed keys (SSE-S3).

Permissions

  • General purpose bucket permissions - The s3:PutEncryptionConfiguration permission is required in a policy. 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 Operations and Managing Access Permissions to Your Amazon S3 Resources.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutEncryptionConfiguration permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to DeleteBucketEncryption:

', 'DeleteBucketIntelligentTieringConfiguration' => '

This operation is not supported for directory buckets.

Deletes the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to DeleteBucketIntelligentTieringConfiguration include:

', 'DeleteBucketInventoryConfiguration' => '

This operation is not supported for directory buckets.

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:

', 'DeleteBucketLifecycle' => '

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

Permissions

  • General purpose bucket permissions - By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must have the s3:PutLifecycleConfiguration permission.

    For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

  • Directory bucket permissions - You must have the s3express:PutLifecycleConfiguration permission in an IAM identity-based policy to use this operation. Cross-account access to this API operation isn\'t supported. The resource owner can optionally grant access permissions to others by creating a role or user for them as long as they are within the same account as the owner and resource.

    For more information about directory bucket policies and permissions, see Authorizing Regional endpoint APIs with IAM in the Amazon S3 User Guide.

    Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

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

Related actions include:

', 'DeleteBucketMetricsConfiguration' => '

This operation is not supported for directory buckets.

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:

', 'DeleteBucketOwnershipControls' => '

This operation is not supported for directory buckets.

Removes OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to DeleteBucketOwnershipControls:

', 'DeleteBucketPolicy' => '

Deletes the policy of a specified bucket.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

If you are using an identity other than the root user of the Amazon Web Services account that owns the bucket, the calling identity must both 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 not using an identity that belongs to the bucket owner\'s account, Amazon S3 returns a 405 Method Not Allowed error.

To ensure that bucket owners don\'t inadvertently lock themselves out of their own buckets, the root principal in a bucket owner\'s Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal\'s access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

  • General purpose bucket permissions - The s3:DeleteBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:DeleteBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to DeleteBucketPolicy

', 'DeleteBucketReplication' => '

This operation is not supported for directory buckets.

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 User Guide.

The following operations are related to DeleteBucketReplication:

', 'DeleteBucketTagging' => '

This operation is not supported for directory buckets.

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:

', 'DeleteBucketWebsite' => '

This operation is not supported for directory buckets.

This action 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 action 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:

', 'DeleteObject' => '

Removes an object from a bucket. The behavior depends on the bucket\'s versioning state. For more information, see Best practices to consider before deleting an object.

To remove a specific version, you must use the versionId query parameter. Using this query parameter 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 and to see example requests, see Using MFA delete and Sample request in the Amazon S3 User Guide.

Permissions

  • General purpose bucket permissions - The following permissions are required in your policies when your DeleteObjects request includes specific headers.

    • s3:DeleteObject - To delete an object from a bucket, you must always have the s3:DeleteObject permission.

      You can also use PutBucketLifecycle to delete objects in Amazon S3.

    • s3:DeleteObjectVersion - To delete a specific version of an object from a versioning-enabled bucket, you must have the s3:DeleteObjectVersion permission.

    • 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 permissions.

  • Directory buckets permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following action is related to DeleteObject:

', 'DeleteObjectTagging' => '

This operation is not supported for directory buckets.

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 DeleteObjectTagging:

', '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 can contain 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 in a quiet mode, the operation does not return any information about the delete in the response body.

When performing this action 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 in the Amazon S3 User Guide.

Directory buckets - MFA delete is not supported by directory buckets.
Permissions

  • General purpose bucket permissions - The following permissions are required in your policies when your DeleteObjects request includes specific headers.

    • s3:DeleteObject - To delete an object from a bucket, you must always specify the s3:DeleteObject permission.

    • s3:DeleteObjectVersion - To delete a specific version of an object from a versioning-enabled bucket, you must specify the s3:DeleteObjectVersion permission.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Content-MD5 request header

  • General purpose bucket - The Content-MD5 request 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.

  • Directory bucket - The Content-MD5 request header or a additional checksum request header (including x-amz-checksum-crc32, x-amz-checksum-crc32c, x-amz-checksum-sha1, or x-amz-checksum-sha256) is required for all Multi-Object Delete requests.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to DeleteObjects:

', 'DeletePublicAccessBlock' => '

This operation is not supported for directory buckets.

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 DeletePublicAccessBlock:

', 'GetBucketAccelerateConfiguration' => '

This operation is not supported for directory buckets.

This implementation of the GET action 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 S3 User 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 S3 User Guide.

The following operations are related to GetBucketAccelerateConfiguration:

', 'GetBucketAcl' => '

This operation is not supported for directory buckets.

This implementation of the GET action uses the acl subresource to return the access control list (ACL) of a bucket. To use GET to return the ACL of the bucket, you must have the READ_ACP access to the bucket. If READ_ACP permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

The following operations are related to GetBucketAcl:

', 'GetBucketAnalyticsConfiguration' => '

This operation is not supported for directory buckets.

This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration 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 S3 User Guide.

For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon S3 User Guide.

The following operations are related to GetBucketAnalyticsConfiguration:

', 'GetBucketCors' => '

This operation is not supported for directory buckets.

Returns the Cross-Origin Resource Sharing (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.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

For more information about CORS, see Enabling Cross-Origin Resource Sharing.

The following operations are related to GetBucketCors:

', 'GetBucketEncryption' => '

Returns the default encryption configuration for an Amazon S3 bucket. By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3).

Permissions

  • General purpose bucket permissions - The s3:GetEncryptionConfiguration permission is required in a policy. 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 Operations and Managing Access Permissions to Your Amazon S3 Resources.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:GetEncryptionConfiguration permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to GetBucketEncryption:

', 'GetBucketIntelligentTieringConfiguration' => '

This operation is not supported for directory buckets.

Gets the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to GetBucketIntelligentTieringConfiguration include:

', 'GetBucketInventoryConfiguration' => '

This operation is not supported for directory buckets.

Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration 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.

For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.

The following operations are related to GetBucketInventoryConfiguration:

', '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.

This operation is not supported for directory buckets.

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:

The following operations are related to GetBucketLifecycle:

', 'GetBucketLifecycleConfiguration' => '

Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.

Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API, which is compatible with the new functionality. The previous version of the API supported filtering based only on an object key name prefix, which is supported for general purpose buckets for backward compatibility. For the related API description, see GetBucketLifecycle.

Lifecyle configurations for directory buckets only support expiring objects and cancelling multipart uploads. Expiring of versioned objects, transitions and tag filters are not supported.
Permissions

  • General purpose bucket permissions - By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must have the s3:GetLifecycleConfiguration permission.

    For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.

  • Directory bucket permissions - You must have the s3express:GetLifecycleConfiguration permission in an IAM identity-based policy to use this operation. Cross-account access to this API operation isn\'t supported. The resource owner can optionally grant access permissions to others by creating a role or user for them as long as they are within the same account as the owner and resource.

    For more information about directory bucket policies and permissions, see Authorizing Regional endpoint APIs with IAM in the Amazon S3 User Guide.

    Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

GetBucketLifecycleConfiguration has the following special error:

The following operations are related to GetBucketLifecycleConfiguration:

', 'GetBucketLocation' => '

This operation is not supported for directory buckets.

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.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

We recommend that you use HeadBucket to return the Region that a bucket resides in. For backward compatibility, Amazon S3 continues to support GetBucketLocation.

The following operations are related to GetBucketLocation:

', 'GetBucketLogging' => '

This operation is not supported for directory buckets.

Returns the logging status of a bucket and the permissions users have to view and modify that status.

The following operations are related to GetBucketLogging:

', 'GetBucketMetricsConfiguration' => '

This operation is not supported for directory buckets.

Gets a metrics configuration (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:GetMetricsConfiguration 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 GetBucketMetricsConfiguration:

', 'GetBucketNotification' => '

This operation is not supported for directory buckets.

No longer used, see GetBucketNotificationConfiguration.

', 'GetBucketNotificationConfiguration' => '

This operation is not supported for directory buckets.

Returns the notification configuration of a bucket.

If notifications are not enabled on the bucket, the action returns an empty NotificationConfiguration element.

By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the s3:GetBucketNotification permission.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.

The following action is related to GetBucketNotification:

', 'GetBucketOwnershipControls' => '

This operation is not supported for directory buckets.

Retrieves OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:GetBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see Using Object Ownership.

The following operations are related to GetBucketOwnershipControls:

', 'GetBucketPolicy' => '

Returns the policy of a specified bucket.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

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

If you don\'t have GetBucketPolicy 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.

To ensure that bucket owners don\'t inadvertently lock themselves out of their own buckets, the root principal in a bucket owner\'s Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal\'s access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

  • General purpose bucket permissions - The s3:GetBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:GetBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

Example bucket policies

General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.

Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following action is related to GetBucketPolicy:

', 'GetBucketPolicyStatus' => '

This operation is not supported for directory buckets.

Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the s3:GetBucketPolicyStatus permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy.

For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".

The following operations are related to GetBucketPolicyStatus:

', 'GetBucketReplication' => '

This operation is not supported for directory buckets.

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 S3 User Guide.

This action 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 List of replication-related error codes

The following operations are related to GetBucketReplication:

', 'GetBucketRequestPayment' => '

This operation is not supported for directory buckets.

Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets.

The following operations are related to GetBucketRequestPayment:

', 'GetBucketTagging' => '

This operation is not supported for directory buckets.

Returns the tag set associated with the bucket.

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

GetBucketTagging has the following special error:

The following operations are related to GetBucketTagging:

', 'GetBucketVersioning' => '

This operation is not supported for directory buckets.

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:

', 'GetBucketWebsite' => '

This operation is not supported for directory buckets.

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 action 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 GetBucketWebsite:

', 'GetObject' => '

Retrieves an object from Amazon S3.

In the GetObject request, specify the full key name for the object.

General purpose buckets - Both the virtual-hosted-style requests and the path-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg, specify the object key name 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 object key name as /examplebucket/photos/2006/February/sample.jpg. For more information about request types, see HTTP Host Header Bucket Specification in the Amazon S3 User Guide.

Directory buckets - Only virtual-hosted-style requests are supported. For a virtual hosted-style request example, if you have the object photos/2006/February/sample.jpg in the bucket named examplebucket--use1-az5--x-s3, specify the object key name as /photos/2006/February/sample.jpg. Also, when you make requests to this API operation, your requests are sent to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

Permissions

  • General purpose bucket permissions - You must have the required permissions in a policy. To use GetObject, you must have the READ access to the object (or version). If you grant READ access to the anonymous user, the GetObject operation returns the object without using an authorization header. For more information, see Specifying permissions in a policy in the Amazon S3 User Guide.

    If you include a versionId in your request header, you must have the s3:GetObjectVersion permission to access a specific version of an object. The s3:GetObject permission is not required in this scenario.

    If you request the current version of an object without a specific versionId in the request header, only the s3:GetObject permission is required. The s3:GetObjectVersion permission is not required in this scenario.

    If the object that you request doesn’t exist, the error that 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 Not Found error.

    • If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Access Denied error.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If the object is encrypted using SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

Storage classes

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects in the Amazon S3 User Guide.

Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. Unsupported storage class values won\'t write a destination object and will respond with the HTTP status code 400 Bad Request.

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for the GetObject requests, if your object uses server-side encryption with Amazon S3 managed encryption keys (SSE-S3), server-side encryption with Key Management Service (KMS) keys (SSE-KMS), or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS). If you include the header in your GetObject requests for the object that uses these types of keys, you’ll get an HTTP 400 Bad Request error.

Directory buckets - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn\'t supported. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

Overriding response header values through the request

There are times when you want to override certain response header values of a GetObject response. For example, you might override the Content-Disposition response header value through your GetObject request.

You can override values for a set of response headers. These modified response header values are included only in a successful response, that is, when the HTTP status code 200 OK is returned. The headers you can override using the following query parameters in the request are a subset of the headers that Amazon S3 accepts when you create an object.

The response headers that you can override for the GetObject response are Cache-Control, Content-Disposition, Content-Encoding, Content-Language, Content-Type, and Expires.

To override values for a set of response headers in the GetObject response, you can use the following query parameters in the request.

  • response-cache-control

  • response-content-disposition

  • response-content-encoding

  • response-content-language

  • response-content-type

  • response-expires

When you use these parameters, you must sign the request by using either an Authorization header or a presigned URL. These parameters cannot be used with an unsigned (anonymous) request.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to GetObject:

', 'GetObjectAcl' => '

This operation is not supported for directory buckets.

Returns the access control list (ACL) of an object. To use this operation, you must have s3:GetObjectAcl permissions or READ_ACP access to the object. For more information, see Mapping of ACL permissions and access policy permissions in the Amazon S3 User Guide

This functionality is not supported for Amazon S3 on Outposts.

By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, requests to read ACLs are still supported and return the bucket-owner-full-control ACL with the owner being the account that created the bucket. For more information, see Controlling object ownership and disabling ACLs in the Amazon S3 User Guide.

The following operations are related to GetObjectAcl:

', 'GetObjectAttributes' => '

Retrieves all the metadata from an object without returning the object itself. This operation is useful if you\'re interested only in an object\'s metadata.

GetObjectAttributes combines the functionality of HeadObject and ListParts. All of the data returned with each of those individual calls can be returned with a single call to GetObjectAttributes.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - To use GetObjectAttributes, you must have READ access to the object. The permissions that you need to use this operation depend on whether the bucket is versioned. If the bucket is versioned, you need both the s3:GetObjectVersion and s3:GetObjectVersionAttributes permissions for this operation. If the bucket is not versioned, you need the s3:GetObject and s3:GetObjectAttributes permissions. For more information, see Specifying Permissions in a Policy in the Amazon S3 User Guide. If the object that 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 Not Found ("no such key") error.

    • If you don\'t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden ("access denied") error.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a GET request for an object that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It\'s because the encryption method can\'t be changed when you retrieve the object.

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 to provide the encryption key for the server to be able to retrieve the object\'s metadata. The headers are:

  • 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) in the Amazon S3 User Guide.

Directory bucket permissions - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket\'s default encryption uses the desired encryption configuration and you don\'t override the bucket default encryption in your CreateSession requests or PUT object requests. Then, new objects are automatically encrypted with the desired encryption settings. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
Versioning

Directory buckets - S3 Versioning isn\'t enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

Conditional request headers

Consider the following when using request headers:

  • If both of the If-Match and If-Unmodified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 200 OK and the data requested:

    • If-Match condition evaluates to true.

    • If-Unmodified-Since condition evaluates to false.

    For more information about conditional requests, see RFC 7232.

  • If both of the If-None-Match and If-Modified-Since headers are present in the request as follows, then Amazon S3 returns the HTTP status code 304 Not Modified:

    • If-None-Match condition evaluates to false.

    • If-Modified-Since condition evaluates to true.

    For more information about conditional requests, see RFC 7232.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following actions are related to GetObjectAttributes:

', 'GetObjectLegalHold' => '

This operation is not supported for directory buckets.

Gets an object\'s current legal hold status. For more information, see Locking Objects.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to GetObjectLegalHold:

', 'GetObjectLockConfiguration' => '

This operation is not supported for directory buckets.

Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

The following action is related to GetObjectLockConfiguration:

', 'GetObjectRetention' => '

This operation is not supported for directory buckets.

Retrieves an object\'s retention settings. For more information, see Locking Objects.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to GetObjectRetention:

', 'GetObjectTagging' => '

This operation is not supported for directory buckets.

Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.

To use this operation, you must have permission to perform the s3:GetObjectTagging action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the s3:GetObjectVersionTagging action.

By default, the bucket owner has this permission and can grant this permission to others.

For information about the Amazon S3 object tagging feature, see Object Tagging.

The following actions are related to GetObjectTagging:

', 'GetObjectTorrent' => '

This operation is not supported for directory buckets.

Returns torrent files from a bucket. BitTorrent can save you bandwidth when you\'re distributing large files.

You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.

To use GET, you must have READ access to the object.

This functionality is not supported for Amazon S3 on Outposts.

The following action is related to GetObjectTorrent:

', 'GetPublicAccessBlock' => '

This operation is not supported for directory buckets.

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:

', 'HeadBucket' => '

You can use this operation to determine if a bucket exists and if you have permission to access it. The action returns a 200 OK if the bucket exists and you have permission to access it.

If the bucket does not exist or you do not have permission to access it, the HEAD request returns a generic 400 Bad Request, 403 Forbidden or 404 Not Found code. A message body is not included, so you cannot determine the exception beyond these HTTP response codes.
Authentication and authorization

General purpose buckets - Request to public buckets that grant the s3:ListBucket permission publicly do not need to be signed. All other HeadBucket requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.

Directory buckets - You must use IAM credentials to authenticate and authorize your access to the HeadBucket API operation, instead of using the temporary security credentials through the CreateSession API operation.

Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.

Permissions

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

You must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
', 'HeadObject' => '

The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you\'re interested only in an object\'s metadata.

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. Because of this, if the HEAD request generates an error, it returns a generic code, such as 400 Bad Request, 403 Forbidden, 404 Not Found, 405 Method Not Allowed, 412 Precondition Failed, or 304 Not Modified. It\'s not possible to retrieve the exact exception of these error codes.

Request headers are limited to 8 KB in size. For more information, see Common Request Headers.

Permissions

  • General purpose bucket permissions - To use HEAD, you must have the s3:GetObject permission. You need the relevant read object (or version) permission for this operation. For more information, see Actions, resources, and condition keys for Amazon S3 in the Amazon S3 User Guide. For more information about the permissions to S3 API operations by S3 resource types, see Required permissions for Amazon S3 API operations in the Amazon S3 User Guide.

    If the object you request doesn\'t exist, the error that 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 Not Found error.

    • If you don’t have the s3:ListBucket permission, Amazon S3 returns an HTTP status code 403 Forbidden error.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If you enable x-amz-checksum-mode in the request and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

Encryption

Encryption request headers, like x-amz-server-side-encryption, should not be sent for HEAD requests if your object uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with Amazon S3 managed encryption keys (SSE-S3). The x-amz-server-side-encryption header is used when you PUT an object to S3 and want to specify the encryption method. If you include this header in a HEAD request for an object that uses these types of keys, you’ll get an HTTP 400 Bad Request error. It\'s because the encryption method can\'t be changed when you retrieve the object.

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 to provide the encryption key for the server to be able to retrieve the object\'s metadata. The headers are:

  • 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) in the Amazon S3 User Guide.

Directory bucket - For directory buckets, there are only two supported options for server-side encryption: SSE-S3 and SSE-KMS. SSE-C isn\'t supported. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

Versioning

  • 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.

  • If the specified version is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

  • Directory buckets - Delete marker is not supported for directory buckets.

  • Directory buckets - S3 Versioning isn\'t enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.
HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

The following actions are related to HeadObject:

', 'ListBucketAnalyticsConfigurations' => '

This operation is not supported for directory buckets.

Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. You should always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there will be a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration 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 ListBucketAnalyticsConfigurations:

', 'ListBucketIntelligentTieringConfigurations' => '

This operation is not supported for directory buckets.

Lists the S3 Intelligent-Tiering configuration from the specified bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to ListBucketIntelligentTieringConfigurations include:

', 'ListBucketInventoryConfigurations' => '

This operation is not supported for directory buckets.

Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration 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

The following operations are related to ListBucketInventoryConfigurations:

', 'ListBucketMetricsConfigurations' => '

This operation is not supported for directory buckets.

Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.

This action supports list pagination and does not return more than 100 configurations at a time. Always check the IsTruncated element in the response. If there are no more configurations to list, IsTruncated is set to false. If there are more configurations to list, IsTruncated is set to true, and there is a value in NextContinuationToken. You use the NextContinuationToken value to continue the pagination of the list by passing the value in continuation-token in the request to GET the next page.

To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration 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 more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.

The following operations are related to ListBucketMetricsConfigurations:

', 'ListBuckets' => '

This operation is not supported for directory buckets.

Returns a list of all buckets owned by the authenticated sender of the request. To grant IAM permission to use this operation, you must add the s3:ListAllMyBuckets policy action.

For information about Amazon S3 buckets, see Creating, configuring, and working with Amazon S3 buckets.

We strongly recommend using only paginated ListBuckets requests. Unpaginated ListBuckets requests are only supported for Amazon Web Services accounts set to the default general purpose bucket quota of 10,000. If you have an approved general purpose bucket quota above 10,000, you must send paginated ListBuckets requests to list your account’s buckets. All unpaginated ListBuckets requests will be rejected for Amazon Web Services accounts with a general purpose bucket quota greater than 10,000.

', 'ListDirectoryBuckets' => '

Returns a list of all Amazon S3 directory buckets owned by the authenticated sender of the request. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

You must have the s3express:ListAllMyDirectoryBuckets permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The BucketRegion response element is not part of the ListDirectoryBuckets Response Syntax.

', 'ListMultipartUploads' => '

This operation lists in-progress multipart uploads in a bucket. An in-progress multipart upload is a multipart upload that has been initiated by the CreateMultipartUpload request, but has not yet been completed or aborted.

Directory buckets - If multipart uploads in a directory bucket are in progress, you can\'t delete the bucket until all the in-progress multipart uploads are aborted or completed. To delete these in-progress multipart uploads, use the ListMultipartUploads operation to list the in-progress multipart uploads in the bucket and use the AbortMultipartUpload operation to abort all the in-progress multipart uploads.

The ListMultipartUploads operation returns a maximum of 1,000 multipart uploads in the response. The limit of 1,000 multipart uploads is also the default value. You can further limit the number of uploads in a response by specifying the max-uploads request parameter. If there are more than 1,000 multipart uploads that satisfy your ListMultipartUploads request, the response returns an IsTruncated element with the value of true, a NextKeyMarker element, and a NextUploadIdMarker element. To list the remaining multipart uploads, you need to make subsequent ListMultipartUploads requests. In these requests, include two query parameters: key-marker and upload-id-marker. Set the value of key-marker to the NextKeyMarker value from the previous response. Similarly, set the value of upload-id-marker to the NextUploadIdMarker value from the previous response.

Directory buckets - The upload-id-marker element and the NextUploadIdMarker element aren\'t supported by directory buckets. To list the additional multipart uploads, you only need to set the value of key-marker to the NextKeyMarker value from the previous response.

For more information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Sorting of multipart uploads in response

  • General purpose bucket - In the ListMultipartUploads response, the multipart uploads are sorted based on two criteria:

    • Key-based sorting - Multipart uploads are initially sorted in ascending order based on their object keys.

    • Time-based sorting - For uploads that share the same object key, they are further sorted in ascending order based on the upload initiation time. Among uploads with the same key, the one that was initiated first will appear before the ones that were initiated later.

  • Directory bucket - In the ListMultipartUploads response, the multipart uploads aren\'t sorted lexicographically based on the object keys.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to ListMultipartUploads:

', 'ListObjectVersions' => '

This operation is not supported for directory buckets.

Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.

To use this operation, you must have permission to perform the s3:ListBucketVersions action. Be aware of the name difference.

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.

The following operations are related to ListObjectVersions:

', 'ListObjects' => '

This operation is not supported for directory buckets.

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 action 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:

', 'ListObjectsV2' => '

Returns some or all (up to 1,000) of the objects in a bucket with each request. 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. For more information about listing objects, see Listing object keys programmatically in the Amazon S3 User Guide. To get a list of your buckets, see ListBuckets.

Permissions

  • General purpose bucket permissions - To use this operation, you must have READ access to the bucket. You must have permission 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 in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

Sorting order of returned objects

  • General purpose bucket - For general purpose buckets, ListObjectsV2 returns objects in lexicographical order based on their key names.

  • Directory bucket - For directory buckets, ListObjectsV2 does not return objects in lexicographical order.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

This section describes the latest revision of this action. We recommend that you use this revised API operation for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API operation, ListObjects.

The following operations are related to ListObjectsV2:

', 'ListParts' => '

Lists the parts that have been uploaded for a specific multipart upload.

To use this operation, you must provide the upload ID in the request. You obtain this uploadID by sending the initiate multipart upload request through CreateMultipartUpload.

The ListParts request returns a maximum of 1,000 uploaded parts. The limit of 1,000 parts is also the default value. You can restrict the number of parts in a response by specifying the max-parts request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an IsTruncated field with the value of true, and a NextPartNumberMarker element. To list remaining uploaded parts, in subsequent ListParts requests, include the part-number-marker query string parameter and set its value to the NextPartNumberMarker field value from the previous response.

For more information on multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions in the Amazon S3 User Guide.

    If the upload was created using server-side encryption with Key Management Service (KMS) keys (SSE-KMS) or dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), you must have permission to the kms:Decrypt action for the ListParts request to succeed.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to ListParts:

', 'PutBucketAccelerateConfiguration' => '

This operation is not supported for directory buckets.

Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3.

To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration 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.

The Transfer Acceleration state of a bucket can be set to one of the following two values:

The GetBucketAccelerateConfiguration action returns the transfer acceleration state of a bucket.

After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase.

The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods (".").

For more information about transfer acceleration, see Transfer Acceleration.

The following operations are related to PutBucketAccelerateConfiguration:

', 'PutBucketAcl' => '

This operation is not supported for directory buckets.

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 the WRITE_ACP permission.

You can use one of the following two ways to set a bucket\'s permissions:

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.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide.
Permissions

You can set access permissions by 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 (Amazon Web Services 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:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    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 Amazon Web Services accounts identified by their email addresses.

    x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"

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 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>

  • 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.

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

The following operations are related to PutBucketAcl:

', 'PutBucketAnalyticsConfiguration' => '

This operation is not supported for directory buckets.

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.

PutBucketAnalyticsConfiguration has the following special errors:

The following operations are related to PutBucketAnalyticsConfiguration:

', 'PutBucketCors' => '

This operation is not supported for directory buckets.

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:

For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon S3 User Guide.

The following operations are related to PutBucketCors:

', 'PutBucketEncryption' => '

This operation configures default encryption and Amazon S3 Bucket Keys for an existing bucket.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

By default, all buckets have a default encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3).

If you\'re specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that\'s encrypted with a KMS key that belongs to the requester, and not the bucket owner.

Also, this action requires Amazon Web Services Signature Version 4. For more information, see Authenticating Requests (Amazon Web Services Signature Version 4).

Permissions

  • General purpose bucket permissions - The s3:PutEncryptionConfiguration permission is required in a policy. 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 Operations and Managing Access Permissions to Your Amazon S3 Resources in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutEncryptionConfiguration permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

    To set a directory bucket default encryption with SSE-KMS, you must also have the kms:GenerateDataKey and the kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the target KMS key.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to PutBucketEncryption:

', 'PutBucketIntelligentTieringConfiguration' => '

This operation is not supported for directory buckets.

Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket.

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without performance impact or operational overhead. S3 Intelligent-Tiering delivers automatic cost savings in three low latency and high throughput access tiers. To get the lowest storage cost on data that can be accessed in minutes to hours, you can choose to activate additional archiving capabilities.

The S3 Intelligent-Tiering storage class is the ideal storage class for data with unknown, changing, or unpredictable access patterns, independent of object size or retention period. If the size of an object is less than 128 KB, it is not monitored and not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the Frequent Access tier rates in the S3 Intelligent-Tiering storage class.

For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.

Operations related to PutBucketIntelligentTieringConfiguration include:

You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier.

PutBucketIntelligentTieringConfiguration has the following special errors:

HTTP 400 Bad Request Error

Code: InvalidArgument

Cause: Invalid Argument

HTTP 400 Bad Request Error

Code: TooManyConfigurations

Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

HTTP 403 Forbidden Error

Cause: You are not the owner of the specified bucket, or you do not have the s3:PutIntelligentTieringConfiguration bucket permission to set the configuration on the bucket.

', 'PutBucketInventoryConfiguration' => '

This operation is not supported for directory buckets.

This implementation of the PUT action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.

Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same Amazon Web Services Region as the source bucket.

When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon S3 User Guide.

You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
Permissions

To use this operation, you must have permission to perform the s3:PutInventoryConfiguration action. The bucket owner has this permission by default and can grant this permission to others.

The s3:PutInventoryConfiguration permission allows a user to create an S3 Inventory report that includes all object metadata fields available and to specify the destination bucket to store the inventory. A user with read access to objects in the destination bucket can also access all object metadata fields that are available in the inventory report.

To restrict access to an inventory report, see Restricting access to an Amazon S3 Inventory report in the Amazon S3 User Guide. For more information about the metadata fields available in S3 Inventory, see Amazon S3 Inventory lists in the Amazon S3 User Guide. For more information about permissions, see Permissions related to bucket subresource operations and Identity and access management in Amazon S3 in the Amazon S3 User Guide.

PutBucketInventoryConfiguration has the following special errors:

HTTP 400 Bad Request Error

Code: InvalidArgument

Cause: Invalid Argument

HTTP 400 Bad Request Error

Code: TooManyConfigurations

Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.

HTTP 403 Forbidden Error

Cause: You are not the owner of the specified bucket, or you do not have the s3:PutInventoryConfiguration bucket permission to set the configuration on the bucket.

The following operations are related to PutBucketInventoryConfiguration:

', 'PutBucketLifecycle' => '

For an updated version of this API, see PutBucketLifecycleConfiguration. This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API.

This operation is not supported for directory buckets.

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management in the Amazon S3 User Guide.

By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the Amazon Web Services account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the s3:PutLifecycleConfiguration permission.

You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources in the Amazon S3 User Guide.

For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration.

The following operations are related to PutBucketLifecycle:

', 'PutBucketLifecycleConfiguration' => '

Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. Keep in mind that this will overwrite an existing lifecycle configuration, so if you want to retain any configuration details, they must be included in the new lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle.

Rules
Permissions
HTTP Host header syntax

You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. An Amazon S3 Lifecycle configuration can have up to 1,000 rules. This limit is not adjustable.

Bucket lifecycle configuration supports specifying a lifecycle rule using an object key name prefix, one or more object tags, object size, or any combination of these. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility for general purpose buckets. For the related API description, see PutBucketLifecycle.

Lifecyle configurations for directory buckets only support expiring objects and cancelling multipart uploads. Expiring of versioned objects,transitions and tag filters are not supported.

A lifecycle rule consists of the following:

  • A filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, object size, or any combination of these.

  • A status indicating whether the rule is in effect.

  • One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.

For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.

  • General purpose bucket permissions - By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the Amazon Web Services account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must have the s3:PutLifecycleConfiguration permission.

    You can also explicitly deny permissions. An explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:

  • Directory bucket permissions - You must have the s3express:PutLifecycleConfiguration permission in an IAM identity-based policy to use this operation. Cross-account access to this API operation isn\'t supported. The resource owner can optionally grant access permissions to others by creating a role or user for them as long as they are within the same account as the owner and resource.

    For more information about directory bucket policies and permissions, see Authorizing Regional endpoint APIs with IAM in the Amazon S3 User Guide.

    Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to PutBucketLifecycleConfiguration:

', 'PutBucketLogging' => '

This operation is not supported for directory buckets.

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 Amazon Web Services 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.

If the target bucket for log delivery uses the bucket owner enforced setting for S3 Object Ownership, you can\'t use the Grantee request element to grant access to others. Permissions can only be granted using policies. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.
Grantee Values

You can specify the person (grantee) to whom you\'re assigning access rights (by 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 GETObjectAcl 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 in the Amazon S3 User Guide.

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:

', 'PutBucketMetricsConfiguration' => '

This operation is not supported for directory buckets.

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:

PutBucketMetricsConfiguration has the following special error:

', 'PutBucketNotification' => '

This operation is not supported for directory buckets.

No longer used, see the PutBucketNotificationConfiguration operation.

', 'PutBucketNotificationConfiguration' => '

This operation is not supported for directory buckets.

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 action 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 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.

For more information about the number of event notification configurations that you can create per bucket, see Amazon S3 service quotas in Amazon Web Services General Reference.

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 the required 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 action will fail, and Amazon S3 will not add the configuration to your bucket.

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 action is related to PutBucketNotificationConfiguration:

', 'PutBucketOwnershipControls' => '

This operation is not supported for directory buckets.

Creates or modifies OwnershipControls for an Amazon S3 bucket. To use this operation, you must have the s3:PutBucketOwnershipControls permission. For more information about Amazon S3 permissions, see Specifying permissions in a policy.

For information about Amazon S3 Object Ownership, see Using object ownership.

The following operations are related to PutBucketOwnershipControls:

', 'PutBucketPolicy' => '

Applies an Amazon S3 bucket policy to an Amazon S3 bucket.

Directory buckets - For directory buckets, you must make requests for this API operation to the Regional endpoint. These endpoints support path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

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

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

To ensure that bucket owners don\'t inadvertently lock themselves out of their own buckets, the root principal in a bucket owner\'s Amazon Web Services account can perform the GetBucketPolicy, PutBucketPolicy, and DeleteBucketPolicy API actions, even if their bucket policy explicitly denies the root principal\'s access. Bucket owner root principals can only be blocked from performing these API actions by VPC endpoint policies and Amazon Web Services Organizations policies.

  • General purpose bucket permissions - The s3:PutBucketPolicy permission is required in a policy. For more information about general purpose buckets bucket policies, see Using Bucket Policies and User Policies in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation, you must have the s3express:PutBucketPolicy permission in an IAM identity-based policy instead of a bucket policy. Cross-account access to this API operation isn\'t supported. This operation can only be performed by the Amazon Web Services account that owns the resource. For more information about directory bucket policies and permissions, see Amazon Web Services Identity and Access Management (IAM) for S3 Express One Zone in the Amazon S3 User Guide.

Example bucket policies

General purpose buckets example bucket policies - See Bucket policy examples in the Amazon S3 User Guide.

Directory bucket example bucket policies - See Example bucket policies for S3 Express One Zone in the Amazon S3 User Guide.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is s3express-control.region.amazonaws.com.

The following operations are related to PutBucketPolicy:

', 'PutBucketReplication' => '

This operation is not supported for directory buckets.

Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 User Guide.

Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets 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. You can invoke this request for a specific Amazon Web Services Region by using the aws:RequestedRegion condition key.

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.

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.

If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.

For information about enabling versioning on a bucket, see Using Versioning.

Handling Replication of Encrypted Objects

By default, Amazon S3 doesn\'t replicate objects that are stored at rest using server-side encryption with KMS keys. To replicate Amazon Web Services KMS-encrypted objects, add the following: SourceSelectionCriteria, SseKmsEncryptedObjects, Status, EncryptionConfiguration, and ReplicaKmsKeyID. For information about replication configuration, see Replicating Objects Created with SSE Using KMS keys.

For information on PutBucketReplication errors, see List of replication-related error codes

Permissions

To create a PutBucketReplication request, you must have s3:PutReplicationConfiguration permissions for the bucket.

By default, a resource owner, in this case the Amazon Web Services 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.

To perform this operation, the user or role performing the action must have the iam:PassRole permission.

The following operations are related to PutBucketReplication:

', 'PutBucketRequestPayment' => '

This operation is not supported for directory buckets.

Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets.

The following operations are related to PutBucketRequestPayment:

', 'PutBucketTagging' => '

This operation is not supported for directory buckets.

Sets the tags for a bucket.

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

When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags.

To use this operation, you must have permissions to perform the s3:PutBucketTagging 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.

PutBucketTagging has the following special errors. For more Amazon S3 errors see, Error Responses.

The following operations are related to PutBucketTagging:

', 'PutBucketVersioning' => '

This operation is not supported for directory buckets.

When you enable versioning on a bucket for the first time, it might take a short amount of time for the change to be fully propagated. While this change is propagating, you may encounter intermittent HTTP 404 NoSuchKey errors for requests to objects created or updated after enabling versioning. We recommend that you wait for 15 minutes after enabling versioning before issuing write operations (PUT or DELETE) on objects in the bucket.

Sets the versioning state of an existing bucket.

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.

In order to enable MFA Delete, you must be the bucket owner. If you are the bucket owner and want to enable MFA Delete in the bucket versioning configuration, you 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 configuration 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 configuration 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.

The following operations are related to PutBucketVersioning:

', 'PutBucketWebsite' => '

This operation is not supported for directory buckets.

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 action 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.

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.

Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect in the Amazon S3 User Guide.

The maximum request length is limited to 128 KB.

', 'PutObject' => '

Adds an object to a 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. However, Amazon S3 provides features that can modify this behavior:

Permissions

  • General purpose bucket permissions - The following permissions are required in your policies when your PutObject request includes specific headers.

    • s3:PutObject - To successfully complete the PutObject request, you must always have the s3:PutObject permission on a bucket to add an object to it.

    • s3:PutObjectAcl - To successfully change the objects ACL of your PutObject request, you must have the s3:PutObjectAcl.

    • s3:PutObjectTagging - To successfully set the tag-set with your PutObject request, you must have the s3:PutObjectTagging.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

Data integrity with Content-MD5

  • General purpose bucket - 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, Amazon S3 returns an error. Alternatively, when the object\'s ETag is its MD5 digest, you can calculate the MD5 while putting the object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

  • Directory bucket - This functionality is not supported for directory buckets.

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

For more information about related Amazon S3 APIs, see the following:

', 'PutObjectAcl' => '

This operation is not supported for directory buckets.

Uses the acl subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have the WRITE_ACP permission to set the ACL of an object. For more information, see What permissions can I grant? in the Amazon S3 User Guide.

This functionality is not supported for Amazon S3 on Outposts.

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. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

If your bucket uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. You must use policies to grant access to your bucket and the objects in it. Requests to set ACLs or update ACLs fail and return the AccessControlListNotSupported error code. Requests to read ACLs are still supported. For more information, see Controlling object ownership in the Amazon S3 User Guide.
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 (Amazon Web Services 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:

    • id – if the value specified is the canonical user ID of an Amazon Web Services account

    • uri – if you are granting permissions to a predefined group

    • emailAddress – if the value specified is the email address of an Amazon Web Services account

      Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

      • US East (N. Virginia)

      • US West (N. California)

      • US West (Oregon)

      • Asia Pacific (Singapore)

      • Asia Pacific (Sydney)

      • Asia Pacific (Tokyo)

      • Europe (Ireland)

      • South America (São Paulo)

      For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

    For example, the following x-amz-grant-read header grants list objects permission to the two Amazon Web Services 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 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>

  • 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.

    Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

    • US East (N. Virginia)

    • US West (N. California)

    • US West (Oregon)

    • Asia Pacific (Singapore)

    • Asia Pacific (Sydney)

    • Asia Pacific (Tokyo)

    • Europe (Ireland)

    • South America (São Paulo)

    For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.
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.

The following operations are related to PutObjectAcl:

', 'PutObjectLegalHold' => '

This operation is not supported for directory buckets.

Applies a legal hold configuration to the specified object. For more information, see Locking Objects.

This functionality is not supported for Amazon S3 on Outposts.

', 'PutObjectLockConfiguration' => '

This operation is not supported for directory buckets.

Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.

', 'PutObjectRetention' => '

This operation is not supported for directory buckets.

Places an Object Retention configuration on an object. For more information, see Locking Objects. Users or accounts require the s3:PutObjectRetention permission in order to place an Object Retention configuration on objects. Bypassing a Governance Retention configuration requires the s3:BypassGovernanceRetention permission.

This functionality is not supported for Amazon S3 on Outposts.

', 'PutObjectTagging' => '

This operation is not supported for directory buckets.

Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair. For more information, see Object Tagging.

You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging.

For tagging-related restrictions related to characters and encodings, see Tag Restrictions. Note that Amazon S3 limits the maximum number of tags to 10 tags per object.

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

To put tags of any other version, use the versionId query parameter. You also need permission for the s3:PutObjectVersionTagging action.

PutObjectTagging has the following special errors. For more Amazon S3 errors see, Error Responses.

The following operations are related to PutObjectTagging:

', 'PutPublicAccessBlock' => '

This operation is not supported for directory buckets.

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".

The following operations are related to PutPublicAccessBlock:

', 'RestoreObject' => '

This operation is not supported for directory buckets.

Restores an archived copy of an object back into Amazon S3

This functionality is not supported for Amazon S3 on Outposts.

This action performs the following types of requests:

For more information about the S3 structure in the request body, see the following:

Permissions

To use this operation, you must have permissions to perform the s3:RestoreObject 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 in the Amazon S3 User Guide.

Restoring objects

Objects that you archive to the S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage class, and S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, are not accessible in real time. For objects in the S3 Glacier Flexible Retrieval Flexible Retrieval or S3 Glacier Deep Archive storage classes, you must first initiate a restore request, and then wait until a temporary copy of the object is available. If you want a permanent copy of the object, create a copy of it in the Amazon S3 Standard storage class in your S3 bucket. To access an archived object, you must restore the object for the duration (number of days) that you specify. For objects in the Archive Access or Deep Archive Access tiers of S3 Intelligent-Tiering, you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier.

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.

When restoring an archived object, 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 S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier when occasional urgent requests for restoring archives are required. For all but the largest archived objects (250 MB+), data accessed using Expedited retrievals is 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 objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.

  • Standard - Standard retrievals allow you to access any of your archived objects within several hours. This is the default option for retrieval requests that do not specify the retrieval option. Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. They typically finish within 12 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier. Standard retrievals are free for objects stored in S3 Intelligent-Tiering.

  • Bulk - Bulk retrievals free for objects stored in the S3 Glacier Flexible Retrieval and S3 Intelligent-Tiering storage classes, enabling you to retrieve large amounts, even petabytes, of data at no cost. Bulk retrievals typically finish within 5–12 hours for objects stored in the S3 Glacier Flexible Retrieval Flexible Retrieval storage class or S3 Intelligent-Tiering Archive tier. Bulk retrievals are also the lowest-cost retrieval option when restoring objects from S3 Glacier Deep Archive. They typically finish within 48 hours for objects stored in the S3 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep Archive tier.

For more information about archive retrieval options and provisioned capacity for Expedited data access, see Restoring Archived Objects in the Amazon S3 User Guide.

You can use Amazon S3 restore speed upgrade to change the restore speed to a faster speed while it is in progress. For more information, see Upgrading the speed of an in-progress restore in the Amazon S3 User 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 S3 User 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 S3 User Guide.

Responses

A successful action returns either the 200 OK or 202 Accepted status code.

  • If the object is not previously restored, then Amazon S3 returns 202 Accepted in the response.

  • If the object is previously restored, Amazon S3 returns 200 OK in the response.

  • Special errors:

    • Code: RestoreAlreadyInProgress

    • Cause: Object restore is already in progress.

    • HTTP Status Code: 409 Conflict

    • SOAP Fault Code Prefix: Client

    • Code: GlacierExpeditedRetrievalNotAvailable

    • Cause: 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 S3 Standard or Bulk retrievals.)

    • HTTP Status Code: 503

    • SOAP Fault Code Prefix: N/A

The following operations are related to RestoreObject:

', 'SelectObjectContent' => '

This operation is not supported for directory buckets.

This action filters the contents of an Amazon S3 object based on a simple structured query language (SQL) statement. In the request, along with the SQL expression, you must also specify a data serialization format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses this format to parse object data into records, and returns only records that match the specified SQL expression. You must also specify the data serialization format for the response.

This functionality is not supported for Amazon S3 on Outposts.

For more information about Amazon S3 Select, see Selecting Content from Objects and SELECT Command in the Amazon S3 User Guide.

Permissions

You must have the s3:GetObject permission for this operation. Amazon S3 Select does not support anonymous access. For more information about permissions, see Specifying Permissions in a Policy in the Amazon S3 User Guide.

Object Data Formats

You can use Amazon S3 Select to query objects that have the following format properties:

  • CSV, JSON, and Parquet - Objects must be in CSV, JSON, or Parquet format.

  • UTF-8 - UTF-8 is the only encoding type Amazon S3 Select supports.

  • GZIP or BZIP2 - CSV and JSON files can be compressed using GZIP or BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3 Select supports for CSV and JSON files. Amazon S3 Select supports columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select does not support whole-object compression for Parquet objects.

  • Server-side encryption - Amazon S3 Select supports querying objects that are protected with server-side encryption.

    For objects that are encrypted with customer-provided encryption keys (SSE-C), you must use HTTPS, and you must use the headers that are documented in the GetObject. For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

    For objects that are encrypted with Amazon S3 managed keys (SSE-S3) and Amazon Web Services KMS keys (SSE-KMS), server-side encryption is handled transparently, so you don\'t need to specify anything. For more information about server-side encryption, including SSE-S3 and SSE-KMS, see Protecting Data Using Server-Side Encryption in the Amazon S3 User Guide.

Working with the Response Body

Given the response size is unknown, Amazon S3 Select streams the response as a series of messages and includes a Transfer-Encoding header with chunked as its value in the response. For more information, see Appendix: SelectObjectContent Response.

GetObject Support

The SelectObjectContent action does not support the following GetObject functionality. For more information, see GetObject.

  • Range: Although you can specify a scan range for an Amazon S3 Select request (see SelectObjectContentRequest - ScanRange in the request parameters), you cannot specify the range of bytes of an object to return.

  • The GLACIER, DEEP_ARCHIVE, and REDUCED_REDUNDANCY storage classes, or the ARCHIVE_ACCESS and DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING storage class: You cannot query objects in the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage classes, nor objects in the ARCHIVE_ACCESS or DEEP_ARCHIVE_ACCESS access tiers of the INTELLIGENT_TIERING storage class. For more information about storage classes, see Using Amazon S3 storage classes in the Amazon S3 User Guide.

Special Errors

For a list of special errors for this operation, see List of SELECT Object Content Error Codes

The following operations are related to SelectObjectContent:

', 'UploadPart' => '

Uploads a part in a multipart upload.

In this operation, you provide new data as a part of an object 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.

For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.

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 S3 User Guide .

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Permissions

  • General purpose bucket permissions - To perform a multipart upload with encryption using an Key Management Service key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey actions on the key. The requester must also have permissions for the kms:GenerateDataKey action for the CreateMultipartUpload API. Then, the requester needs permissions for the kms:Decrypt action on the UploadPart and UploadPartCopy APIs.

    These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information about KMS permissions, see Protecting data using server-side encryption with KMS in the Amazon S3 User Guide. For information about the permissions required to use the multipart upload API, see Multipart upload and permissions and Multipart upload API and permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - To grant access to this API operation on a directory bucket, we recommend that you use the CreateSession API operation for session-based authorization. Specifically, you grant the s3express:CreateSession permission to the directory bucket in a bucket policy or an IAM identity-based policy. Then, you make the CreateSession API call on the bucket to obtain a session token. With the session token in your request header, you can make API requests to this operation. After the session token expires, you make another CreateSession API call to generate a new session token for use. Amazon Web Services CLI or SDKs create session and refresh the session token automatically to avoid service interruptions when a session expires. For more information about authorization, see CreateSession .

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

Data integrity

General purpose bucket - To ensure that data is not corrupted 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. If the upload request is signed with Signature Version 4, then Amazon Web Services S3 uses the x-amz-content-sha256 header as a checksum instead of Content-MD5. For more information see Authenticating Requests: Using the Authorization Header (Amazon Web Services Signature Version 4).

Directory buckets - MD5 is not supported by directory buckets. You can use checksum algorithms to check object integrity.
Encryption

  • General purpose bucket - 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. You have mutually exclusive options to protect data using server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS), and Customer-Provided Keys (SSE-C). Amazon S3 encrypts data with server-side encryption using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption with other key options. The option you use depends on whether you want to use KMS keys (SSE-KMS) or provide your own encryption key (SSE-C).

    Server-side encryption is supported by the S3 Multipart Upload operations. Unless you are using a customer-provided encryption key (SSE-C), 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 request server-side encryption using a customer-provided encryption key (SSE-C) in your initiate multipart upload request, you must provide identical encryption information in each part upload using the following request 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, see Using Server-Side Encryption in the Amazon S3 User Guide.

  • Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms).

Special errors

  • 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.

    • HTTP Status Code: 404 Not Found

    • SOAP Fault Code Prefix: Client

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to UploadPart:

', 'UploadPartCopy' => '

Uploads a part by copying data from an existing object as data source. To specify the data source, you add the request header x-amz-copy-source in your request. To specify a byte range, you add the request header x-amz-copy-source-range in your request.

For information about maximum and minimum part sizes and other multipart upload specifications, see Multipart upload limits in the Amazon S3 User Guide.

Instead of copying data from an existing object as part data, you might use the UploadPart action to upload new data as a part of an object in your request.

You must initiate a multipart upload before you can upload any part. In response to your initiate request, Amazon S3 returns the upload ID, a unique identifier that you must include in your upload part request.

For conceptual information about multipart uploads, see Uploading Objects Using Multipart Upload in the Amazon S3 User Guide. For information about copying objects using a single atomic action vs. a multipart upload, see Operations on Objects in the Amazon S3 User Guide.

Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name . Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
Authentication and authorization

All UploadPartCopy requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with the x-amz- prefix, including x-amz-copy-source, must be signed. For more information, see REST Authentication.

Directory buckets - You must use IAM credentials to authenticate and authorize your access to the UploadPartCopy API operation, instead of using the temporary security credentials through the CreateSession API operation.

Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.

Permissions

You must have READ access to the source object and WRITE access to the destination bucket.

  • General purpose bucket permissions - You must have the permissions in a policy based on the bucket types of your source bucket and destination bucket in an UploadPartCopy operation.

    • If the source object is in a general purpose bucket, you must have the s3:GetObject permission to read the source object that is being copied.

    • If the destination bucket is a general purpose bucket, you must have the s3:PutObject permission to write the object copy to the destination bucket.

    • To perform a multipart upload with encryption using an Key Management Service key, the requester must have permission to the kms:Decrypt and kms:GenerateDataKey actions on the key. The requester must also have permissions for the kms:GenerateDataKey action for the CreateMultipartUpload API. Then, the requester needs permissions for the kms:Decrypt action on the UploadPart and UploadPartCopy APIs. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information about KMS permissions, see Protecting data using server-side encryption with KMS in the Amazon S3 User Guide. For information about the permissions required to use the multipart upload API, see Multipart upload and permissions and Multipart upload API and permissions in the Amazon S3 User Guide.

  • Directory bucket permissions - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in an UploadPartCopy operation.

    • If the source object that you want to copy is in a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to read the object. By default, the session is in the ReadWrite mode. If you want to restrict the access, you can explicitly set the s3express:SessionMode condition key to ReadOnly on the copy source bucket.

    • If the copy destination is a directory bucket, you must have the s3express:CreateSession permission in the Action element of a policy to write the object to the destination. The s3express:SessionMode condition key cannot be set to ReadOnly on the copy destination.

    If the object is encrypted with SSE-KMS, you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key.

    For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.

Encryption

  • General purpose buckets - For information about using server-side encryption with customer-provided encryption keys with the UploadPartCopy operation, see CopyObject and UploadPart.

  • Directory buckets - For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

    For directory buckets, when you perform a CreateMultipartUpload operation and an UploadPartCopy operation, the request headers you provide in the CreateMultipartUpload request must match the default encryption configuration of the destination bucket.

    S3 Bucket Keys aren\'t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through UploadPartCopy. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

Special errors

  • 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.

    • HTTP Status Code: 404 Not Found

  • Error Code: InvalidRequest

    • Description: The specified copy source is not supported as a byte-range copy source.

    • HTTP Status Code: 400 Bad Request

HTTP Host header syntax

Directory buckets - The HTTP Host header syntax is Bucket_name.s3express-az_id.region.amazonaws.com.

The following operations are related to UploadPartCopy:

', 'WriteGetObjectResponse' => '

This operation is not supported for directory buckets.

Passes transformed objects to a GetObject operation when using Object Lambda access points. For information about Object Lambda access points, see Transforming objects with Object Lambda access points in the Amazon S3 User Guide.

This operation supports metadata that can be returned by GetObject, in addition to RequestRoute, RequestToken, StatusCode, ErrorCode, and ErrorMessage. The GetObject response metadata is supported so that the WriteGetObjectResponse caller, typically an Lambda function, can provide the same metadata when it internally invokes GetObject. When WriteGetObjectResponse is called by a customer-owned Lambda function, the metadata returned to the end user GetObject call might differ from what Amazon S3 would normally return.

You can include any number of metadata headers. When including a metadata header, it should be prefaced with x-amz-meta. For example, x-amz-meta-my-custom-header: MyCustomValue. The primary use case for this is to forward GetObject metadata.

Amazon Web Services provides some prebuilt Lambda functions that you can use with S3 Object Lambda to detect and redact personally identifiable information (PII) and decompress S3 objects. These Lambda functions are available in the Amazon Web Services Serverless Application Repository, and can be selected through the Amazon Web Services Management Console when you create your Object Lambda access point.

Example 1: PII Access Control - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically detects personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

Example 2: PII Redaction - This Lambda function uses Amazon Comprehend, a natural language processing (NLP) service using machine learning to find insights and relationships in text. It automatically redacts personally identifiable information (PII) such as names, addresses, dates, credit card numbers, and social security numbers from documents in your Amazon S3 bucket.

Example 3: Decompression - The Lambda function S3ObjectLambdaDecompression, is equipped to decompress objects stored in S3 in one of six compressed file formats including bzip2, gzip, snappy, zlib, zstandard and ZIP.

For information on how to view and use these functions, see Using Amazon Web Services built Lambda functions in the Amazon S3 User Guide.

', ], 'shapes' => [ 'AbortDate' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartUploadOutput$AbortDate' => '

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 Configuration in the Amazon S3 User Guide.

The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines the abort action.

This functionality is not supported for directory buckets.

', 'ListPartsOutput$AbortDate' => '

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 Configuration.

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 functionality is not supported for directory buckets.

', ], ], 'AbortIncompleteMultipartUpload' => [ 'base' => '

Specifies the days since the initiation of an incomplete multipart upload that Amazon S3 will wait before permanently removing all parts of the upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration in the Amazon S3 User Guide.

', 'refs' => [ 'LifecycleRule$AbortIncompleteMultipartUpload' => NULL, 'Rule$AbortIncompleteMultipartUpload' => NULL, ], ], 'AbortMultipartUploadOutput' => [ 'base' => NULL, 'refs' => [], ], 'AbortMultipartUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'AbortRuleId' => [ 'base' => NULL, 'refs' => [ 'CreateMultipartUploadOutput$AbortRuleId' => '

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.

This functionality is not supported for directory buckets.

', 'ListPartsOutput$AbortRuleId' => '

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.

This functionality is not supported for directory buckets.

', ], ], 'AccelerateConfiguration' => [ 'base' => '

Configures the transfer acceleration state for an Amazon S3 bucket. For more information, see Amazon S3 Transfer Acceleration in the Amazon S3 User Guide.

', 'refs' => [ 'PutBucketAccelerateConfigurationRequest$AccelerateConfiguration' => '

Container for setting the transfer acceleration state.

', ], ], 'AcceptRanges' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$AcceptRanges' => '

Indicates that a range of bytes was specified in the request.

', 'HeadObjectOutput$AcceptRanges' => '

Indicates that a range of bytes was specified.

', 'WriteGetObjectResponseRequest$AcceptRanges' => '

Indicates that a range of bytes was specified.

', ], ], 'AccessControlPolicy' => [ 'base' => '

Contains the elements that set the ACL permissions for an object per grantee.

', 'refs' => [ 'PutBucketAclRequest$AccessControlPolicy' => '

Contains the elements that set the ACL permissions for an object per grantee.

', 'PutObjectAclRequest$AccessControlPolicy' => '

Contains the elements that set the ACL permissions for an object per grantee.

', ], ], 'AccessControlTranslation' => [ 'base' => '

A container for information about access control for replicas.

', 'refs' => [ 'Destination$AccessControlTranslation' => '

Specify this only in a cross-account scenario (where source and destination bucket owners are not the same), and you want to change replica ownership to the Amazon Web Services account that owns the destination bucket. If this is not specified in the replication configuration, the replicas are owned by same Amazon Web Services account that owns the source object.

', ], ], 'AccessKeyIdValue' => [ 'base' => NULL, 'refs' => [ 'SessionCredentials$AccessKeyId' => '

A unique identifier that\'s associated with a secret access key. The access key ID and the secret access key are used together to sign programmatic Amazon Web Services requests cryptographically.

', ], ], 'AccessPointAlias' => [ 'base' => NULL, 'refs' => [ 'HeadBucketOutput$AccessPointAlias' => '

Indicates whether the bucket name used in the request is an access point alias.

For directory buckets, the value of this field is false.

', ], ], 'AccessPointArn' => [ 'base' => NULL, 'refs' => [ 'MetricsAndOperator$AccessPointArn' => '

The access point ARN used when evaluating an AND predicate.

', 'MetricsFilter$AccessPointArn' => '

The access point ARN used when evaluating a metrics filter.

', ], ], 'AccountId' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartUploadRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'AnalyticsS3BucketDestination$BucketAccountId' => '

The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

', 'CompleteMultipartUploadRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'CopyObjectRequest$ExpectedBucketOwner' => '

The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'CopyObjectRequest$ExpectedSourceBucketOwner' => '

The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'CreateMultipartUploadRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketAnalyticsConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketCorsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketEncryptionRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'DeleteBucketInventoryConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketLifecycleRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'DeleteBucketMetricsConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketOwnershipControlsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketPolicyRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'DeleteBucketReplicationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'DeleteBucketTaggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteBucketWebsiteRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteObjectRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteObjectTaggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeleteObjectsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'DeletePublicAccessBlockRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'Destination$Account' => '

Destination bucket owner account ID. In a cross-account scenario, if you direct Amazon S3 to change replica ownership to the Amazon Web Services 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 S3 User Guide.

', 'GetBucketAccelerateConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketAclRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketAnalyticsConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketCorsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketEncryptionRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'GetBucketInventoryConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketLifecycleConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'GetBucketLifecycleRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketLocationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketLoggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketMetricsConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketNotificationConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketOwnershipControlsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketPolicyRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'GetBucketPolicyStatusRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketReplicationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketRequestPaymentRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketTaggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketVersioningRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetBucketWebsiteRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectAclRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectAttributesRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectLegalHoldRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectLockConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectRetentionRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectTaggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetObjectTorrentRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'GetPublicAccessBlockRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'HeadBucketRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'HeadObjectRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'InventoryS3BucketDestination$AccountId' => '

The account ID that owns the destination S3 bucket. If no account ID is provided, the owner is not validated before exporting data.

Although this value is optional, we strongly recommend that you set it to help prevent problems if the destination bucket ownership changes.

', 'ListBucketAnalyticsConfigurationsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListBucketInventoryConfigurationsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListBucketMetricsConfigurationsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListMultipartUploadsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListObjectVersionsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListObjectsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListObjectsV2Request$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'ListPartsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketAccelerateConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketAclRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketAnalyticsConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketCorsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketEncryptionRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'PutBucketInventoryConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketLifecycleConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'PutBucketLifecycleRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketLoggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketMetricsConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketNotificationConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketNotificationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketOwnershipControlsRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketPolicyRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

For directory buckets, this header is not supported in this API operation. If you specify this header, the request fails with the HTTP status code 501 Not Implemented.

', 'PutBucketReplicationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketRequestPaymentRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketTaggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketVersioningRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutBucketWebsiteRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutObjectAclRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutObjectLegalHoldRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutObjectLockConfigurationRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutObjectRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutObjectRetentionRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutObjectTaggingRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'PutPublicAccessBlockRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'RestoreObjectRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'SelectObjectContentRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'UploadPartCopyRequest$ExpectedBucketOwner' => '

The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'UploadPartCopyRequest$ExpectedSourceBucketOwner' => '

The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', 'UploadPartRequest$ExpectedBucketOwner' => '

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

', ], ], 'AllowQuotedRecordDelimiter' => [ 'base' => NULL, 'refs' => [ 'CSVInput$AllowQuotedRecordDelimiter' => '

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.

', ], ], 'AllowedHeader' => [ 'base' => NULL, 'refs' => [ 'AllowedHeaders$member' => NULL, ], ], 'AllowedHeaders' => [ 'base' => NULL, 'refs' => [ 'CORSRule$AllowedHeaders' => '

Headers that are specified in the Access-Control-Request-Headers header. These headers are allowed in a preflight OPTIONS request. In response to any preflight OPTIONS request, Amazon S3 returns any requested headers that are allowed.

', ], ], 'AllowedMethod' => [ 'base' => NULL, 'refs' => [ 'AllowedMethods$member' => NULL, ], ], 'AllowedMethods' => [ 'base' => NULL, 'refs' => [ 'CORSRule$AllowedMethods' => '

An HTTP method that you allow the origin to execute. Valid values are GET, PUT, HEAD, POST, and DELETE.

', ], ], 'AllowedOrigin' => [ 'base' => NULL, 'refs' => [ 'AllowedOrigins$member' => NULL, ], ], 'AllowedOrigins' => [ 'base' => NULL, 'refs' => [ 'CORSRule$AllowedOrigins' => '

One or more origins you want customers to be able to access the bucket from.

', ], ], 'AnalyticsAndOperator' => [ 'base' => '

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates in any combination, and an object must match all of the predicates for the filter to apply.

', 'refs' => [ 'AnalyticsFilter$And' => '

A conjunction (logical AND) of predicates, which is used in evaluating an analytics filter. The operator must have at least two predicates.

', ], ], 'AnalyticsConfiguration' => [ 'base' => '

Specifies the configuration and any analyses for the analytics filter of an Amazon S3 bucket.

', 'refs' => [ 'AnalyticsConfigurationList$member' => NULL, 'GetBucketAnalyticsConfigurationOutput$AnalyticsConfiguration' => '

The configuration and any analyses for the analytics filter.

', 'PutBucketAnalyticsConfigurationRequest$AnalyticsConfiguration' => '

The configuration and any analyses for the analytics filter.

', ], ], 'AnalyticsConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListBucketAnalyticsConfigurationsOutput$AnalyticsConfigurationList' => '

The list of analytics configurations for a bucket.

', ], ], 'AnalyticsExportDestination' => [ 'base' => '

Where to publish the analytics results.

', 'refs' => [ 'StorageClassAnalysisDataExport$Destination' => '

The place to store the data for an analysis.

', ], ], 'AnalyticsFilter' => [ 'base' => '

The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

', 'refs' => [ 'AnalyticsConfiguration$Filter' => '

The filter used to describe a set of objects for analyses. A filter must have exactly one prefix, one tag, or one conjunction (AnalyticsAndOperator). If no filter is provided, all objects will be considered in any analysis.

', ], ], 'AnalyticsId' => [ 'base' => NULL, 'refs' => [ 'AnalyticsConfiguration$Id' => '

The ID that identifies the analytics configuration.

', 'DeleteBucketAnalyticsConfigurationRequest$Id' => '

The ID that identifies the analytics configuration.

', 'GetBucketAnalyticsConfigurationRequest$Id' => '

The ID that identifies the analytics configuration.

', 'PutBucketAnalyticsConfigurationRequest$Id' => '

The ID that identifies the analytics configuration.

', ], ], 'AnalyticsS3BucketDestination' => [ 'base' => '

Contains information about where to publish the analytics results.

', 'refs' => [ 'AnalyticsExportDestination$S3BucketDestination' => '

A destination signifying output to an S3 bucket.

', ], ], 'AnalyticsS3ExportFileFormat' => [ 'base' => NULL, 'refs' => [ 'AnalyticsS3BucketDestination$Format' => '

Specifies the file format used when exporting data to Amazon S3.

', ], ], 'ArchiveStatus' => [ 'base' => NULL, 'refs' => [ 'HeadObjectOutput$ArchiveStatus' => '

The archive state of the head object.

This functionality is not supported for directory buckets.

', ], ], 'Body' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$Body' => '

Object data.

', 'GetObjectTorrentOutput$Body' => '

A Bencoded dictionary as defined by the BitTorrent specification

', 'PutObjectRequest$Body' => '

Object data.

', 'RecordsEvent$Payload' => '

The byte array of partial, one or more result records. S3 Select doesn\'t guarantee that a record will be self-contained in one record frame. To ensure continuous streaming of data, S3 Select might split the same record across multiple record frames instead of aggregating the results in memory. Some S3 clients (for example, the SDK for Java) handle this behavior by creating a ByteStream out of the response by default. Other clients might not handle this behavior by default. In those cases, you must aggregate the results on the client side and parse the response.

', 'UploadPartRequest$Body' => '

Object data.

', 'WriteGetObjectResponseRequest$Body' => '

The object data.

', ], ], 'Bucket' => [ 'base' => '

In terms of implementation, a Bucket is a resource.

', 'refs' => [ 'Buckets$member' => NULL, ], ], 'BucketAccelerateStatus' => [ 'base' => NULL, 'refs' => [ 'AccelerateConfiguration$Status' => '

Specifies the transfer acceleration status of the bucket.

', 'GetBucketAccelerateConfigurationOutput$Status' => '

The accelerate configuration of the bucket.

', ], ], 'BucketAlreadyExists' => [ 'base' => '

The requested bucket name is not available. The bucket namespace is shared by all users of the system. Select a different name and try again.

', 'refs' => [], ], 'BucketAlreadyOwnedByYou' => [ 'base' => '

The bucket you tried to create already exists, and you own it. Amazon S3 returns this error in all Amazon Web Services 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).

', 'refs' => [], ], 'BucketCannedACL' => [ 'base' => NULL, 'refs' => [ 'CreateBucketRequest$ACL' => '

The canned ACL to apply to the bucket.

This functionality is not supported for directory buckets.

', 'PutBucketAclRequest$ACL' => '

The canned ACL to apply to the bucket.

', ], ], 'BucketInfo' => [ 'base' => '

Specifies the information about the bucket that will be created. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

This functionality is only supported by directory buckets.

', 'refs' => [ 'CreateBucketConfiguration$Bucket' => '

Specifies the information about the bucket that will be created.

This functionality is only supported by directory buckets.

', ], ], 'BucketKeyEnabled' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$BucketKeyEnabled' => '

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'CopyObjectOutput$BucketKeyEnabled' => '

Indicates whether the copied object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'CopyObjectRequest$BucketKeyEnabled' => '

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object.

Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.

For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.

Directory buckets - S3 Bucket Keys aren\'t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

', 'CreateMultipartUploadOutput$BucketKeyEnabled' => '

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'CreateMultipartUploadRequest$BucketKeyEnabled' => '

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).

General purpose buckets - Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn\'t affect bucket-level settings for S3 Bucket Key.

Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren\'t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

', 'CreateSessionOutput$BucketKeyEnabled' => '

Indicates whether to use an S3 Bucket Key for server-side encryption with KMS keys (SSE-KMS).

', 'CreateSessionRequest$BucketKeyEnabled' => '

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using KMS keys (SSE-KMS).

S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren\'t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

', 'GetObjectOutput$BucketKeyEnabled' => '

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'HeadObjectOutput$BucketKeyEnabled' => '

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'PutObjectOutput$BucketKeyEnabled' => '

Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'PutObjectRequest$BucketKeyEnabled' => '

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS).

General purpose buckets - Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn\'t affect bucket-level settings for S3 Bucket Key.

Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren\'t supported, when you copy SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy operation in Batch Operations, or the import jobs. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

', 'ServerSideEncryptionRule$BucketKeyEnabled' => '

Specifies whether Amazon S3 should use an S3 Bucket Key with server-side encryption using KMS (SSE-KMS) for new objects in the bucket. Existing objects are not affected. Setting the BucketKeyEnabled element to true causes Amazon S3 to use an S3 Bucket Key.

', 'UploadPartCopyOutput$BucketKeyEnabled' => '

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'UploadPartOutput$BucketKeyEnabled' => '

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

', 'WriteGetObjectResponseRequest$BucketKeyEnabled' => '

Indicates whether the object stored in Amazon S3 uses an S3 bucket key for server-side encryption with Amazon Web Services KMS (SSE-KMS).

', ], ], 'BucketLifecycleConfiguration' => [ 'base' => '

Specifies the lifecycle configuration for objects in an Amazon S3 bucket. For more information, see Object Lifecycle Management in the Amazon S3 User Guide.

', 'refs' => [ 'PutBucketLifecycleConfigurationRequest$LifecycleConfiguration' => '

Container for lifecycle rules. You can add as many as 1,000 rules.

', ], ], 'BucketLocationConstraint' => [ 'base' => NULL, 'refs' => [ 'CreateBucketConfiguration$LocationConstraint' => '

Specifies the Region where the bucket will be created. 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 Europe (Ireland) Region. For more information, see Accessing a bucket in the Amazon S3 User Guide.

If you don\'t specify a Region, the bucket is created in the US East (N. Virginia) Region (us-east-1) by default.

This functionality is not supported for directory buckets.

', 'GetBucketLocationOutput$LocationConstraint' => '

Specifies the Region where the bucket resides. For a list of all the Amazon S3 supported location constraints by Region, see Regions and Endpoints. Buckets in Region us-east-1 have a LocationConstraint of null.

', ], ], 'BucketLocationName' => [ 'base' => NULL, 'refs' => [ 'HeadBucketOutput$BucketLocationName' => '

The name of the location where the bucket will be created.

For directory buckets, the AZ ID of the Availability Zone where the bucket is created. An example AZ ID value is usw2-az1.

This functionality is only supported by directory buckets.

', ], ], 'BucketLoggingStatus' => [ 'base' => '

Container for logging status information.

', 'refs' => [ 'PutBucketLoggingRequest$BucketLoggingStatus' => '

Container for logging status information.

', ], ], 'BucketLogsPermission' => [ 'base' => NULL, 'refs' => [ 'TargetGrant$Permission' => '

Logging permissions assigned to the grantee for the bucket.

', ], ], 'BucketName' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartUploadRequest$Bucket' => '

The bucket name to which the upload was taking place.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'AnalyticsS3BucketDestination$Bucket' => '

The Amazon Resource Name (ARN) of the bucket to which data is exported.

', 'Bucket$Name' => '

The name of the bucket.

', 'CompleteMultipartUploadOutput$Bucket' => '

The name of the bucket that contains the newly created object. Does not return the access point ARN or access point alias if used.

Access points are not supported by directory buckets.

', 'CompleteMultipartUploadRequest$Bucket' => '

Name of the bucket to which the multipart upload was initiated.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'CopyObjectRequest$Bucket' => '

The name of the destination bucket.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'CreateBucketRequest$Bucket' => '

The name of the bucket to create.

General purpose buckets - For information about bucket naming restrictions, see Bucket naming rules in the Amazon S3 User Guide.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'CreateMultipartUploadOutput$Bucket' => '

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

Access points are not supported by directory buckets.

', 'CreateMultipartUploadRequest$Bucket' => '

The name of the bucket where the multipart upload is initiated and where the object is uploaded.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'CreateSessionRequest$Bucket' => '

The name of the bucket that you create a session for.

', 'DeleteBucketAnalyticsConfigurationRequest$Bucket' => '

The name of the bucket from which an analytics configuration is deleted.

', 'DeleteBucketCorsRequest$Bucket' => '

Specifies the bucket whose cors configuration is being deleted.

', 'DeleteBucketEncryptionRequest$Bucket' => '

The name of the bucket containing the server-side encryption configuration to delete.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'DeleteBucketIntelligentTieringConfigurationRequest$Bucket' => '

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

', 'DeleteBucketInventoryConfigurationRequest$Bucket' => '

The name of the bucket containing the inventory configuration to delete.

', 'DeleteBucketLifecycleRequest$Bucket' => '

The bucket name of the lifecycle to delete.

', 'DeleteBucketMetricsConfigurationRequest$Bucket' => '

The name of the bucket containing the metrics configuration to delete.

', 'DeleteBucketOwnershipControlsRequest$Bucket' => '

The Amazon S3 bucket whose OwnershipControls you want to delete.

', 'DeleteBucketPolicyRequest$Bucket' => '

The bucket name.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'DeleteBucketReplicationRequest$Bucket' => '

The bucket name.

', 'DeleteBucketRequest$Bucket' => '

Specifies the bucket being deleted.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'DeleteBucketTaggingRequest$Bucket' => '

The bucket that has the tag set to be removed.

', 'DeleteBucketWebsiteRequest$Bucket' => '

The bucket name for which you want to remove the website configuration.

', 'DeleteObjectRequest$Bucket' => '

The bucket name of the bucket containing the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'DeleteObjectTaggingRequest$Bucket' => '

The bucket name containing the objects from which to remove the tags.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'DeleteObjectsRequest$Bucket' => '

The bucket name containing the objects to delete.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'DeletePublicAccessBlockRequest$Bucket' => '

The Amazon S3 bucket whose PublicAccessBlock configuration you want to delete.

', 'Destination$Bucket' => '

The Amazon Resource Name (ARN) of the bucket where you want Amazon S3 to store the results.

', 'GetBucketAccelerateConfigurationRequest$Bucket' => '

The name of the bucket for which the accelerate configuration is retrieved.

', 'GetBucketAclRequest$Bucket' => '

Specifies the S3 bucket whose ACL is being requested.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

', 'GetBucketAnalyticsConfigurationRequest$Bucket' => '

The name of the bucket from which an analytics configuration is retrieved.

', 'GetBucketCorsRequest$Bucket' => '

The bucket name for which to get the cors configuration.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

', 'GetBucketEncryptionRequest$Bucket' => '

The name of the bucket from which the server-side encryption configuration is retrieved.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'GetBucketIntelligentTieringConfigurationRequest$Bucket' => '

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

', 'GetBucketInventoryConfigurationRequest$Bucket' => '

The name of the bucket containing the inventory configuration to retrieve.

', 'GetBucketLifecycleConfigurationRequest$Bucket' => '

The name of the bucket for which to get the lifecycle information.

', 'GetBucketLifecycleRequest$Bucket' => '

The name of the bucket for which to get the lifecycle information.

', 'GetBucketLocationRequest$Bucket' => '

The name of the bucket for which to get the location.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

', 'GetBucketLoggingRequest$Bucket' => '

The bucket name for which to get the logging information.

', 'GetBucketMetricsConfigurationRequest$Bucket' => '

The name of the bucket containing the metrics configuration to retrieve.

', 'GetBucketNotificationConfigurationRequest$Bucket' => '

The name of the bucket for which to get the notification configuration.

When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

', 'GetBucketOwnershipControlsRequest$Bucket' => '

The name of the Amazon S3 bucket whose OwnershipControls you want to retrieve.

', 'GetBucketPolicyRequest$Bucket' => '

The bucket name to get the bucket policy for.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

Access points - When you use this API operation with an access point, provide the alias of the access point in place of the bucket name.

Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

Access points and Object Lambda access points are not supported by directory buckets.

', 'GetBucketPolicyStatusRequest$Bucket' => '

The name of the Amazon S3 bucket whose policy status you want to retrieve.

', 'GetBucketReplicationRequest$Bucket' => '

The bucket name for which to get the replication information.

', 'GetBucketRequestPaymentRequest$Bucket' => '

The name of the bucket for which to get the payment request configuration

', 'GetBucketTaggingRequest$Bucket' => '

The name of the bucket for which to get the tagging information.

', 'GetBucketVersioningRequest$Bucket' => '

The name of the bucket for which to get the versioning information.

', 'GetBucketWebsiteRequest$Bucket' => '

The bucket name for which to get the website configuration.

', 'GetObjectAclRequest$Bucket' => '

The bucket name that contains the object for which to get the ACL information.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

', 'GetObjectAttributesRequest$Bucket' => '

The name of the bucket that contains the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'GetObjectLegalHoldRequest$Bucket' => '

The bucket name containing the object whose legal hold status you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

', 'GetObjectLockConfigurationRequest$Bucket' => '

The bucket whose Object Lock configuration you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

', 'GetObjectRequest$Bucket' => '

The bucket name containing the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Object Lambda access points - When you use this action with an Object Lambda access point, you must direct requests to the Object Lambda access point hostname. The Object Lambda access point hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'GetObjectRetentionRequest$Bucket' => '

The bucket name containing the object whose retention settings you want to retrieve.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

', 'GetObjectTaggingRequest$Bucket' => '

The bucket name containing the object for which to get the tagging information.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'GetObjectTorrentRequest$Bucket' => '

The name of the bucket containing the object for which to get the torrent files.

', 'GetPublicAccessBlockRequest$Bucket' => '

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to retrieve.

', 'HeadBucketRequest$Bucket' => '

The bucket name.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Object Lambda access points - When you use this API operation with an Object Lambda access point, provide the alias of the Object Lambda access point in place of the bucket name. If the Object Lambda access point alias in a request is not valid, the error code InvalidAccessPointAliasError is returned. For more information about InvalidAccessPointAliasError, see List of Error Codes.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'HeadObjectRequest$Bucket' => '

The name of the bucket that contains the object.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'InventoryS3BucketDestination$Bucket' => '

The Amazon Resource Name (ARN) of the bucket where inventory results will be published.

', 'ListBucketAnalyticsConfigurationsRequest$Bucket' => '

The name of the bucket from which analytics configurations are retrieved.

', 'ListBucketIntelligentTieringConfigurationsRequest$Bucket' => '

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

', 'ListBucketInventoryConfigurationsRequest$Bucket' => '

The name of the bucket containing the inventory configurations to retrieve.

', 'ListBucketMetricsConfigurationsRequest$Bucket' => '

The name of the bucket containing the metrics configurations to retrieve.

', 'ListMultipartUploadsOutput$Bucket' => '

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

', 'ListMultipartUploadsRequest$Bucket' => '

The name of the bucket to which the multipart upload was initiated.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'ListObjectVersionsOutput$Name' => '

The bucket name.

', 'ListObjectVersionsRequest$Bucket' => '

The bucket name that contains the objects.

', 'ListObjectsOutput$Name' => '

The bucket name.

', 'ListObjectsRequest$Bucket' => '

The name of the bucket containing the objects.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'ListObjectsV2Output$Name' => '

The bucket name.

', 'ListObjectsV2Request$Bucket' => '

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'ListPartsOutput$Bucket' => '

The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.

', 'ListPartsRequest$Bucket' => '

The name of the bucket to which the parts are being uploaded.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'PutBucketAccelerateConfigurationRequest$Bucket' => '

The name of the bucket for which the accelerate configuration is set.

', 'PutBucketAclRequest$Bucket' => '

The bucket to which to apply the ACL.

', 'PutBucketAnalyticsConfigurationRequest$Bucket' => '

The name of the bucket to which an analytics configuration is stored.

', 'PutBucketCorsRequest$Bucket' => '

Specifies the bucket impacted by the corsconfiguration.

', 'PutBucketEncryptionRequest$Bucket' => '

Specifies default encryption for a bucket using server-side encryption with different key options.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'PutBucketIntelligentTieringConfigurationRequest$Bucket' => '

The name of the Amazon S3 bucket whose configuration you want to modify or retrieve.

', 'PutBucketInventoryConfigurationRequest$Bucket' => '

The name of the bucket where the inventory configuration will be stored.

', 'PutBucketLifecycleConfigurationRequest$Bucket' => '

The name of the bucket for which to set the configuration.

', 'PutBucketLifecycleRequest$Bucket' => '

', 'PutBucketLoggingRequest$Bucket' => '

The name of the bucket for which to set the logging parameters.

', 'PutBucketMetricsConfigurationRequest$Bucket' => '

The name of the bucket for which the metrics configuration is set.

', 'PutBucketNotificationConfigurationRequest$Bucket' => '

The name of the bucket.

', 'PutBucketNotificationRequest$Bucket' => '

The name of the bucket.

', 'PutBucketOwnershipControlsRequest$Bucket' => '

The name of the Amazon S3 bucket whose OwnershipControls you want to set.

', 'PutBucketPolicyRequest$Bucket' => '

The name of the bucket.

Directory buckets - When you use this operation with a directory bucket, you must use path-style requests in the format https://s3express-control.region_code.amazonaws.com/bucket-name . Virtual-hosted-style requests aren\'t supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must also follow the format bucket_base_name--az_id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide

', 'PutBucketReplicationRequest$Bucket' => '

The name of the bucket

', 'PutBucketRequestPaymentRequest$Bucket' => '

The bucket name.

', 'PutBucketTaggingRequest$Bucket' => '

The bucket name.

', 'PutBucketVersioningRequest$Bucket' => '

The bucket name.

', 'PutBucketWebsiteRequest$Bucket' => '

The bucket name.

', 'PutObjectAclRequest$Bucket' => '

The bucket name that contains the object to which you want to attach the ACL.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'PutObjectLegalHoldRequest$Bucket' => '

The bucket name containing the object that you want to place a legal hold on.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

', 'PutObjectLockConfigurationRequest$Bucket' => '

The bucket whose Object Lock configuration you want to create or replace.

', 'PutObjectRequest$Bucket' => '

The bucket name to which the PUT action was initiated.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'PutObjectRetentionRequest$Bucket' => '

The bucket name that contains the object you want to apply this Object Retention configuration to.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

', 'PutObjectTaggingRequest$Bucket' => '

The bucket name containing the object.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'PutPublicAccessBlockRequest$Bucket' => '

The name of the Amazon S3 bucket whose PublicAccessBlock configuration you want to set.

', 'RestoreObjectRequest$Bucket' => '

The bucket name containing the object to restore.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'S3Location$BucketName' => '

The name of the bucket where the restore results will be placed.

', 'SelectObjectContentRequest$Bucket' => '

The S3 bucket.

', 'UploadPartCopyRequest$Bucket' => '

The bucket name.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', 'UploadPartRequest$Bucket' => '

The name of the bucket to which the multipart upload was initiated.

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

Access points and Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

', ], ], 'BucketRegion' => [ 'base' => NULL, 'refs' => [ 'Bucket$BucketRegion' => '

BucketRegion indicates the Amazon Web Services region where the bucket is located. If the request contains at least one valid parameter, it is included in the response.

', 'ListBucketsRequest$BucketRegion' => '

Limits the response to buckets that are located in the specified Amazon Web Services Region. The Amazon Web Services Region must be expressed according to the Amazon Web Services Region code, such as us-west-2 for the US West (Oregon) Region. For a list of the valid values for all of the Amazon Web Services Regions, see Regions and Endpoints.

Requests made to a Regional endpoint that is different from the bucket-region parameter are not supported. For example, if you want to limit the response to your buckets in Region us-west-2, the request must be made to an endpoint in Region us-west-2.

', ], ], 'BucketType' => [ 'base' => NULL, 'refs' => [ 'BucketInfo$Type' => '

The type of bucket.

', ], ], 'BucketVersioningStatus' => [ 'base' => NULL, 'refs' => [ 'GetBucketVersioningOutput$Status' => '

The versioning state of the bucket.

', 'VersioningConfiguration$Status' => '

The versioning state of the bucket.

', ], ], 'Buckets' => [ 'base' => NULL, 'refs' => [ 'ListBucketsOutput$Buckets' => '

The list of buckets owned by the requester.

', 'ListDirectoryBucketsOutput$Buckets' => '

The list of buckets owned by the requester.

', ], ], 'BypassGovernanceRetention' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectRequest$BypassGovernanceRetention' => '

Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:BypassGovernanceRetention permission.

This functionality is not supported for directory buckets.

', 'DeleteObjectsRequest$BypassGovernanceRetention' => '

Specifies whether you want to delete this object even if it has a Governance-type Object Lock in place. To use this header, you must have the s3:BypassGovernanceRetention permission.

This functionality is not supported for directory buckets.

', 'PutObjectRetentionRequest$BypassGovernanceRetention' => '

Indicates whether this action should bypass Governance-mode restrictions.

', ], ], 'BytesProcessed' => [ 'base' => NULL, 'refs' => [ 'Progress$BytesProcessed' => '

The current number of uncompressed object bytes processed.

', 'Stats$BytesProcessed' => '

The total number of uncompressed object bytes processed.

', ], ], 'BytesReturned' => [ 'base' => NULL, 'refs' => [ 'Progress$BytesReturned' => '

The current number of bytes of records payload data returned.

', 'Stats$BytesReturned' => '

The total number of bytes of records payload data returned.

', ], ], 'BytesScanned' => [ 'base' => NULL, 'refs' => [ 'Progress$BytesScanned' => '

The current number of object bytes scanned.

', 'Stats$BytesScanned' => '

The total number of object bytes scanned.

', ], ], 'CORSConfiguration' => [ 'base' => '

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 S3 User Guide.

', 'refs' => [ 'PutBucketCorsRequest$CORSConfiguration' => '

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 S3 User Guide.

', ], ], 'CORSRule' => [ 'base' => '

Specifies a cross-origin access rule for an Amazon S3 bucket.

', 'refs' => [ 'CORSRules$member' => NULL, ], ], 'CORSRules' => [ 'base' => NULL, 'refs' => [ 'CORSConfiguration$CORSRules' => '

A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.

', 'GetBucketCorsOutput$CORSRules' => '

A set of origins and methods (cross-origin access that you want to allow). You can add up to 100 rules to the configuration.

', ], ], 'CSVInput' => [ 'base' => '

Describes how an uncompressed comma-separated values (CSV)-formatted input object is formatted.

', 'refs' => [ 'InputSerialization$CSV' => '

Describes the serialization of a CSV-encoded object.

', ], ], 'CSVOutput' => [ 'base' => '

Describes how uncompressed comma-separated values (CSV)-formatted results are formatted.

', 'refs' => [ 'OutputSerialization$CSV' => '

Describes the serialization of CSV-encoded Select results.

', ], ], 'CacheControl' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CacheControl' => '

Specifies the caching behavior along the request/reply chain.

', 'CreateMultipartUploadRequest$CacheControl' => '

Specifies caching behavior along the request/reply chain.

', 'GetObjectOutput$CacheControl' => '

Specifies caching behavior along the request/reply chain.

', 'HeadObjectOutput$CacheControl' => '

Specifies caching behavior along the request/reply chain.

', 'PutObjectRequest$CacheControl' => '

Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.

', 'WriteGetObjectResponseRequest$CacheControl' => '

Specifies caching behavior along the request/reply chain.

', ], ], 'Checksum' => [ 'base' => '

Contains all the possible checksum or digest values for an object.

', 'refs' => [ 'GetObjectAttributesOutput$Checksum' => '

The checksum or digest of the object.

', ], ], 'ChecksumAlgorithm' => [ 'base' => NULL, 'refs' => [ 'ChecksumAlgorithmList$member' => NULL, 'CopyObjectRequest$ChecksumAlgorithm' => '

Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

When you copy an object, if the source object has a checksum, that checksum value will be copied to the new object by default. If the CopyObject request does not include this x-amz-checksum-algorithm header, the checksum algorithm will be copied from the source object to the destination object (if it\'s present on the source object). You can optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm header. Unrecognized or unsupported values will respond with the HTTP status code 400 Bad Request.

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that\'s used for performance.

', 'CreateMultipartUploadOutput$ChecksumAlgorithm' => '

The algorithm that was used to create a checksum of the object.

', 'CreateMultipartUploadRequest$ChecksumAlgorithm' => '

Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'DeleteObjectsRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:

For more information, see Checking object integrity in the Amazon S3 User Guide.

If the individual checksum value you provide through x-amz-checksum-algorithm doesn\'t match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'ListPartsOutput$ChecksumAlgorithm' => '

The algorithm that was used to create a checksum of the object.

', 'MultipartUpload$ChecksumAlgorithm' => '

The algorithm that was used to create a checksum of the object.

', 'PutBucketAccelerateConfigurationRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketAclRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketCorsRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketEncryptionRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that\'s used for performance.

', 'PutBucketLifecycleConfigurationRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketLifecycleRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketLoggingRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketNotificationRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketPolicyRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:

For more information, see Checking object integrity in the Amazon S3 User Guide.

If the individual checksum value you provide through x-amz-checksum-algorithm doesn\'t match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that\'s used for performance.

', 'PutBucketReplicationRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketRequestPaymentRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketTaggingRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketVersioningRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutBucketWebsiteRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutObjectAclRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutObjectLegalHoldRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutObjectLockConfigurationRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutObjectRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.

For the x-amz-checksum-algorithm header, replace algorithm with the supported algorithm from the following list:

For more information, see Checking object integrity in the Amazon S3 User Guide.

If the individual checksum value you provide through x-amz-checksum-algorithm doesn\'t match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in x-amz-checksum-algorithm .

The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.

For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum algorithm that\'s used for performance.

', 'PutObjectRetentionRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutObjectTaggingRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'PutPublicAccessBlockRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'RestoreObjectRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

', 'UploadPartRequest$ChecksumAlgorithm' => '

Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not provide any additional functionality if you don\'t use the SDK. When you send this header, there must be a corresponding x-amz-checksum or x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request. For more information, see Checking object integrity in the Amazon S3 User Guide.

If you provide an individual checksum, Amazon S3 ignores any provided ChecksumAlgorithm parameter.

This checksum algorithm must be the same for all parts and it match the checksum value supplied in the CreateMultipartUpload request.

', ], ], 'ChecksumAlgorithmList' => [ 'base' => NULL, 'refs' => [ 'Object$ChecksumAlgorithm' => '

The algorithm that was used to create a checksum of the object.

', 'ObjectVersion$ChecksumAlgorithm' => '

The algorithm that was used to create a checksum of the object.

', ], ], 'ChecksumCRC32' => [ 'base' => NULL, 'refs' => [ 'Checksum$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadOutput$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadRequest$ChecksumCRC32' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CompletedPart$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyObjectResult$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyPartResult$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'GetObjectOutput$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'HeadObjectOutput$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'ObjectPart$ChecksumCRC32' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'Part$ChecksumCRC32' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectOutput$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectRequest$ChecksumCRC32' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartOutput$ChecksumCRC32' => '

The base64-encoded, 32-bit CRC-32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartRequest$ChecksumCRC32' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'WriteGetObjectResponseRequest$ChecksumCRC32' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32 checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

', ], ], 'ChecksumCRC32C' => [ 'base' => NULL, 'refs' => [ 'Checksum$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadOutput$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadRequest$ChecksumCRC32C' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CompletedPart$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyObjectResult$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyPartResult$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'GetObjectOutput$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'HeadObjectOutput$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'ObjectPart$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'Part$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectOutput$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectRequest$ChecksumCRC32C' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartOutput$ChecksumCRC32C' => '

The base64-encoded, 32-bit CRC-32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartRequest$ChecksumCRC32C' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'WriteGetObjectResponseRequest$ChecksumCRC32C' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 32-bit CRC-32C checksum of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

', ], ], 'ChecksumMode' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ChecksumMode' => '

To retrieve the checksum, this mode must be enabled.

General purpose buckets - In addition, if you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.

', 'HeadObjectRequest$ChecksumMode' => '

To retrieve the checksum, this parameter must be enabled.

General purpose buckets - If you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.

Directory buckets - If you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

', ], ], 'ChecksumSHA1' => [ 'base' => NULL, 'refs' => [ 'Checksum$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadOutput$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadRequest$ChecksumSHA1' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CompletedPart$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyObjectResult$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyPartResult$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'GetObjectOutput$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'HeadObjectOutput$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'ObjectPart$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'Part$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectOutput$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectRequest$ChecksumSHA1' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartOutput$ChecksumSHA1' => '

The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartRequest$ChecksumSHA1' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'WriteGetObjectResponseRequest$ChecksumSHA1' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 160-bit SHA-1 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

', ], ], 'ChecksumSHA256' => [ 'base' => NULL, 'refs' => [ 'Checksum$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadOutput$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CompleteMultipartUploadRequest$ChecksumSHA256' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CompletedPart$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyObjectResult$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'CopyPartResult$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'GetObjectOutput$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'HeadObjectOutput$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'ObjectPart$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'Part$ChecksumSHA256' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectOutput$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'PutObjectRequest$ChecksumSHA256' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartOutput$ChecksumSHA256' => '

The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it\'s a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

', 'UploadPartRequest$ChecksumSHA256' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

', 'WriteGetObjectResponseRequest$ChecksumSHA256' => '

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This specifies the base64-encoded, 256-bit SHA-256 digest of the object returned by the Object Lambda function. This may not match the checksum for the object stored in Amazon S3. Amazon S3 will perform validation of the checksum values only when the original GetObject request required checksum validation. For more information about checksums, see Checking object integrity in the Amazon S3 User Guide.

Only one checksum header can be specified at a time. If you supply multiple checksum headers, this request will fail.

', ], ], 'CloudFunction' => [ 'base' => NULL, 'refs' => [ 'CloudFunctionConfiguration$CloudFunction' => '

Lambda cloud function ARN that Amazon S3 can invoke when it detects events of the specified type.

', ], ], 'CloudFunctionConfiguration' => [ 'base' => '

Container for specifying the Lambda notification configuration.

', 'refs' => [ 'NotificationConfigurationDeprecated$CloudFunctionConfiguration' => '

Container for specifying the Lambda notification configuration.

', ], ], 'CloudFunctionInvocationRole' => [ 'base' => NULL, 'refs' => [ 'CloudFunctionConfiguration$InvocationRole' => '

The role supporting the invocation of the Lambda function

', ], ], 'Code' => [ 'base' => NULL, 'refs' => [ 'Error$Code' => '

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. The following is a list of Amazon S3 error codes. For more information, see Error responses.

', ], ], 'Comments' => [ 'base' => NULL, 'refs' => [ 'CSVInput$Comments' => '

A single character used to indicate that a row should be ignored when the character is present at the start of that row. You can specify any character to indicate a comment line. The default character is #.

Default: #

', ], ], 'CommonPrefix' => [ 'base' => '

Container for all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter. CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix. For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/.

', 'refs' => [ 'CommonPrefixList$member' => NULL, ], ], 'CommonPrefixList' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$CommonPrefixes' => '

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.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

', 'ListObjectVersionsOutput$CommonPrefixes' => '

All of the keys rolled up into a common prefix count as a single return when calculating the number of returns.

', 'ListObjectsOutput$CommonPrefixes' => '

All of the keys (up to 1,000) rolled up in a common prefix count as a single return when calculating the number of returns.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by the delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/), as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

', 'ListObjectsV2Output$CommonPrefixes' => '

All of the keys (up to 1,000) that share the same prefix are grouped together. When counting the total numbers of returns by this API operation, this group of keys is considered as one item.

A response can contain CommonPrefixes only if you specify a delimiter.

CommonPrefixes contains all (if there are any) keys between Prefix and the next occurrence of the string specified by a delimiter.

CommonPrefixes lists keys that act like subdirectories in the directory specified by Prefix.

For example, if the prefix is notes/ and the delimiter is a slash (/) as in notes/summer/july, the common prefix is notes/summer/. All of the keys that roll up into a common prefix count as a single return when calculating the number of returns.

', ], ], 'CompleteMultipartUploadOutput' => [ 'base' => NULL, 'refs' => [], ], 'CompleteMultipartUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'CompletedMultipartUpload' => [ 'base' => '

The container for the completed multipart upload details.

', 'refs' => [ 'CompleteMultipartUploadRequest$MultipartUpload' => '

The container for the multipart upload request information.

', ], ], 'CompletedPart' => [ 'base' => '

Details of the parts that were uploaded.

', 'refs' => [ 'CompletedPartList$member' => NULL, ], ], 'CompletedPartList' => [ 'base' => NULL, 'refs' => [ 'CompletedMultipartUpload$Parts' => '

Array of CompletedPart data types.

If you do not supply a valid Part with your request, the service sends back an HTTP 400 response.

', ], ], 'CompressionType' => [ 'base' => NULL, 'refs' => [ 'InputSerialization$CompressionType' => '

Specifies object\'s compression format. Valid values: NONE, GZIP, BZIP2. Default Value: NONE.

', ], ], 'Condition' => [ 'base' => '

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.

', 'refs' => [ 'RoutingRule$Condition' => '

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.

', ], ], 'ConfirmRemoveSelfBucketAccess' => [ 'base' => NULL, 'refs' => [ 'PutBucketPolicyRequest$ConfirmRemoveSelfBucketAccess' => '

Set this parameter to true to confirm that you want to remove your permissions to change this bucket policy in the future.

This functionality is not supported for directory buckets.

', ], ], 'ContentDisposition' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ContentDisposition' => '

Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.

', 'CreateMultipartUploadRequest$ContentDisposition' => '

Specifies presentational information for the object.

', 'GetObjectOutput$ContentDisposition' => '

Specifies presentational information for the object.

', 'HeadObjectOutput$ContentDisposition' => '

Specifies presentational information for the object.

', 'PutObjectRequest$ContentDisposition' => '

Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.

', 'WriteGetObjectResponseRequest$ContentDisposition' => '

Specifies presentational information for the object.

', ], ], 'ContentEncoding' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ContentEncoding' => '

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

For directory buckets, only the aws-chunked value is supported in this header field.

', 'CreateMultipartUploadRequest$ContentEncoding' => '

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

For directory buckets, only the aws-chunked value is supported in this header field.

', 'GetObjectOutput$ContentEncoding' => '

Indicates what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

', 'HeadObjectOutput$ContentEncoding' => '

Indicates what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

', 'PutObjectRequest$ContentEncoding' => '

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding.

', 'WriteGetObjectResponseRequest$ContentEncoding' => '

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

', ], ], 'ContentLanguage' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ContentLanguage' => '

The language the content is in.

', 'CreateMultipartUploadRequest$ContentLanguage' => '

The language that the content is in.

', 'GetObjectOutput$ContentLanguage' => '

The language the content is in.

', 'HeadObjectOutput$ContentLanguage' => '

The language the content is in.

', 'PutObjectRequest$ContentLanguage' => '

The language the content is in.

', 'WriteGetObjectResponseRequest$ContentLanguage' => '

The language the content is in.

', ], ], 'ContentLength' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$ContentLength' => '

Size of the body in bytes.

', 'HeadObjectOutput$ContentLength' => '

Size of the body in bytes.

', 'PutObjectRequest$ContentLength' => '

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.

', 'UploadPartRequest$ContentLength' => '

Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.

', 'WriteGetObjectResponseRequest$ContentLength' => '

The size of the content body in bytes.

', ], ], 'ContentMD5' => [ 'base' => NULL, 'refs' => [ 'PutBucketAclRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketCorsRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketEncryptionRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the server-side encryption configuration.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

This functionality is not supported for directory buckets.

', 'PutBucketLifecycleRequest$ContentMD5' => '

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketLoggingRequest$ContentMD5' => '

The MD5 hash of the PutBucketLogging request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketNotificationRequest$ContentMD5' => '

The MD5 hash of the PutPublicAccessBlock request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketOwnershipControlsRequest$ContentMD5' => '

The MD5 hash of the OwnershipControls request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketPolicyRequest$ContentMD5' => '

The MD5 hash of the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

This functionality is not supported for directory buckets.

', 'PutBucketReplicationRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketRequestPaymentRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketTaggingRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketVersioningRequest$ContentMD5' => '

>The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutBucketWebsiteRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. You must use this header as a message integrity check to verify that the request body was not corrupted in transit. For more information, see RFC 1864.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutObjectAclRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the data. This header must be used as a message integrity check to verify that the request body was not corrupted in transit. For more information, go to RFC 1864.>

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutObjectLegalHoldRequest$ContentMD5' => '

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutObjectLockConfigurationRequest$ContentMD5' => '

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutObjectRequest$ContentMD5' => '

The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more information about REST request authentication, see REST Authentication.

The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'PutObjectRetentionRequest$ContentMD5' => '

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutObjectTaggingRequest$ContentMD5' => '

The MD5 hash for the request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'PutPublicAccessBlockRequest$ContentMD5' => '

The MD5 hash of the PutPublicAccessBlock request body.

For requests made using the Amazon Web Services Command Line Interface (CLI) or Amazon Web Services SDKs, this field is calculated automatically.

', 'UploadPartRequest$ContentMD5' => '

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.

This functionality is not supported for directory buckets.

', ], ], 'ContentRange' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$ContentRange' => '

The portion of the object returned in the response.

', 'WriteGetObjectResponseRequest$ContentRange' => '

The portion of the object returned in the response.

', ], ], 'ContentType' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ContentType' => '

A standard MIME type that describes the format of the object data.

', 'CreateMultipartUploadRequest$ContentType' => '

A standard MIME type describing the format of the object data.

', 'GetObjectOutput$ContentType' => '

A standard MIME type describing the format of the object data.

', 'HeadObjectOutput$ContentType' => '

A standard MIME type describing the format of the object data.

', 'PutObjectRequest$ContentType' => '

A standard MIME type describing the format of the contents. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.

', 'WriteGetObjectResponseRequest$ContentType' => '

A standard MIME type describing the format of the object data.

', ], ], 'ContinuationEvent' => [ 'base' => '

', 'refs' => [ 'SelectObjectContentEventStream$Cont' => '

The Continuation Event.

', ], ], 'CopyObjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'CopyObjectRequest' => [ 'base' => NULL, 'refs' => [], ], 'CopyObjectResult' => [ 'base' => '

Container for all response elements.

', 'refs' => [ 'CopyObjectOutput$CopyObjectResult' => '

Container for all response elements.

', ], ], 'CopyPartResult' => [ 'base' => '

Container for all response elements.

', 'refs' => [ 'UploadPartCopyOutput$CopyPartResult' => '

Container for all response elements.

', ], ], 'CopySource' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySource' => '

Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket.

You specify the value of the copy source in one of two formats, depending on whether you want to access the source object through an access point:

If your source bucket versioning is enabled, the x-amz-copy-source header by default 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 query parameter. Specifically, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don\'t specify a version ID, Amazon S3 copies the latest version of the source object.

If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the copied object. 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 destination bucket, the version ID that Amazon S3 generates in the x-amz-version-id response header is always null.

Directory buckets - S3 Versioning isn\'t enabled and supported for directory buckets.

', 'UploadPartCopyRequest$CopySource' => '

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

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 source object to copy. To copy a specific version of the source object to copy, append ?versionId=<version-id> to the x-amz-copy-source request header (for example, x-amz-copy-source: /awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893).

If the current version is a delete marker and you don\'t specify a versionId in the x-amz-copy-source request header, Amazon S3 returns a 404 Not Found 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 Bad Request error, because you are not allowed to specify a delete marker as a version for the x-amz-copy-source.

Directory buckets - S3 Versioning isn\'t enabled and supported for directory buckets.

', ], ], 'CopySourceIfMatch' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceIfMatch' => '

Copies the object if its entity tag (ETag) matches the specified tag.

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:

', 'UploadPartCopyRequest$CopySourceIfMatch' => '

Copies the object if its entity tag (ETag) matches the specified tag.

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.

', ], ], 'CopySourceIfModifiedSince' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceIfModifiedSince' => '

Copies the object if it has been modified since the specified time.

If both 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:

', 'UploadPartCopyRequest$CopySourceIfModifiedSince' => '

Copies the object if it has been modified since the specified time.

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.

', ], ], 'CopySourceIfNoneMatch' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceIfNoneMatch' => '

Copies the object if its entity tag (ETag) is different than the specified ETag.

If both 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:

', 'UploadPartCopyRequest$CopySourceIfNoneMatch' => '

Copies the object if its entity tag (ETag) is different than the specified ETag.

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.

', ], ], 'CopySourceIfUnmodifiedSince' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceIfUnmodifiedSince' => '

Copies the object if it hasn\'t been modified since the specified time.

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:

', 'UploadPartCopyRequest$CopySourceIfUnmodifiedSince' => '

Copies the object if it hasn\'t been modified since the specified time.

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.

', ], ], 'CopySourceRange' => [ 'base' => NULL, 'refs' => [ 'UploadPartCopyRequest$CopySourceRange' => '

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.

', ], ], 'CopySourceSSECustomerAlgorithm' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceSSECustomerAlgorithm' => '

Specifies the algorithm to use when decrypting the source object (for example, AES256).

If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

This functionality is not supported when the source object is in a directory bucket.

', 'UploadPartCopyRequest$CopySourceSSECustomerAlgorithm' => '

Specifies the algorithm to use when decrypting the source object (for example, AES256).

This functionality is not supported when the source object is in a directory bucket.

', ], ], 'CopySourceSSECustomerKey' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceSSECustomerKey' => '

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be the same one that was used when the source object was created.

If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

This functionality is not supported when the source object is in a directory bucket.

', 'UploadPartCopyRequest$CopySourceSSECustomerKey' => '

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

This functionality is not supported when the source object is in a directory bucket.

', ], ], 'CopySourceSSECustomerKeyMD5' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$CopySourceSSECustomerKeyMD5' => '

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.

If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3 can decrypt the object for copying.

This functionality is not supported when the source object is in a directory bucket.

', 'UploadPartCopyRequest$CopySourceSSECustomerKeyMD5' => '

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.

This functionality is not supported when the source object is in a directory bucket.

', ], ], 'CopySourceVersionId' => [ 'base' => NULL, 'refs' => [ 'CopyObjectOutput$CopySourceVersionId' => '

Version ID of the source object that was copied.

This functionality is not supported when the source object is in a directory bucket.

', 'UploadPartCopyOutput$CopySourceVersionId' => '

The version of the source object that was copied, if you have enabled versioning on the source bucket.

This functionality is not supported when the source object is in a directory bucket.

', ], ], 'CreateBucketConfiguration' => [ 'base' => '

The configuration information for the bucket.

', 'refs' => [ 'CreateBucketRequest$CreateBucketConfiguration' => '

The configuration information for the bucket.

', ], ], 'CreateBucketOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateMultipartUploadOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateMultipartUploadRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateSessionOutput' => [ 'base' => NULL, 'refs' => [], ], 'CreateSessionRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreationDate' => [ 'base' => NULL, 'refs' => [ 'Bucket$CreationDate' => '

Date the bucket was created. This date can change when making changes to your bucket, such as editing its bucket policy.

', ], ], 'DataRedundancy' => [ 'base' => NULL, 'refs' => [ 'BucketInfo$DataRedundancy' => '

The number of Availability Zone that\'s used for redundancy for the bucket.

', ], ], 'Date' => [ 'base' => NULL, 'refs' => [ 'LifecycleExpiration$Date' => '

Indicates at what date the object is to be moved or deleted. The date value must conform to the ISO 8601 format. The time is always midnight UTC.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'ObjectLockRetention$RetainUntilDate' => '

The date on which this Object Lock Retention will expire.

', 'Transition$Date' => '

Indicates when objects are transitioned to the specified storage class. The date value must be in ISO 8601 format. The time is always midnight UTC.

', ], ], 'Days' => [ 'base' => NULL, 'refs' => [ 'DefaultRetention$Days' => '

The number of days that you want to specify for the default retention period. Must be used with Mode.

', 'LifecycleExpiration$Days' => '

Indicates the lifetime, in days, of the objects that are subject to the rule. The value must be a non-zero positive integer.

', 'NoncurrentVersionExpiration$NoncurrentDays' => '

Specifies the number of days an object is noncurrent before Amazon S3 can perform the associated action. The value must be a non-zero positive integer. For information about the noncurrent days calculations, see How Amazon S3 Calculates When an Object Became Noncurrent in the Amazon S3 User Guide.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'NoncurrentVersionTransition$NoncurrentDays' => '

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 S3 User Guide.

', 'RestoreRequest$Days' => '

Lifetime of the active copy in days. Do not use with restores that specify OutputLocation.

The Days element is required for regular restores, and must not be provided for select requests.

', 'Transition$Days' => '

Indicates the number of days after creation when objects are transitioned to the specified storage class. The value must be a positive integer.

', ], ], 'DaysAfterInitiation' => [ 'base' => NULL, 'refs' => [ 'AbortIncompleteMultipartUpload$DaysAfterInitiation' => '

Specifies the number of days after which Amazon S3 aborts an incomplete multipart upload.

', ], ], 'DefaultRetention' => [ 'base' => '

The container element for optionally specifying the default Object Lock retention settings for new objects placed in the specified bucket.

', 'refs' => [ 'ObjectLockRule$DefaultRetention' => '

The default Object Lock retention mode and period that you want to apply to new objects placed in the specified bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

', ], ], 'Delete' => [ 'base' => '

Container for the objects to delete.

', 'refs' => [ 'DeleteObjectsRequest$Delete' => '

Container for the request.

', ], ], 'DeleteBucketAnalyticsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketCorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketEncryptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketIntelligentTieringConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketInventoryConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketLifecycleRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketMetricsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketOwnershipControlsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketReplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketTaggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteBucketWebsiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteMarker' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectOutput$DeleteMarker' => '

Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.

This functionality is not supported for directory buckets.

', 'DeletedObject$DeleteMarker' => '

Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion. In a simple DELETE, this header indicates whether (true) or not (false) the current version of the object is a delete marker.

This functionality is not supported for directory buckets.

', 'GetObjectAttributesOutput$DeleteMarker' => '

Specifies whether the object retrieved was (true) or was not (false) a delete marker. If false, this response header does not appear in the response.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$DeleteMarker' => '

Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

', 'HeadObjectOutput$DeleteMarker' => '

Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$DeleteMarker' => '

Specifies whether an object stored in Amazon S3 is (true) or is not (false) a delete marker.

', ], ], 'DeleteMarkerEntry' => [ 'base' => '

Information about the delete marker.

', 'refs' => [ 'DeleteMarkers$member' => NULL, ], ], 'DeleteMarkerReplication' => [ 'base' => '

Specifies whether Amazon S3 replicates delete markers. If you specify a Filter in your replication configuration, you must also include a DeleteMarkerReplication element. If your Filter includes a Tag element, the DeleteMarkerReplication Status must be set to Disabled, because Amazon S3 does not support replicating delete markers for tag-based rules. For an example configuration, see Basic Rule Configuration.

For more information about delete marker replication, see Basic Rule Configuration.

If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility.

', 'refs' => [ 'ReplicationRule$DeleteMarkerReplication' => NULL, ], ], 'DeleteMarkerReplicationStatus' => [ 'base' => NULL, 'refs' => [ 'DeleteMarkerReplication$Status' => '

Indicates whether to replicate delete markers.

Indicates whether to replicate delete markers.

', ], ], 'DeleteMarkerVersionId' => [ 'base' => NULL, 'refs' => [ 'DeletedObject$DeleteMarkerVersionId' => '

The version ID of the delete marker created as a result of the DELETE operation. If you delete a specific object version, the value returned by this header is the version ID of the object version deleted.

This functionality is not supported for directory buckets.

', ], ], 'DeleteMarkers' => [ 'base' => NULL, 'refs' => [ 'ListObjectVersionsOutput$DeleteMarkers' => '

Container for an object that is a delete marker.

', ], ], 'DeleteObjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteObjectRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteObjectTaggingOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteObjectTaggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeleteObjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'DeleteObjectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePublicAccessBlockRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletedObject' => [ 'base' => '

Information about the deleted object.

', 'refs' => [ 'DeletedObjects$member' => NULL, ], ], 'DeletedObjects' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectsOutput$Deleted' => '

Container element for a successful delete. It identifies the object that was successfully deleted.

', ], ], 'Delimiter' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$Delimiter' => '

Contains the delimiter you specified in the request. If you don\'t specify a delimiter in your request, this element is absent from the response.

Directory buckets - For directory buckets, / is the only supported delimiter.

', 'ListMultipartUploadsRequest$Delimiter' => '

Character you use to group keys.

All keys that contain the same string between the prefix, if specified, and the first occurrence of the delimiter after the prefix are grouped under a single result element, CommonPrefixes. If you don\'t specify the prefix parameter, then the substring starts at the beginning of the key. The keys that are grouped under CommonPrefixes result element are not returned elsewhere in the response.

Directory buckets - For directory buckets, / is the only supported delimiter.

', 'ListObjectVersionsOutput$Delimiter' => '

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.

', 'ListObjectVersionsRequest$Delimiter' => '

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.

', 'ListObjectsOutput$Delimiter' => '

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.

', 'ListObjectsRequest$Delimiter' => '

A delimiter is a character that you use to group keys.

', 'ListObjectsV2Output$Delimiter' => '

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.

Directory buckets - For directory buckets, / is the only supported delimiter.

', 'ListObjectsV2Request$Delimiter' => '

A delimiter is a character that you use to group keys.

', ], ], 'Description' => [ 'base' => NULL, 'refs' => [ 'RestoreRequest$Description' => '

The optional description for the job.

', ], ], 'Destination' => [ 'base' => '

Specifies information about where to publish analysis or configuration results for an Amazon S3 bucket and S3 Replication Time Control (S3 RTC).

', 'refs' => [ 'ReplicationRule$Destination' => '

A container for information about the replication destination and its configurations including enabling the S3 Replication Time Control (S3 RTC).

', ], ], 'DirectoryBucketToken' => [ 'base' => NULL, 'refs' => [ 'ListDirectoryBucketsOutput$ContinuationToken' => '

If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response.

', 'ListDirectoryBucketsRequest$ContinuationToken' => '

ContinuationToken indicates to Amazon S3 that the list is being continued on buckets in this account with a token. ContinuationToken is obfuscated and is not a real bucket name. You can use this ContinuationToken for the pagination of the list results.

', ], ], 'DisplayName' => [ 'base' => NULL, 'refs' => [ 'Grantee$DisplayName' => '

Screen name of the grantee.

', 'Initiator$DisplayName' => '

Name of the Principal.

This functionality is not supported for directory buckets.

', 'Owner$DisplayName' => '

Container for the display name of the owner. This value is only supported in the following Amazon Web Services Regions:

This functionality is not supported for directory buckets.

', ], ], 'ETag' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$ETag' => '

Entity tag that identifies the newly created object\'s data. Objects with different object data will have different entity tags. The entity tag is an opaque string. The entity tag may or may not be an MD5 digest of the object data. If the entity tag is not an MD5 digest of the object data, it will contain one or more nonhexadecimal characters and/or will consist of less than 32 or more than 32 hexadecimal digits. For more information about how the entity tag is calculated, see Checking object integrity in the Amazon S3 User Guide.

', 'CompletedPart$ETag' => '

Entity tag returned when the part was uploaded.

', 'CopyObjectResult$ETag' => '

Returns the ETag of the new object. The ETag reflects only changes to the contents of an object, not its metadata.

', 'CopyPartResult$ETag' => '

Entity tag of the object.

', 'GetObjectAttributesOutput$ETag' => '

An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

', 'GetObjectOutput$ETag' => '

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

', 'HeadObjectOutput$ETag' => '

An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.

', 'Object$ETag' => '

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

Directory buckets - MD5 is not supported by directory buckets.

', 'ObjectIdentifier$ETag' => '

An entity tag (ETag) is an identifier assigned by a web server to a specific version of a resource found at a URL. This header field makes the request method conditional on ETags.

Entity tags (ETags) for S3 Express One Zone are random alphanumeric strings unique to the object.

', 'ObjectVersion$ETag' => '

The entity tag is an MD5 hash of that version of the object.

', 'Part$ETag' => '

Entity tag returned when the part was uploaded.

', 'PutObjectOutput$ETag' => '

Entity tag for the uploaded object.

General purpose buckets - To ensure that data is not corrupted traversing the network, for objects where the ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.

Directory buckets - The ETag for the object in a directory bucket isn\'t the MD5 digest of the object.

', 'UploadPartOutput$ETag' => '

Entity tag for the uploaded object.

', 'WriteGetObjectResponseRequest$ETag' => '

An opaque identifier assigned by a web server to a specific version of a resource found at a URL.

', ], ], 'EmailAddress' => [ 'base' => NULL, 'refs' => [ 'Grantee$EmailAddress' => '

Email address of the grantee.

Using email addresses to specify a grantee is only supported in the following Amazon Web Services Regions:

For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the Amazon Web Services General Reference.

', ], ], 'EnableRequestProgress' => [ 'base' => NULL, 'refs' => [ 'RequestProgress$Enabled' => '

Specifies whether periodic QueryProgress frames should be sent. Valid values: TRUE, FALSE. Default value: FALSE.

', ], ], 'EncodingType' => [ 'base' => '

Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can\'t parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren\'t supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.

When using the URL encoding type, non-ASCII characters that are used in an object\'s key name will be percent-encoded according to UTF-8 code values. For example, the object test_file(3).png will appear as test_file%283%29.png.

', 'refs' => [ 'ListMultipartUploadsOutput$EncodingType' => '

Encoding type used by Amazon S3 to encode object keys in the response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, KeyMarker, Prefix, NextKeyMarker, Key.

', 'ListMultipartUploadsRequest$EncodingType' => NULL, 'ListObjectVersionsOutput$EncodingType' => '

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

KeyMarker, NextKeyMarker, Prefix, Key, and Delimiter.

', 'ListObjectVersionsRequest$EncodingType' => NULL, 'ListObjectsOutput$EncodingType' => '

Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can\'t parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren\'t supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.

When using the URL encoding type, non-ASCII characters that are used in an object\'s key name will be percent-encoded according to UTF-8 code values. For example, the object test_file(3).png will appear as test_file%283%29.png.

', 'ListObjectsRequest$EncodingType' => NULL, 'ListObjectsV2Output$EncodingType' => '

Encoding type used by Amazon S3 to encode object key names in the XML response.

If you specify the encoding-type request parameter, Amazon S3 includes this element in the response, and returns encoded key name values in the following response elements:

Delimiter, Prefix, Key, and StartAfter.

', 'ListObjectsV2Request$EncodingType' => '

Encoding type used by Amazon S3 to encode the object keys in the response. Responses are encoded only in UTF-8. An object key can contain any Unicode character. However, the XML 1.0 parser can\'t parse certain characters, such as characters with an ASCII value from 0 to 10. For characters that aren\'t supported in XML 1.0, you can add this parameter to request that Amazon S3 encode the keys in the response. For more information about characters to avoid in object key names, see Object key naming guidelines.

When using the URL encoding type, non-ASCII characters that are used in an object\'s key name will be percent-encoded according to UTF-8 code values. For example, the object test_file(3).png will appear as test_file%283%29.png.

', ], ], 'Encryption' => [ 'base' => '

Contains the type of server-side encryption used.

', 'refs' => [ 'S3Location$Encryption' => NULL, ], ], 'EncryptionConfiguration' => [ 'base' => '

Specifies encryption-related information for an Amazon S3 bucket that is a destination for replicated objects.

If you\'re specifying a customer managed KMS key, we recommend using a fully qualified KMS key ARN. If you use a KMS key alias instead, then KMS resolves the key within the requester’s account. This behavior can result in data that\'s encrypted with a KMS key that belongs to the requester, and not the bucket owner.

', 'refs' => [ 'Destination$EncryptionConfiguration' => '

A container that provides information about encryption. If SourceSelectionCriteria is specified, you must specify this element.

', ], ], 'EncryptionTypeMismatch' => [ 'base' => '

The existing object was created with a different encryption type. Subsequent write requests must include the appropriate encryption parameters in the request or while creating the session.

', 'refs' => [], ], 'End' => [ 'base' => NULL, 'refs' => [ 'ScanRange$End' => '

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.

', ], ], 'EndEvent' => [ 'base' => '

A message that indicates the request is complete and no more messages will be sent. You should not assume that the request is complete until the client receives an EndEvent.

', 'refs' => [ 'SelectObjectContentEventStream$End' => '

The End Event.

', ], ], 'Error' => [ 'base' => '

Container for all error elements.

', 'refs' => [ 'Errors$member' => NULL, ], ], 'ErrorCode' => [ 'base' => NULL, 'refs' => [ 'WriteGetObjectResponseRequest$ErrorCode' => '

A string that uniquely identifies an error condition. Returned in the <Code> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in the body. All error codes from S3 are sentence-cased. The regular expression (regex) value is "^[A-Z][a-zA-Z]+$".

', ], ], 'ErrorDocument' => [ 'base' => '

The error information.

', 'refs' => [ 'GetBucketWebsiteOutput$ErrorDocument' => '

The object key name of the website error document to use for 4XX class errors.

', 'WebsiteConfiguration$ErrorDocument' => '

The name of the error document for the website.

', ], ], 'ErrorMessage' => [ 'base' => NULL, 'refs' => [ 'WriteGetObjectResponseRequest$ErrorMessage' => '

Contains a generic description of the error condition. Returned in the <Message> tag of the error XML response for a corresponding GetObject call. Cannot be used with a successful StatusCode header or when the transformed object is provided in body.

', ], ], 'Errors' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectsOutput$Errors' => '

Container for a failed delete action that describes the object that Amazon S3 attempted to delete and the error it encountered.

', ], ], 'Event' => [ 'base' => '

The bucket event for which to send notifications.

', 'refs' => [ 'CloudFunctionConfiguration$Event' => NULL, 'EventList$member' => NULL, 'QueueConfigurationDeprecated$Event' => NULL, 'TopicConfigurationDeprecated$Event' => '

Bucket event for which to send notifications.

', ], ], 'EventBridgeConfiguration' => [ 'base' => '

A container for specifying the configuration for Amazon EventBridge.

', 'refs' => [ 'NotificationConfiguration$EventBridgeConfiguration' => '

Enables delivery of events to Amazon EventBridge.

', ], ], 'EventList' => [ 'base' => NULL, 'refs' => [ 'CloudFunctionConfiguration$Events' => '

Bucket events for which to send notifications.

', 'LambdaFunctionConfiguration$Events' => '

The Amazon S3 bucket event for which to invoke the Lambda function. For more information, see Supported Event Types in the Amazon S3 User Guide.

', 'QueueConfiguration$Events' => '

A collection of bucket events for which to send notifications

', 'QueueConfigurationDeprecated$Events' => '

A collection of bucket events for which to send notifications.

', 'TopicConfiguration$Events' => '

The Amazon S3 bucket event about which to send notifications. For more information, see Supported Event Types in the Amazon S3 User Guide.

', 'TopicConfigurationDeprecated$Events' => '

A collection of events related to objects

', ], ], 'ExistingObjectReplication' => [ 'base' => '

Optional configuration to replicate existing source bucket objects.

This parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the Amazon S3 User Guide.

', 'refs' => [ 'ReplicationRule$ExistingObjectReplication' => '

Optional configuration to replicate existing source bucket objects.

This parameter is no longer supported. To replicate existing objects, see Replicating existing objects with S3 Batch Replication in the Amazon S3 User Guide.

', ], ], 'ExistingObjectReplicationStatus' => [ 'base' => NULL, 'refs' => [ 'ExistingObjectReplication$Status' => '

Specifies whether Amazon S3 replicates existing source bucket objects.

', ], ], 'Expiration' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$Expiration' => '

If the object expiration is configured, this will contain the expiration date (expiry-date) and rule ID (rule-id). The value of rule-id is URL-encoded.

This functionality is not supported for directory buckets.

', 'CopyObjectOutput$Expiration' => '

If the object expiration is configured, the response includes this header.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$Expiration' => '

If the object expiration is configured (see PutBucketLifecycleConfiguration ), 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.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$Expiration' => '

If the object expiration is configured (see PutBucketLifecycleConfiguration ), 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.

This functionality is not supported for directory buckets.

', 'PutObjectOutput$Expiration' => '

If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header. It includes the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$Expiration' => '

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 that provide the object expiration information. The value of the rule-id is URL-encoded.

', ], ], 'ExpirationStatus' => [ 'base' => NULL, 'refs' => [ 'LifecycleRule$Status' => '

If \'Enabled\', the rule is currently being applied. If \'Disabled\', the rule is not currently being applied.

', 'Rule$Status' => '

If Enabled, the rule is currently being applied. If Disabled, the rule is not currently being applied.

', ], ], 'ExpiredObjectDeleteMarker' => [ 'base' => NULL, 'refs' => [ 'LifecycleExpiration$ExpiredObjectDeleteMarker' => '

Indicates whether Amazon S3 will remove a delete marker with no noncurrent versions. If set to true, the delete marker will be expired; if set to false the policy takes no action. This cannot be specified with Days or Date in a Lifecycle Expiration Policy.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', ], ], 'Expires' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$Expires' => '

The date and time at which the object is no longer cacheable.

', 'CreateMultipartUploadRequest$Expires' => '

The date and time at which the object is no longer cacheable.

', 'GetObjectOutput$Expires' => '

The date and time at which the object is no longer cacheable.

', 'HeadObjectOutput$Expires' => '

The date and time at which the object is no longer cacheable.

', 'PutObjectRequest$Expires' => '

The date and time at which the object is no longer cacheable. For more information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3.

', 'WriteGetObjectResponseRequest$Expires' => '

The date and time at which the object is no longer cacheable.

', ], ], 'ExposeHeader' => [ 'base' => NULL, 'refs' => [ 'ExposeHeaders$member' => NULL, ], ], 'ExposeHeaders' => [ 'base' => NULL, 'refs' => [ 'CORSRule$ExposeHeaders' => '

One or more headers in the response that you want customers to be able to access from their applications (for example, from a JavaScript XMLHttpRequest object).

', ], ], 'Expression' => [ 'base' => NULL, 'refs' => [ 'SelectObjectContentRequest$Expression' => '

The expression that is used to query the object.

', 'SelectParameters$Expression' => '

The expression that is used to query the object.

', ], ], 'ExpressionType' => [ 'base' => NULL, 'refs' => [ 'SelectObjectContentRequest$ExpressionType' => '

The type of the provided expression (for example, SQL).

', 'SelectParameters$ExpressionType' => '

The type of the provided expression (for example, SQL).

', ], ], 'FetchOwner' => [ 'base' => NULL, 'refs' => [ 'ListObjectsV2Request$FetchOwner' => '

The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.

Directory buckets - For directory buckets, the bucket owner is returned as the object owner for all objects.

', ], ], 'FieldDelimiter' => [ 'base' => NULL, 'refs' => [ 'CSVInput$FieldDelimiter' => '

A single character used to separate individual fields in a record. You can specify an arbitrary delimiter.

', 'CSVOutput$FieldDelimiter' => '

The value used to separate individual fields in a record. You can specify an arbitrary delimiter.

', ], ], 'FileHeaderInfo' => [ 'base' => NULL, 'refs' => [ 'CSVInput$FileHeaderInfo' => '

Describes the first line of input. Valid values are:

', ], ], 'FilterRule' => [ 'base' => '

Specifies the Amazon S3 object key name to filter on. An object key name is the name assigned to an object in your Amazon S3 bucket. You specify whether to filter on the suffix or prefix of the object key name. A prefix is a specific string of characters at the beginning of an object key name, which you can use to organize objects. For example, you can start the key names of related objects with a prefix, such as 2023- or engineering/. Then, you can use FilterRule to find objects in a bucket with key names that have the same prefix. A suffix is similar to a prefix, but it is at the end of the object key name instead of at the beginning.

', 'refs' => [ 'FilterRuleList$member' => NULL, ], ], 'FilterRuleList' => [ 'base' => '

A list of containers for the key-value pair that defines the criteria for the filter rule.

', 'refs' => [ 'S3KeyFilter$FilterRules' => NULL, ], ], 'FilterRuleName' => [ 'base' => NULL, 'refs' => [ 'FilterRule$Name' => '

The object key name prefix or suffix identifying one or more objects to which the filtering rule applies. The maximum length is 1,024 characters. Overlapping prefixes and suffixes are not supported. For more information, see Configuring Event Notifications in the Amazon S3 User Guide.

', ], ], 'FilterRuleValue' => [ 'base' => NULL, 'refs' => [ 'FilterRule$Value' => '

The value that the filter searches for in object key names.

', ], ], 'GetBucketAccelerateConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAccelerateConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAclOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAclRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAnalyticsConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketAnalyticsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketCorsOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketCorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketEncryptionOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketEncryptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketIntelligentTieringConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketIntelligentTieringConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketInventoryConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketInventoryConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLifecycleConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLifecycleConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLifecycleOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLifecycleRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLocationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLocationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLoggingOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketLoggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketMetricsConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketMetricsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketNotificationConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketOwnershipControlsOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketOwnershipControlsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketPolicyOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketPolicyStatusOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketPolicyStatusRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketReplicationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketReplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketRequestPaymentOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketRequestPaymentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketTaggingOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketTaggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketVersioningOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketVersioningRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketWebsiteOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetBucketWebsiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectAclOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectAclRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectAttributesOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectAttributesParts' => [ 'base' => '

A collection of parts associated with a multipart upload.

', 'refs' => [ 'GetObjectAttributesOutput$ObjectParts' => '

A collection of parts associated with a multipart upload.

', ], ], 'GetObjectAttributesRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectLegalHoldOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectLegalHoldRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectLockConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectLockConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectResponseStatusCode' => [ 'base' => NULL, 'refs' => [ 'WriteGetObjectResponseRequest$StatusCode' => '

The integer status code for an HTTP response of a corresponding GetObject request. The following is a list of status codes.

', ], ], 'GetObjectRetentionOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectRetentionRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectTaggingOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectTaggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectTorrentOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetObjectTorrentRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPublicAccessBlockOutput' => [ 'base' => NULL, 'refs' => [], ], 'GetPublicAccessBlockRequest' => [ 'base' => NULL, 'refs' => [], ], 'GlacierJobParameters' => [ 'base' => '

Container for S3 Glacier job parameters.

', 'refs' => [ 'RestoreRequest$GlacierJobParameters' => '

S3 Glacier related parameters pertaining to this job. Do not use with restores that specify OutputLocation.

', ], ], 'Grant' => [ 'base' => '

Container for grant information.

', 'refs' => [ 'Grants$member' => NULL, ], ], 'GrantFullControl' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$GrantFullControl' => '

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

', 'CreateBucketRequest$GrantFullControl' => '

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$GrantFullControl' => '

Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

You specify each grantee as a type=value pair, where the type is one of the following:

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

x-amz-grant-read: id="11112222333", id="444455556666"

', 'PutBucketAclRequest$GrantFullControl' => '

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

', 'PutObjectAclRequest$GrantFullControl' => '

Allows grantee the read, write, read ACP, and write ACP permissions on the bucket.

This functionality is not supported for Amazon S3 on Outposts.

', 'PutObjectRequest$GrantFullControl' => '

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

', ], ], 'GrantRead' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$GrantRead' => '

Allows grantee to read the object data and its metadata.

', 'CreateBucketRequest$GrantRead' => '

Allows grantee to list the objects in the bucket.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$GrantRead' => '

Specify access permissions explicitly to allow grantee to read the object data and its metadata.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

You specify each grantee as a type=value pair, where the type is one of the following:

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

x-amz-grant-read: id="11112222333", id="444455556666"

', 'PutBucketAclRequest$GrantRead' => '

Allows grantee to list the objects in the bucket.

', 'PutObjectAclRequest$GrantRead' => '

Allows grantee to list the objects in the bucket.

This functionality is not supported for Amazon S3 on Outposts.

', 'PutObjectRequest$GrantRead' => '

Allows grantee to read the object data and its metadata.

', ], ], 'GrantReadACP' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$GrantReadACP' => '

Allows grantee to read the object ACL.

', 'CreateBucketRequest$GrantReadACP' => '

Allows grantee to read the bucket ACL.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$GrantReadACP' => '

Specify access permissions explicitly to allows grantee to read the object ACL.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

You specify each grantee as a type=value pair, where the type is one of the following:

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

x-amz-grant-read: id="11112222333", id="444455556666"

', 'PutBucketAclRequest$GrantReadACP' => '

Allows grantee to read the bucket ACL.

', 'PutObjectAclRequest$GrantReadACP' => '

Allows grantee to read the bucket ACL.

This functionality is not supported for Amazon S3 on Outposts.

', 'PutObjectRequest$GrantReadACP' => '

Allows grantee to read the object ACL.

', ], ], 'GrantWrite' => [ 'base' => NULL, 'refs' => [ 'CreateBucketRequest$GrantWrite' => '

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

This functionality is not supported for directory buckets.

', 'PutBucketAclRequest$GrantWrite' => '

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

', 'PutObjectAclRequest$GrantWrite' => '

Allows grantee to create new objects in the bucket.

For the bucket and object owners of existing objects, also allows deletions and overwrites of those objects.

', ], ], 'GrantWriteACP' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$GrantWriteACP' => '

Allows grantee to write the ACL for the applicable object.

', 'CreateBucketRequest$GrantWriteACP' => '

Allows grantee to write the ACL for the applicable bucket.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$GrantWriteACP' => '

Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can use this header to explicitly grant access permissions to specific Amazon Web Services accounts or groups. This header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview in the Amazon S3 User Guide.

You specify each grantee as a type=value pair, where the type is one of the following:

For example, the following x-amz-grant-read header grants the Amazon Web Services accounts identified by account IDs permissions to read object data and its metadata:

x-amz-grant-read: id="11112222333", id="444455556666"

', 'PutBucketAclRequest$GrantWriteACP' => '

Allows grantee to write the ACL for the applicable bucket.

', 'PutObjectAclRequest$GrantWriteACP' => '

Allows grantee to write the ACL for the applicable bucket.

This functionality is not supported for Amazon S3 on Outposts.

', 'PutObjectRequest$GrantWriteACP' => '

Allows grantee to write the ACL for the applicable object.

', ], ], 'Grantee' => [ 'base' => '

Container for the person being granted permissions.

', 'refs' => [ 'Grant$Grantee' => '

The person being granted permissions.

', 'TargetGrant$Grantee' => '

Container for the person being granted permissions.

', ], ], 'Grants' => [ 'base' => NULL, 'refs' => [ 'AccessControlPolicy$Grants' => '

A list of grants.

', 'GetBucketAclOutput$Grants' => '

A list of grants.

', 'GetObjectAclOutput$Grants' => '

A list of grants.

', 'S3Location$AccessControlList' => '

A list of grants that control access to the staged results.

', ], ], 'HeadBucketOutput' => [ 'base' => NULL, 'refs' => [], ], 'HeadBucketRequest' => [ 'base' => NULL, 'refs' => [], ], 'HeadObjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'HeadObjectRequest' => [ 'base' => NULL, 'refs' => [], ], 'HostName' => [ 'base' => NULL, 'refs' => [ 'Redirect$HostName' => '

The host name to use in the redirect request.

', 'RedirectAllRequestsTo$HostName' => '

Name of the host where requests are redirected.

', ], ], 'HttpErrorCodeReturnedEquals' => [ 'base' => NULL, 'refs' => [ 'Condition$HttpErrorCodeReturnedEquals' => '

The HTTP error code when the redirect is applied. In the event of an error, if the error code equals this value, then the specified redirect is applied. Required when parent element Condition is specified and sibling KeyPrefixEquals is not specified. If both are specified, then both must be true for the redirect to be applied.

', ], ], 'HttpRedirectCode' => [ 'base' => NULL, 'refs' => [ 'Redirect$HttpRedirectCode' => '

The HTTP redirect code to use on the response. Not required if one of the siblings is present.

', ], ], 'ID' => [ 'base' => NULL, 'refs' => [ 'CORSRule$ID' => '

Unique identifier for the rule. The value cannot be longer than 255 characters.

', 'Grantee$ID' => '

The canonical user ID of the grantee.

', 'Initiator$ID' => '

If the principal is an Amazon Web Services account, it provides the Canonical User ID. If the principal is an IAM User, it provides a user ARN value.

Directory buckets - If the principal is an Amazon Web Services account, it provides the Amazon Web Services account ID. If the principal is an IAM User, it provides a user ARN value.

', 'LifecycleRule$ID' => '

Unique identifier for the rule. The value cannot be longer than 255 characters.

', 'Owner$ID' => '

Container for the ID of the owner.

', 'ReplicationRule$ID' => '

A unique identifier for the rule. The maximum value is 255 characters.

', 'Rule$ID' => '

Unique identifier for the rule. The value can\'t be longer than 255 characters.

', ], ], 'IfMatch' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadRequest$IfMatch' => '

Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should fetch the object\'s ETag, re-initiate the multipart upload with CreateMultipartUpload, and re-upload each part.

Expects the ETag value as a string.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

', 'DeleteObjectRequest$IfMatch' => '

The If-Match header field makes the request method conditional on ETags. If the ETag value does not match, the operation returns a 412 Precondition Failed error. If the ETag matches or if the object doesn\'t exist, the operation will return a 204 Success (No Content) response.

For more information about conditional requests, see RFC 7232.

This functionality is only supported for directory buckets.

', 'GetObjectRequest$IfMatch' => '

Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a 412 Precondition Failed error.

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.

For more information about conditional requests, see RFC 7232.

', 'HeadObjectRequest$IfMatch' => '

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

', 'PutObjectRequest$IfMatch' => '

Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should fetch the object\'s ETag and retry the upload.

Expects the ETag value as a string.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

', ], ], 'IfMatchInitiatedTime' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartUploadRequest$IfMatchInitiatedTime' => '

If present, this header aborts an in progress multipart upload only if it was initiated on the provided timestamp. If the initiated timestamp of the multipart upload does not match the provided value, the operation returns a 412 Precondition Failed error. If the initiated timestamp matches or if the multipart upload doesn’t exist, the operation returns a 204 Success (No Content) response.

This functionality is only supported for directory buckets.

', ], ], 'IfMatchLastModifiedTime' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectRequest$IfMatchLastModifiedTime' => '

If present, the object is deleted only if its modification times matches the provided Timestamp. If the Timestamp values do not match, the operation returns a 412 Precondition Failed error. If the Timestamp matches or if the object doesn’t exist, the operation returns a 204 Success (No Content) response.

This functionality is only supported for directory buckets.

', ], ], 'IfMatchSize' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectRequest$IfMatchSize' => '

If present, the object is deleted only if its size matches the provided size in bytes. If the Size value does not match, the operation returns a 412 Precondition Failed error. If the Size matches or if the object doesn’t exist, the operation returns a 204 Success (No Content) response.

This functionality is only supported for directory buckets.

You can use the If-Match, x-amz-if-match-last-modified-time and x-amz-if-match-size conditional headers in conjunction with each-other or individually.

', ], ], 'IfModifiedSince' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$IfModifiedSince' => '

Return the object only if it has been modified since the specified time; otherwise, return a 304 Not Modified error.

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 status code.

For more information about conditional requests, see RFC 7232.

', 'HeadObjectRequest$IfModifiedSince' => '

Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

', ], ], 'IfNoneMatch' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadRequest$IfNoneMatch' => '

Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should re-initiate the multipart upload with CreateMultipartUpload and re-upload each part.

Expects the \'*\' (asterisk) character.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

', 'GetObjectRequest$IfNoneMatch' => '

Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a 304 Not Modified error.

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 HTTP status code.

For more information about conditional requests, see RFC 7232.

', 'HeadObjectRequest$IfNoneMatch' => '

Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

', 'PutObjectRequest$IfNoneMatch' => '

Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should retry the upload.

Expects the \'*\' (asterisk) character.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

', ], ], 'IfUnmodifiedSince' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$IfUnmodifiedSince' => '

Return the object only if it has not been modified since the specified time; otherwise, return a 412 Precondition Failed error.

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.

For more information about conditional requests, see RFC 7232.

', 'HeadObjectRequest$IfUnmodifiedSince' => '

Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

', ], ], 'IndexDocument' => [ 'base' => '

Container for the Suffix element.

', 'refs' => [ 'GetBucketWebsiteOutput$IndexDocument' => '

The name of the index document for the website (for example index.html).

', 'WebsiteConfiguration$IndexDocument' => '

The name of the index document for the website.

', ], ], 'Initiated' => [ 'base' => NULL, 'refs' => [ 'MultipartUpload$Initiated' => '

Date and time at which the multipart upload was initiated.

', ], ], 'Initiator' => [ 'base' => '

Container element that identifies who initiated the multipart upload.

', 'refs' => [ 'ListPartsOutput$Initiator' => '

Container element that identifies who initiated the multipart upload. If the initiator is an Amazon Web Services 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.

', 'MultipartUpload$Initiator' => '

Identifies who initiated the multipart upload.

', ], ], 'InputSerialization' => [ 'base' => '

Describes the serialization format of the object.

', 'refs' => [ 'SelectObjectContentRequest$InputSerialization' => '

Describes the format of the data in the object that is being queried.

', 'SelectParameters$InputSerialization' => '

Describes the serialization format of the object.

', ], ], 'IntelligentTieringAccessTier' => [ 'base' => NULL, 'refs' => [ 'InvalidObjectState$AccessTier' => NULL, 'Tiering$AccessTier' => '

S3 Intelligent-Tiering access tier. See Storage class for automatically optimizing frequently and infrequently accessed objects for a list of access tiers in the S3 Intelligent-Tiering storage class.

', ], ], 'IntelligentTieringAndOperator' => [ 'base' => '

A container for specifying S3 Intelligent-Tiering filters. The filters determine the subset of objects to which the rule applies.

', 'refs' => [ 'IntelligentTieringFilter$And' => '

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

', ], ], 'IntelligentTieringConfiguration' => [ 'base' => '

Specifies the S3 Intelligent-Tiering configuration for an Amazon S3 bucket.

For information about the S3 Intelligent-Tiering storage class, see Storage class for automatically optimizing frequently and infrequently accessed objects.

', 'refs' => [ 'GetBucketIntelligentTieringConfigurationOutput$IntelligentTieringConfiguration' => '

Container for S3 Intelligent-Tiering configuration.

', 'IntelligentTieringConfigurationList$member' => NULL, 'PutBucketIntelligentTieringConfigurationRequest$IntelligentTieringConfiguration' => '

Container for S3 Intelligent-Tiering configuration.

', ], ], 'IntelligentTieringConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListBucketIntelligentTieringConfigurationsOutput$IntelligentTieringConfigurationList' => '

The list of S3 Intelligent-Tiering configurations for a bucket.

', ], ], 'IntelligentTieringDays' => [ 'base' => NULL, 'refs' => [ 'Tiering$Days' => '

The number of consecutive days of no access after which an object will be eligible to be transitioned to the corresponding tier. The minimum number of days specified for Archive Access tier must be at least 90 days and Deep Archive Access tier must be at least 180 days. The maximum can be up to 2 years (730 days).

', ], ], 'IntelligentTieringFilter' => [ 'base' => '

The Filter is used to identify objects that the S3 Intelligent-Tiering configuration applies to.

', 'refs' => [ 'IntelligentTieringConfiguration$Filter' => '

Specifies a bucket filter. The configuration only includes objects that meet the filter\'s criteria.

', ], ], 'IntelligentTieringId' => [ 'base' => NULL, 'refs' => [ 'DeleteBucketIntelligentTieringConfigurationRequest$Id' => '

The ID used to identify the S3 Intelligent-Tiering configuration.

', 'GetBucketIntelligentTieringConfigurationRequest$Id' => '

The ID used to identify the S3 Intelligent-Tiering configuration.

', 'IntelligentTieringConfiguration$Id' => '

The ID used to identify the S3 Intelligent-Tiering configuration.

', 'PutBucketIntelligentTieringConfigurationRequest$Id' => '

The ID used to identify the S3 Intelligent-Tiering configuration.

', ], ], 'IntelligentTieringStatus' => [ 'base' => NULL, 'refs' => [ 'IntelligentTieringConfiguration$Status' => '

Specifies the status of the configuration.

', ], ], 'InvalidObjectState' => [ 'base' => '

Object is archived and inaccessible until restored.

If the object you are retrieving is stored in the S3 Glacier Flexible Retrieval storage class, the S3 Glacier Deep Archive storage class, the S3 Intelligent-Tiering Archive Access tier, or the S3 Intelligent-Tiering Deep Archive Access tier, before you can retrieve the object you must first restore a copy using RestoreObject. Otherwise, this operation returns an InvalidObjectState error. For information about restoring archived objects, see Restoring Archived Objects in the Amazon S3 User Guide.

', 'refs' => [], ], 'InvalidRequest' => [ 'base' => '

You may receive this error in multiple cases. Depending on the reason for the error, you may receive one of the messages below:

', 'refs' => [], ], 'InvalidWriteOffset' => [ 'base' => '

The write offset value that you specified does not match the current object size.

', 'refs' => [], ], 'InventoryConfiguration' => [ 'base' => '

Specifies the inventory configuration for an Amazon S3 bucket. For more information, see GET Bucket inventory in the Amazon S3 API Reference.

', 'refs' => [ 'GetBucketInventoryConfigurationOutput$InventoryConfiguration' => '

Specifies the inventory configuration.

', 'InventoryConfigurationList$member' => NULL, 'PutBucketInventoryConfigurationRequest$InventoryConfiguration' => '

Specifies the inventory configuration.

', ], ], 'InventoryConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListBucketInventoryConfigurationsOutput$InventoryConfigurationList' => '

The list of inventory configurations for a bucket.

', ], ], 'InventoryDestination' => [ 'base' => '

Specifies the inventory configuration for an Amazon S3 bucket.

', 'refs' => [ 'InventoryConfiguration$Destination' => '

Contains information about where to publish the inventory results.

', ], ], 'InventoryEncryption' => [ 'base' => '

Contains the type of server-side encryption used to encrypt the inventory results.

', 'refs' => [ 'InventoryS3BucketDestination$Encryption' => '

Contains the type of server-side encryption used to encrypt the inventory results.

', ], ], 'InventoryFilter' => [ 'base' => '

Specifies an inventory filter. The inventory only includes objects that meet the filter\'s criteria.

', 'refs' => [ 'InventoryConfiguration$Filter' => '

Specifies an inventory filter. The inventory only includes objects that meet the filter\'s criteria.

', ], ], 'InventoryFormat' => [ 'base' => NULL, 'refs' => [ 'InventoryS3BucketDestination$Format' => '

Specifies the output format of the inventory results.

', ], ], 'InventoryFrequency' => [ 'base' => NULL, 'refs' => [ 'InventorySchedule$Frequency' => '

Specifies how frequently inventory results are produced.

', ], ], 'InventoryId' => [ 'base' => NULL, 'refs' => [ 'DeleteBucketInventoryConfigurationRequest$Id' => '

The ID used to identify the inventory configuration.

', 'GetBucketInventoryConfigurationRequest$Id' => '

The ID used to identify the inventory configuration.

', 'InventoryConfiguration$Id' => '

The ID used to identify the inventory configuration.

', 'PutBucketInventoryConfigurationRequest$Id' => '

The ID used to identify the inventory configuration.

', ], ], 'InventoryIncludedObjectVersions' => [ 'base' => NULL, 'refs' => [ 'InventoryConfiguration$IncludedObjectVersions' => '

Object versions to include in the inventory list. If set to All, the list includes all the object versions, which adds the version-related fields VersionId, IsLatest, and DeleteMarker to the list. If set to Current, the list does not contain these version-related fields.

', ], ], 'InventoryOptionalField' => [ 'base' => NULL, 'refs' => [ 'InventoryOptionalFields$member' => NULL, ], ], 'InventoryOptionalFields' => [ 'base' => NULL, 'refs' => [ 'InventoryConfiguration$OptionalFields' => '

Contains the optional fields that are included in the inventory results.

', ], ], 'InventoryS3BucketDestination' => [ 'base' => '

Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

', 'refs' => [ 'InventoryDestination$S3BucketDestination' => '

Contains the bucket name, file format, bucket owner (optional), and prefix (optional) where inventory results are published.

', ], ], 'InventorySchedule' => [ 'base' => '

Specifies the schedule for generating inventory results.

', 'refs' => [ 'InventoryConfiguration$Schedule' => '

Specifies the schedule for generating inventory results.

', ], ], 'IsEnabled' => [ 'base' => NULL, 'refs' => [ 'InventoryConfiguration$IsEnabled' => '

Specifies whether the inventory is enabled or disabled. If set to True, an inventory list is generated. If set to False, no inventory list is generated.

', ], ], 'IsLatest' => [ 'base' => NULL, 'refs' => [ 'DeleteMarkerEntry$IsLatest' => '

Specifies whether the object is (true) or is not (false) the latest version of an object.

', 'ObjectVersion$IsLatest' => '

Specifies whether the object is (true) or is not (false) the latest version of an object.

', ], ], 'IsPublic' => [ 'base' => NULL, 'refs' => [ 'PolicyStatus$IsPublic' => '

The policy status for this bucket. TRUE indicates that this bucket is public. FALSE indicates that the bucket is not public.

', ], ], 'IsRestoreInProgress' => [ 'base' => NULL, 'refs' => [ 'RestoreStatus$IsRestoreInProgress' => '

Specifies whether the object is currently being restored. If the object restoration is in progress, the header returns the value TRUE. For example:

x-amz-optional-object-attributes: IsRestoreInProgress="true"

If the object restoration has completed, the header returns the value FALSE. For example:

x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

If the object hasn\'t been restored, there is no header response.

', ], ], 'IsTruncated' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesParts$IsTruncated' => '

Indicates whether the returned list of parts is truncated. A value of true indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

', 'ListBucketAnalyticsConfigurationsOutput$IsTruncated' => '

Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

', 'ListBucketIntelligentTieringConfigurationsOutput$IsTruncated' => '

Indicates whether the returned list of analytics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

', 'ListBucketInventoryConfigurationsOutput$IsTruncated' => '

Tells whether the returned list of inventory configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken is provided for a subsequent request.

', 'ListBucketMetricsConfigurationsOutput$IsTruncated' => '

Indicates whether the returned list of metrics configurations is complete. A value of true indicates that the list is not complete and the NextContinuationToken will be provided for a subsequent request.

', 'ListMultipartUploadsOutput$IsTruncated' => '

Indicates whether the returned list of multipart uploads is truncated. A value of true indicates that the list was truncated. The list can be truncated if the number of multipart uploads exceeds the limit allowed or specified by max uploads.

', 'ListObjectVersionsOutput$IsTruncated' => '

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 by using the NextKeyMarker and NextVersionIdMarker response parameters as a starting place in another request to return the rest of the results.

', 'ListObjectsOutput$IsTruncated' => '

A flag that indicates whether Amazon S3 returned all of the results that satisfied the search criteria.

', 'ListObjectsV2Output$IsTruncated' => '

Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.

', 'ListPartsOutput$IsTruncated' => '

Indicates whether the returned list of parts is truncated. A true value indicates that the list was truncated. A list can be truncated if the number of parts exceeds the limit returned in the MaxParts element.

', ], ], 'JSONInput' => [ 'base' => '

Specifies JSON as object\'s input serialization format.

', 'refs' => [ 'InputSerialization$JSON' => '

Specifies JSON as object\'s input serialization format.

', ], ], 'JSONOutput' => [ 'base' => '

Specifies JSON as request\'s output serialization format.

', 'refs' => [ 'OutputSerialization$JSON' => '

Specifies JSON as request\'s output serialization format.

', ], ], 'JSONType' => [ 'base' => NULL, 'refs' => [ 'JSONInput$Type' => '

The type of JSON. Valid values: Document, Lines.

', ], ], 'KMSContext' => [ 'base' => NULL, 'refs' => [ 'Encryption$KMSContext' => '

If the encryption type is aws:kms, this optional value can be used to specify the encryption context for the restore results.

', ], ], 'KeyCount' => [ 'base' => NULL, 'refs' => [ 'ListObjectsV2Output$KeyCount' => '

KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.

', ], ], 'KeyMarker' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$KeyMarker' => '

The key at or after which the listing began.

', 'ListMultipartUploadsRequest$KeyMarker' => '

Specifies the multipart upload after which listing should begin.

', 'ListObjectVersionsOutput$KeyMarker' => '

Marks the last key returned in a truncated response.

', 'ListObjectVersionsRequest$KeyMarker' => '

Specifies the key to start with when listing objects in a bucket.

', ], ], 'KeyPrefixEquals' => [ 'base' => NULL, 'refs' => [ 'Condition$KeyPrefixEquals' => '

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.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', ], ], 'LambdaFunctionArn' => [ 'base' => NULL, 'refs' => [ 'LambdaFunctionConfiguration$LambdaFunctionArn' => '

The Amazon Resource Name (ARN) of the Lambda function that Amazon S3 invokes when the specified event type occurs.

', ], ], 'LambdaFunctionConfiguration' => [ 'base' => '

A container for specifying the configuration for Lambda notifications.

', 'refs' => [ 'LambdaFunctionConfigurationList$member' => NULL, ], ], 'LambdaFunctionConfigurationList' => [ 'base' => NULL, 'refs' => [ 'NotificationConfiguration$LambdaFunctionConfigurations' => '

Describes the Lambda functions to invoke and the events for which to invoke them.

', ], ], 'LastModified' => [ 'base' => NULL, 'refs' => [ 'CopyObjectResult$LastModified' => '

Creation date of the object.

', 'CopyPartResult$LastModified' => '

Date and time at which the object was uploaded.

', 'DeleteMarkerEntry$LastModified' => '

Date and time when the object was last modified.

', 'GetObjectAttributesOutput$LastModified' => '

Date and time when the object was last modified.

', 'GetObjectOutput$LastModified' => '

Date and time when the object was last modified.

General purpose buckets - When you specify a versionId of the object in your request, if the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

', 'HeadObjectOutput$LastModified' => '

Date and time when the object was last modified.

', 'Object$LastModified' => '

Creation date of the object.

', 'ObjectVersion$LastModified' => '

Date and time when the object was last modified.

', 'Part$LastModified' => '

Date and time at which the part was uploaded.

', 'WriteGetObjectResponseRequest$LastModified' => '

The date and time that the object was last modified.

', ], ], 'LastModifiedTime' => [ 'base' => NULL, 'refs' => [ 'ObjectIdentifier$LastModifiedTime' => '

If present, the objects are deleted only if its modification times matches the provided Timestamp.

This functionality is only supported for directory buckets.

', ], ], 'LifecycleConfiguration' => [ 'base' => '

Container for lifecycle rules. You can add as many as 1000 rules.

For more information see, Managing your storage lifecycle in the Amazon S3 User Guide.

', 'refs' => [ 'PutBucketLifecycleRequest$LifecycleConfiguration' => '

', ], ], 'LifecycleExpiration' => [ 'base' => '

Container for the expiration for the lifecycle of the object.

For more information see, Managing your storage lifecycle in the Amazon S3 User Guide.

', 'refs' => [ 'LifecycleRule$Expiration' => '

Specifies the expiration for the lifecycle of the object in the form of date, days and, whether the object has a delete marker.

', 'Rule$Expiration' => '

Specifies the expiration for the lifecycle of the object.

', ], ], 'LifecycleRule' => [ 'base' => '

A lifecycle rule for individual objects in an Amazon S3 bucket.

For more information see, Managing your storage lifecycle in the Amazon S3 User Guide.

', 'refs' => [ 'LifecycleRules$member' => NULL, ], ], 'LifecycleRuleAndOperator' => [ 'base' => '

This is used in a Lifecycle Rule Filter to apply a logical AND to two or more predicates. The Lifecycle Rule will apply to any object matching all of the predicates configured inside the And operator.

', 'refs' => [ 'LifecycleRuleFilter$And' => NULL, ], ], 'LifecycleRuleFilter' => [ 'base' => '

The Filter is used to identify objects that a Lifecycle Rule applies to. A Filter can have exactly one of Prefix, Tag, ObjectSizeGreaterThan, ObjectSizeLessThan, or And specified. If the Filter element is left empty, the Lifecycle Rule applies to all objects in the bucket.

', 'refs' => [ 'LifecycleRule$Filter' => '

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. Filter is required if the LifecycleRule does not contain a Prefix element.

Tag filters are not supported for directory buckets.

', ], ], 'LifecycleRules' => [ 'base' => NULL, 'refs' => [ 'BucketLifecycleConfiguration$Rules' => '

A lifecycle rule for individual objects in an Amazon S3 bucket.

', 'GetBucketLifecycleConfigurationOutput$Rules' => '

Container for a lifecycle rule.

', ], ], 'ListBucketAnalyticsConfigurationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketAnalyticsConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketIntelligentTieringConfigurationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketIntelligentTieringConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketInventoryConfigurationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketInventoryConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketMetricsConfigurationsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketMetricsConfigurationsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListBucketsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListDirectoryBucketsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListDirectoryBucketsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListMultipartUploadsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListMultipartUploadsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListObjectVersionsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListObjectVersionsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListObjectsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListObjectsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListObjectsV2Output' => [ 'base' => NULL, 'refs' => [], ], 'ListObjectsV2Request' => [ 'base' => NULL, 'refs' => [], ], 'ListPartsOutput' => [ 'base' => NULL, 'refs' => [], ], 'ListPartsRequest' => [ 'base' => NULL, 'refs' => [], ], 'Location' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$Location' => '

The URI that identifies the newly created object.

', 'CreateBucketOutput$Location' => '

A forward slash followed by the name of the bucket.

', ], ], 'LocationInfo' => [ 'base' => '

Specifies the location where the bucket will be created.

For directory buckets, the location type is Availability Zone. For more information about directory buckets, see Directory buckets in the Amazon S3 User Guide.

This functionality is only supported by directory buckets.

', 'refs' => [ 'CreateBucketConfiguration$Location' => '

Specifies the location where the bucket will be created.

For directory buckets, the location type is Availability Zone.

This functionality is only supported by directory buckets.

', ], ], 'LocationNameAsString' => [ 'base' => NULL, 'refs' => [ 'LocationInfo$Name' => '

The name of the location where the bucket will be created.

For directory buckets, the name of the location is the AZ ID of the Availability Zone where the bucket will be created. An example AZ ID value is usw2-az1.

', ], ], 'LocationPrefix' => [ 'base' => NULL, 'refs' => [ 'S3Location$Prefix' => '

The prefix that is prepended to the restore results for this request.

', ], ], 'LocationType' => [ 'base' => NULL, 'refs' => [ 'HeadBucketOutput$BucketLocationType' => '

The type of location where the bucket is created.

This functionality is only supported by directory buckets.

', 'LocationInfo$Type' => '

The type of location where the bucket will be created.

', ], ], 'LoggingEnabled' => [ 'base' => '

Describes where logs are stored and the prefix that Amazon S3 assigns to all log object keys for a bucket. For more information, see PUT Bucket logging in the Amazon S3 API Reference.

', 'refs' => [ 'BucketLoggingStatus$LoggingEnabled' => NULL, 'GetBucketLoggingOutput$LoggingEnabled' => NULL, ], ], 'MFA' => [ 'base' => NULL, 'refs' => [ 'DeleteObjectRequest$MFA' => '

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.

This functionality is not supported for directory buckets.

', 'DeleteObjectsRequest$MFA' => '

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.

When performing the DeleteObjects operation on an MFA delete enabled bucket, which attempts to delete the specified versioned objects, you must include an MFA token. If you don\'t provide an MFA token, the entire request will fail, even if there are non-versioned objects that you are trying to delete. If you provide an invalid token, whether there are versioned object keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'PutBucketVersioningRequest$MFA' => '

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

', ], ], 'MFADelete' => [ 'base' => NULL, 'refs' => [ 'VersioningConfiguration$MFADelete' => '

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

', ], ], 'MFADeleteStatus' => [ 'base' => NULL, 'refs' => [ 'GetBucketVersioningOutput$MFADelete' => '

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

', ], ], 'Marker' => [ 'base' => NULL, 'refs' => [ 'ListObjectsOutput$Marker' => '

Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.

', 'ListObjectsRequest$Marker' => '

Marker is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. Marker can be any key in the bucket.

', ], ], 'MaxAgeSeconds' => [ 'base' => NULL, 'refs' => [ 'CORSRule$MaxAgeSeconds' => '

The time in seconds that your browser is to cache the preflight response for the specified resource.

', ], ], 'MaxBuckets' => [ 'base' => NULL, 'refs' => [ 'ListBucketsRequest$MaxBuckets' => '

Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.

', ], ], 'MaxDirectoryBuckets' => [ 'base' => NULL, 'refs' => [ 'ListDirectoryBucketsRequest$MaxDirectoryBuckets' => '

Maximum number of buckets to be returned in response. When the number is more than the count of buckets that are owned by an Amazon Web Services account, return all the buckets in response.

', ], ], 'MaxKeys' => [ 'base' => NULL, 'refs' => [ 'ListObjectVersionsOutput$MaxKeys' => '

Specifies the maximum number of objects to return.

', 'ListObjectVersionsRequest$MaxKeys' => '

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more. If additional keys satisfy the search criteria, but were not returned because max-keys was exceeded, the response contains <isTruncated>true</isTruncated>. To return the additional keys, see key-marker and version-id-marker.

', 'ListObjectsOutput$MaxKeys' => '

The maximum number of keys returned in the response body.

', 'ListObjectsRequest$MaxKeys' => '

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

', 'ListObjectsV2Output$MaxKeys' => '

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

', 'ListObjectsV2Request$MaxKeys' => '

Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.

', ], ], 'MaxParts' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesParts$MaxParts' => '

The maximum number of parts allowed in the response.

', 'GetObjectAttributesRequest$MaxParts' => '

Sets the maximum number of parts to return.

', 'ListPartsOutput$MaxParts' => '

Maximum number of parts that were allowed in the response.

', 'ListPartsRequest$MaxParts' => '

Sets the maximum number of parts to return.

', ], ], 'MaxUploads' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$MaxUploads' => '

Maximum number of multipart uploads that could have been included in the response.

', 'ListMultipartUploadsRequest$MaxUploads' => '

Sets the maximum number of multipart uploads, from 1 to 1,000, to return in the response body. 1,000 is the maximum number of uploads that can be returned in a response.

', ], ], 'Message' => [ 'base' => NULL, 'refs' => [ 'Error$Message' => '

The error message contains a generic description of the error condition in English. It is intended for a human audience. Simple programs display the message directly to the end user if they encounter an error condition they don\'t know how or don\'t care to handle. Sophisticated programs with more exhaustive error handling and proper internationalization are more likely to ignore the error message.

', ], ], 'Metadata' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$Metadata' => '

A map of metadata to store with the object in S3.

', 'CreateMultipartUploadRequest$Metadata' => '

A map of metadata to store with the object in S3.

', 'GetObjectOutput$Metadata' => '

A map of metadata to store with the object in S3.

', 'HeadObjectOutput$Metadata' => '

A map of metadata to store with the object in S3.

', 'PutObjectRequest$Metadata' => '

A map of metadata to store with the object in S3.

', 'WriteGetObjectResponseRequest$Metadata' => '

A map of metadata to store with the object in S3.

', ], ], 'MetadataDirective' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$MetadataDirective' => '

Specifies whether the metadata is copied from the source object or replaced with metadata that\'s provided in the request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If this header isn’t specified, COPY is the default behavior.

General purpose bucket - For general purpose buckets, when you grant permissions, you can use the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Amazon S3 condition key examples in the Amazon S3 User Guide.

x-amz-website-redirect-location is unique to each object and is not copied when using the x-amz-metadata-directive header. To copy the value, you must specify x-amz-website-redirect-location in the request header.

', ], ], 'MetadataEntry' => [ 'base' => '

A metadata key-value pair to store with an object.

', 'refs' => [ 'UserMetadata$member' => NULL, ], ], 'MetadataKey' => [ 'base' => NULL, 'refs' => [ 'Metadata$key' => NULL, 'MetadataEntry$Name' => '

Name of the object.

', ], ], 'MetadataValue' => [ 'base' => NULL, 'refs' => [ 'Metadata$value' => NULL, 'MetadataEntry$Value' => '

Value of the object.

', ], ], 'Metrics' => [ 'base' => '

A container specifying replication metrics-related settings enabling replication metrics and events.

', 'refs' => [ 'Destination$Metrics' => '

A container specifying replication metrics-related settings enabling replication metrics and events.

', ], ], 'MetricsAndOperator' => [ 'base' => '

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

', 'refs' => [ 'MetricsFilter$And' => '

A conjunction (logical AND) of predicates, which is used in evaluating a metrics filter. The operator must have at least two predicates, and an object must match all of the predicates in order for the filter to apply.

', ], ], 'MetricsConfiguration' => [ 'base' => '

Specifies a metrics configuration for the CloudWatch request metrics (specified by the metrics configuration ID) from an Amazon S3 bucket. If you\'re updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don\'t include the elements you want to keep, they are erased. For more information, see PutBucketMetricsConfiguration.

', 'refs' => [ 'GetBucketMetricsConfigurationOutput$MetricsConfiguration' => '

Specifies the metrics configuration.

', 'MetricsConfigurationList$member' => NULL, 'PutBucketMetricsConfigurationRequest$MetricsConfiguration' => '

Specifies the metrics configuration.

', ], ], 'MetricsConfigurationList' => [ 'base' => NULL, 'refs' => [ 'ListBucketMetricsConfigurationsOutput$MetricsConfigurationList' => '

The list of metrics configurations for a bucket.

', ], ], 'MetricsFilter' => [ 'base' => '

Specifies a metrics configuration filter. The metrics configuration only includes objects that meet the filter\'s criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator). For more information, see PutBucketMetricsConfiguration.

', 'refs' => [ 'MetricsConfiguration$Filter' => '

Specifies a metrics configuration filter. The metrics configuration will only include objects that meet the filter\'s criteria. A filter must be a prefix, an object tag, an access point ARN, or a conjunction (MetricsAndOperator).

', ], ], 'MetricsId' => [ 'base' => NULL, 'refs' => [ 'DeleteBucketMetricsConfigurationRequest$Id' => '

The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

', 'GetBucketMetricsConfigurationRequest$Id' => '

The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

', 'MetricsConfiguration$Id' => '

The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

', 'PutBucketMetricsConfigurationRequest$Id' => '

The ID used to identify the metrics configuration. The ID has a 64 character limit and can only contain letters, numbers, periods, dashes, and underscores.

', ], ], 'MetricsStatus' => [ 'base' => NULL, 'refs' => [ 'Metrics$Status' => '

Specifies whether the replication metrics are enabled.

', ], ], 'Minutes' => [ 'base' => NULL, 'refs' => [ 'ReplicationTimeValue$Minutes' => '

Contains an integer specifying time in minutes.

Valid value: 15

', ], ], 'MissingMeta' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$MissingMeta' => '

This is set to the number of metadata entries not returned in the headers that are prefixed with x-amz-meta-. 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.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$MissingMeta' => '

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.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$MissingMeta' => '

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.

', ], ], 'MultipartUpload' => [ 'base' => '

Container for the MultipartUpload for the Amazon S3 object.

', 'refs' => [ 'MultipartUploadList$member' => NULL, ], ], 'MultipartUploadId' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartUploadRequest$UploadId' => '

Upload ID that identifies the multipart upload.

', 'CompleteMultipartUploadRequest$UploadId' => '

ID for the initiated multipart upload.

', 'CreateMultipartUploadOutput$UploadId' => '

ID for the initiated multipart upload.

', 'ListPartsOutput$UploadId' => '

Upload ID identifying the multipart upload whose parts are being listed.

', 'ListPartsRequest$UploadId' => '

Upload ID identifying the multipart upload whose parts are being listed.

', 'MultipartUpload$UploadId' => '

Upload ID that identifies the multipart upload.

', 'UploadPartCopyRequest$UploadId' => '

Upload ID identifying the multipart upload whose part is being copied.

', 'UploadPartRequest$UploadId' => '

Upload ID identifying the multipart upload whose part is being uploaded.

', ], ], 'MultipartUploadList' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$Uploads' => '

Container for elements related to a particular multipart upload. A response can contain zero or more Upload elements.

', ], ], 'NextKeyMarker' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$NextKeyMarker' => '

When a list is truncated, this element specifies the value that should be used for the key-marker request parameter in a subsequent request.

', 'ListObjectVersionsOutput$NextKeyMarker' => '

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.

', ], ], 'NextMarker' => [ 'base' => NULL, 'refs' => [ 'ListObjectsOutput$NextMarker' => '

When the response is truncated (the IsTruncated element value in the response is true), you can use the key name in this field as the marker parameter in the subsequent request to get the next set of objects. Amazon S3 lists objects in alphabetical order.

This element is returned only if you have the delimiter request parameter specified. If the response does not include the NextMarker element and it is truncated, you can use the value of the last Key element in the response as the marker parameter in the subsequent request to get the next set of object keys.

', ], ], 'NextPartNumberMarker' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesParts$NextPartNumberMarker' => '

When a list is truncated, this element specifies the last part in the list, as well as the value to use for the PartNumberMarker request parameter in a subsequent request.

', 'ListPartsOutput$NextPartNumberMarker' => '

When a list is truncated, this element specifies the last part in the list, as well as the value to use for the part-number-marker request parameter in a subsequent request.

', ], ], 'NextToken' => [ 'base' => NULL, 'refs' => [ 'ListBucketAnalyticsConfigurationsOutput$NextContinuationToken' => '

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.

', 'ListBucketIntelligentTieringConfigurationsOutput$NextContinuationToken' => '

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.

', 'ListBucketInventoryConfigurationsOutput$NextContinuationToken' => '

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.

', 'ListBucketMetricsConfigurationsOutput$NextContinuationToken' => '

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.

', 'ListBucketsOutput$ContinuationToken' => '

ContinuationToken is included in the response when there are more buckets that can be listed with pagination. The next ListBuckets request to Amazon S3 can be continued with this ContinuationToken. ContinuationToken is obfuscated and is not a real bucket.

', 'ListObjectsV2Output$NextContinuationToken' => '

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

', ], ], 'NextUploadIdMarker' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$NextUploadIdMarker' => '

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.

This functionality is not supported for directory buckets.

', ], ], 'NextVersionIdMarker' => [ 'base' => NULL, 'refs' => [ 'ListObjectVersionsOutput$NextVersionIdMarker' => '

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.

', ], ], 'NoSuchBucket' => [ 'base' => '

The specified bucket does not exist.

', 'refs' => [], ], 'NoSuchKey' => [ 'base' => '

The specified key does not exist.

', 'refs' => [], ], 'NoSuchUpload' => [ 'base' => '

The specified multipart upload does not exist.

', 'refs' => [], ], 'NoncurrentVersionExpiration' => [ 'base' => '

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.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'refs' => [ 'LifecycleRule$NoncurrentVersionExpiration' => NULL, 'Rule$NoncurrentVersionExpiration' => NULL, ], ], 'NoncurrentVersionTransition' => [ 'base' => '

Container for the transition rule that describes when noncurrent objects transition to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class. If your bucket is versioning-enabled (or versioning is suspended), you can set this action to request that Amazon S3 transition noncurrent object versions to the STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER_IR, GLACIER, or DEEP_ARCHIVE storage class at a specific period in the object\'s lifetime.

', 'refs' => [ 'NoncurrentVersionTransitionList$member' => NULL, 'Rule$NoncurrentVersionTransition' => NULL, ], ], 'NoncurrentVersionTransitionList' => [ 'base' => NULL, 'refs' => [ 'LifecycleRule$NoncurrentVersionTransitions' => '

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.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', ], ], 'NotificationConfiguration' => [ 'base' => '

A container for specifying the notification configuration of the bucket. If this element is empty, notifications are turned off for the bucket.

', 'refs' => [ 'PutBucketNotificationConfigurationRequest$NotificationConfiguration' => NULL, ], ], 'NotificationConfigurationDeprecated' => [ 'base' => NULL, 'refs' => [ 'PutBucketNotificationRequest$NotificationConfiguration' => '

The container for the configuration.

', ], ], 'NotificationConfigurationFilter' => [ 'base' => '

Specifies object key name filtering rules. For information about key name filtering, see Configuring event notifications using object key name filtering in the Amazon S3 User Guide.

', 'refs' => [ 'LambdaFunctionConfiguration$Filter' => NULL, 'QueueConfiguration$Filter' => NULL, 'TopicConfiguration$Filter' => NULL, ], ], 'NotificationId' => [ 'base' => '

An optional unique identifier for configurations in a notification configuration. If you don\'t provide one, Amazon S3 will assign an ID.

', 'refs' => [ 'CloudFunctionConfiguration$Id' => NULL, 'LambdaFunctionConfiguration$Id' => NULL, 'QueueConfiguration$Id' => NULL, 'QueueConfigurationDeprecated$Id' => NULL, 'TopicConfiguration$Id' => NULL, 'TopicConfigurationDeprecated$Id' => NULL, ], ], 'Object' => [ 'base' => '

An object consists of data and its descriptive metadata.

', 'refs' => [ 'ObjectList$member' => NULL, ], ], 'ObjectAlreadyInActiveTierError' => [ 'base' => '

This action is not allowed against this storage tier.

', 'refs' => [], ], 'ObjectAttributes' => [ 'base' => NULL, 'refs' => [ 'ObjectAttributesList$member' => NULL, ], ], 'ObjectAttributesList' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesRequest$ObjectAttributes' => '

Specifies the fields at the root level that you want returned in the response. Fields that you do not specify are not returned.

', ], ], 'ObjectCannedACL' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ACL' => '

The canned access control list (ACL) to apply to the object.

When you copy an object, the ACL metadata is not preserved and is set to private by default. Only the owner has full access control. To override the default ACL setting, specify a new ACL when you generate a copy request. For more information, see Using ACLs.

If the destination bucket that you\'re copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don\'t specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.

', 'CreateMultipartUploadRequest$ACL' => '

The canned ACL to apply to the object. 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 in the Amazon S3 User Guide.

By default, all objects are private. Only the owner has full access control. When uploading an object, you can grant access permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the new object. For more information, see Using ACLs. One way to grant the permissions using the request headers is to specify a canned ACL with the x-amz-acl request header.

', 'PutObjectAclRequest$ACL' => '

The canned ACL to apply to the object. For more information, see Canned ACL.

', 'PutObjectRequest$ACL' => '

The canned ACL to apply to the object. For more information, see Canned ACL in the Amazon S3 User Guide.

When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API in the Amazon S3 User Guide.

If the bucket that you\'re uploading objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don\'t specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL expressed in the XML format. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail and return a 400 error with the error code AccessControlListNotSupported. For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.

', 'S3Location$CannedACL' => '

The canned ACL to apply to the restore results.

', ], ], 'ObjectIdentifier' => [ 'base' => '

Object Identifier is unique value to identify objects.

', 'refs' => [ 'ObjectIdentifierList$member' => NULL, ], ], 'ObjectIdentifierList' => [ 'base' => NULL, 'refs' => [ 'Delete$Objects' => '

The object to delete.

Directory buckets - For directory buckets, an object that\'s composed entirely of whitespace characters is not supported by the DeleteObjects API operation. The request will receive a 400 Bad Request error and none of the objects in the request will be deleted.

', ], ], 'ObjectKey' => [ 'base' => NULL, 'refs' => [ 'AbortMultipartUploadRequest$Key' => '

Key of the object for which the multipart upload was initiated.

', 'CompleteMultipartUploadOutput$Key' => '

The object key of the newly created object.

', 'CompleteMultipartUploadRequest$Key' => '

Object key for which the multipart upload was initiated.

', 'CopyObjectRequest$Key' => '

The key of the destination object.

', 'CreateMultipartUploadOutput$Key' => '

Object key for which the multipart upload was initiated.

', 'CreateMultipartUploadRequest$Key' => '

Object key for which the multipart upload is to be initiated.

', 'DeleteMarkerEntry$Key' => '

The object key.

', 'DeleteObjectRequest$Key' => '

Key name of the object to delete.

', 'DeleteObjectTaggingRequest$Key' => '

The key that identifies the object in the bucket from which to remove all tags.

', 'DeletedObject$Key' => '

The name of the deleted object.

', 'Error$Key' => '

The error key.

', 'ErrorDocument$Key' => '

The object key name to use when a 4XX class error occurs.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'GetObjectAclRequest$Key' => '

The key of the object for which to get the ACL information.

', 'GetObjectAttributesRequest$Key' => '

The object key.

', 'GetObjectLegalHoldRequest$Key' => '

The key name for the object whose legal hold status you want to retrieve.

', 'GetObjectRequest$Key' => '

Key of the object to get.

', 'GetObjectRetentionRequest$Key' => '

The key name for the object whose retention settings you want to retrieve.

', 'GetObjectTaggingRequest$Key' => '

Object key for which to get the tagging information.

', 'GetObjectTorrentRequest$Key' => '

The object key for which to get the information.

', 'HeadObjectRequest$Key' => '

The object key.

', 'ListPartsOutput$Key' => '

Object key for which the multipart upload was initiated.

', 'ListPartsRequest$Key' => '

Object key for which the multipart upload was initiated.

', 'MultipartUpload$Key' => '

Key of the object for which the multipart upload was initiated.

', 'Object$Key' => '

The name that you assign to an object. You use the object key to retrieve the object.

', 'ObjectIdentifier$Key' => '

Key name of the object.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'ObjectVersion$Key' => '

The object key.

', 'PutObjectAclRequest$Key' => '

Key for which the PUT action was initiated.

', 'PutObjectLegalHoldRequest$Key' => '

The key name for the object that you want to place a legal hold on.

', 'PutObjectRequest$Key' => '

Object key for which the PUT action was initiated.

', 'PutObjectRetentionRequest$Key' => '

The key name for the object that you want to apply this Object Retention configuration to.

', 'PutObjectTaggingRequest$Key' => '

Name of the object key.

', 'RestoreObjectRequest$Key' => '

Object key for which the action was initiated.

', 'SelectObjectContentRequest$Key' => '

The object key.

', 'Tag$Key' => '

Name of the object key.

', 'UploadPartCopyRequest$Key' => '

Object key for which the multipart upload was initiated.

', 'UploadPartRequest$Key' => '

Object key for which the multipart upload was initiated.

', ], ], 'ObjectList' => [ 'base' => NULL, 'refs' => [ 'ListObjectsOutput$Contents' => '

Metadata about each object returned.

', 'ListObjectsV2Output$Contents' => '

Metadata about each object returned.

', ], ], 'ObjectLockConfiguration' => [ 'base' => '

The container element for Object Lock configuration parameters.

', 'refs' => [ 'GetObjectLockConfigurationOutput$ObjectLockConfiguration' => '

The specified bucket\'s Object Lock configuration.

', 'PutObjectLockConfigurationRequest$ObjectLockConfiguration' => '

The Object Lock configuration that you want to apply to the specified bucket.

', ], ], 'ObjectLockEnabled' => [ 'base' => NULL, 'refs' => [ 'ObjectLockConfiguration$ObjectLockEnabled' => '

Indicates whether this bucket has an Object Lock configuration enabled. Enable ObjectLockEnabled when you apply ObjectLockConfiguration to a bucket.

', ], ], 'ObjectLockEnabledForBucket' => [ 'base' => NULL, 'refs' => [ 'CreateBucketRequest$ObjectLockEnabledForBucket' => '

Specifies whether you want S3 Object Lock to be enabled for the new bucket.

This functionality is not supported for directory buckets.

', ], ], 'ObjectLockLegalHold' => [ 'base' => '

A legal hold configuration for an object.

', 'refs' => [ 'GetObjectLegalHoldOutput$LegalHold' => '

The current legal hold status for the specified object.

', 'PutObjectLegalHoldRequest$LegalHold' => '

Container element for the legal hold configuration you want to apply to the specified object.

', ], ], 'ObjectLockLegalHoldStatus' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ObjectLockLegalHoldStatus' => '

Specifies whether you want to apply a legal hold to the object copy.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$ObjectLockLegalHoldStatus' => '

Specifies whether you want to apply a legal hold to the uploaded object.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$ObjectLockLegalHoldStatus' => '

Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object\'s legal hold status.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$ObjectLockLegalHoldStatus' => '

Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

This functionality is not supported for directory buckets.

', 'ObjectLockLegalHold$Status' => '

Indicates whether the specified object has a legal hold in place.

', 'PutObjectRequest$ObjectLockLegalHoldStatus' => '

Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$ObjectLockLegalHoldStatus' => '

Indicates whether an object stored in Amazon S3 has an active legal hold.

', ], ], 'ObjectLockMode' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ObjectLockMode' => '

The Object Lock mode that you want to apply to the object copy.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$ObjectLockMode' => '

Specifies the Object Lock mode that you want to apply to the uploaded object.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$ObjectLockMode' => '

The Object Lock mode that\'s currently in place for this object.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$ObjectLockMode' => '

The Object Lock mode, if any, that\'s in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$ObjectLockMode' => '

The Object Lock mode that you want to apply to this object.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$ObjectLockMode' => '

Indicates whether an object stored in Amazon S3 has Object Lock enabled. For more information about S3 Object Lock, see Object Lock.

', ], ], 'ObjectLockRetainUntilDate' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$ObjectLockRetainUntilDate' => '

The date and time when you want the Object Lock of the object copy to expire.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$ObjectLockRetainUntilDate' => '

Specifies the date and time when you want the Object Lock to expire.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$ObjectLockRetainUntilDate' => '

The date and time when this object\'s Object Lock will expire.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$ObjectLockRetainUntilDate' => '

The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$ObjectLockRetainUntilDate' => '

The date and time when you want this object\'s Object Lock to expire. Must be formatted as a timestamp parameter.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$ObjectLockRetainUntilDate' => '

The date and time when Object Lock is configured to expire.

', ], ], 'ObjectLockRetention' => [ 'base' => '

A Retention configuration for an object.

', 'refs' => [ 'GetObjectRetentionOutput$Retention' => '

The container element for an object\'s retention settings.

', 'PutObjectRetentionRequest$Retention' => '

The container element for the Object Retention configuration.

', ], ], 'ObjectLockRetentionMode' => [ 'base' => NULL, 'refs' => [ 'DefaultRetention$Mode' => '

The default Object Lock retention mode you want to apply to new objects placed in the specified bucket. Must be used with either Days or Years.

', 'ObjectLockRetention$Mode' => '

Indicates the Retention mode for the specified object.

', ], ], 'ObjectLockRule' => [ 'base' => '

The container element for an Object Lock rule.

', 'refs' => [ 'ObjectLockConfiguration$Rule' => '

Specifies the Object Lock rule for the specified object. Enable the this rule when you apply ObjectLockConfiguration to a bucket. Bucket settings require both a mode and a period. The period can be either Days or Years but you must select one. You cannot specify Days and Years at the same time.

', ], ], 'ObjectLockToken' => [ 'base' => NULL, 'refs' => [ 'PutBucketReplicationRequest$Token' => '

A token to allow Object Lock to be enabled for an existing bucket.

', 'PutObjectLockConfigurationRequest$Token' => '

A token to allow Object Lock to be enabled for an existing bucket.

', ], ], 'ObjectNotInActiveTierError' => [ 'base' => '

The source object of the COPY action is not in the active tier and is only stored in Amazon S3 Glacier.

', 'refs' => [], ], 'ObjectOwnership' => [ 'base' => '

The container element for object ownership for a bucket\'s ownership controls.

BucketOwnerPreferred - Objects uploaded to the bucket change ownership to the bucket owner if the objects are uploaded with the bucket-owner-full-control canned ACL.

ObjectWriter - The uploading account will own the object if the object is uploaded with the bucket-owner-full-control canned ACL.

BucketOwnerEnforced - Access control lists (ACLs) are disabled and no longer affect permissions. The bucket owner automatically owns and has full control over every object in the bucket. The bucket only accepts PUT requests that don\'t specify an ACL or specify bucket owner full control ACLs (such as the predefined bucket-owner-full-control canned ACL or a custom ACL in XML format that grants the same permissions).

By default, ObjectOwnership is set to BucketOwnerEnforced and ACLs are disabled. We recommend keeping ACLs disabled, except in uncommon use cases where you must control access for each object individually. For more information about S3 Object Ownership, see Controlling ownership of objects and disabling ACLs for your bucket in the Amazon S3 User Guide.

This functionality is not supported for directory buckets. Directory buckets use the bucket owner enforced setting for S3 Object Ownership.

', 'refs' => [ 'CreateBucketRequest$ObjectOwnership' => NULL, 'OwnershipControlsRule$ObjectOwnership' => NULL, ], ], 'ObjectPart' => [ 'base' => '

A container for elements related to an individual part.

', 'refs' => [ 'PartsList$member' => NULL, ], ], 'ObjectSize' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesOutput$ObjectSize' => '

The size of the object in bytes.

', ], ], 'ObjectSizeGreaterThanBytes' => [ 'base' => NULL, 'refs' => [ 'LifecycleRuleAndOperator$ObjectSizeGreaterThan' => '

Minimum object size to which the rule applies.

', 'LifecycleRuleFilter$ObjectSizeGreaterThan' => '

Minimum object size to which the rule applies.

', ], ], 'ObjectSizeLessThanBytes' => [ 'base' => NULL, 'refs' => [ 'LifecycleRuleAndOperator$ObjectSizeLessThan' => '

Maximum object size to which the rule applies.

', 'LifecycleRuleFilter$ObjectSizeLessThan' => '

Maximum object size to which the rule applies.

', ], ], 'ObjectStorageClass' => [ 'base' => NULL, 'refs' => [ 'Object$StorageClass' => '

The class of storage used to store the object.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', ], ], 'ObjectVersion' => [ 'base' => '

The version of an object.

', 'refs' => [ 'ObjectVersionList$member' => NULL, ], ], 'ObjectVersionId' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$VersionId' => '

Version ID of the newly created object, in case the bucket has versioning turned on.

This functionality is not supported for directory buckets.

', 'CopyObjectOutput$VersionId' => '

Version ID of the newly created copy.

This functionality is not supported for directory buckets.

', 'DeleteMarkerEntry$VersionId' => '

Version ID of an object.

', 'DeleteObjectOutput$VersionId' => '

Returns the version ID of the delete marker created as a result of the DELETE operation.

This functionality is not supported for directory buckets.

', 'DeleteObjectRequest$VersionId' => '

Version ID used to reference a specific version of the object.

For directory buckets in this API operation, only the null value of the version ID is supported.

', 'DeleteObjectTaggingOutput$VersionId' => '

The versionId of the object the tag-set was removed from.

', 'DeleteObjectTaggingRequest$VersionId' => '

The versionId of the object that the tag-set will be removed from.

', 'DeletedObject$VersionId' => '

The version ID of the deleted object.

This functionality is not supported for directory buckets.

', 'Error$VersionId' => '

The version ID of the error.

This functionality is not supported for directory buckets.

', 'GetObjectAclRequest$VersionId' => '

Version ID used to reference a specific version of the object.

This functionality is not supported for directory buckets.

', 'GetObjectAttributesOutput$VersionId' => '

The version ID of the object.

This functionality is not supported for directory buckets.

', 'GetObjectAttributesRequest$VersionId' => '

The version ID used to reference a specific version of the object.

S3 Versioning isn\'t enabled and supported for directory buckets. For this API operation, only the null value of the version ID is supported by directory buckets. You can only specify null to the versionId query parameter in the request.

', 'GetObjectLegalHoldRequest$VersionId' => '

The version ID of the object whose legal hold status you want to retrieve.

', 'GetObjectOutput$VersionId' => '

Version ID of the object.

This functionality is not supported for directory buckets.

', 'GetObjectRequest$VersionId' => '

Version ID used to reference a specific version of the object.

By default, the GetObject operation returns the current version of an object. To return a different version, use the versionId subresource.

For more information about versioning, see PutBucketVersioning.

', 'GetObjectRetentionRequest$VersionId' => '

The version ID for the object whose retention settings you want to retrieve.

', 'GetObjectTaggingOutput$VersionId' => '

The versionId of the object for which you got the tagging information.

', 'GetObjectTaggingRequest$VersionId' => '

The versionId of the object for which to get the tagging information.

', 'HeadObjectOutput$VersionId' => '

Version ID of the object.

This functionality is not supported for directory buckets.

', 'HeadObjectRequest$VersionId' => '

Version ID used to reference a specific version of the object.

For directory buckets in this API operation, only the null value of the version ID is supported.

', 'ObjectIdentifier$VersionId' => '

Version ID for the specific version of the object to delete.

This functionality is not supported for directory buckets.

', 'ObjectVersion$VersionId' => '

Version ID of an object.

', 'PutObjectAclRequest$VersionId' => '

Version ID used to reference a specific version of the object.

This functionality is not supported for directory buckets.

', 'PutObjectLegalHoldRequest$VersionId' => '

The version ID of the object that you want to place a legal hold on.

', 'PutObjectOutput$VersionId' => '

Version ID of the object.

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. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets in the Amazon S3 User Guide. For information about returning the versioning state of a bucket, see GetBucketVersioning.

This functionality is not supported for directory buckets.

', 'PutObjectRetentionRequest$VersionId' => '

The version ID for the object that you want to apply this Object Retention configuration to.

', 'PutObjectTaggingOutput$VersionId' => '

The versionId of the object the tag-set was added to.

', 'PutObjectTaggingRequest$VersionId' => '

The versionId of the object that the tag-set will be added to.

', 'RestoreObjectRequest$VersionId' => '

VersionId used to reference a specific version of the object.

', 'WriteGetObjectResponseRequest$VersionId' => '

An ID used to reference a specific version of the object.

', ], ], 'ObjectVersionList' => [ 'base' => NULL, 'refs' => [ 'ListObjectVersionsOutput$Versions' => '

Container for version information.

', ], ], 'ObjectVersionStorageClass' => [ 'base' => NULL, 'refs' => [ 'ObjectVersion$StorageClass' => '

The class of storage used to store the object.

', ], ], 'OptionalObjectAttributes' => [ 'base' => NULL, 'refs' => [ 'OptionalObjectAttributesList$member' => NULL, ], ], 'OptionalObjectAttributesList' => [ 'base' => NULL, 'refs' => [ 'ListObjectVersionsRequest$OptionalObjectAttributes' => '

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

', 'ListObjectsRequest$OptionalObjectAttributes' => '

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

', 'ListObjectsV2Request$OptionalObjectAttributes' => '

Specifies the optional fields that you want returned in the response. Fields that you do not specify are not returned.

This functionality is not supported for directory buckets.

', ], ], 'OutputLocation' => [ 'base' => '

Describes the location where the restore job\'s output is stored.

', 'refs' => [ 'RestoreRequest$OutputLocation' => '

Describes the location where the restore job\'s output is stored.

', ], ], 'OutputSerialization' => [ 'base' => '

Describes how results of the Select job are serialized.

', 'refs' => [ 'SelectObjectContentRequest$OutputSerialization' => '

Describes the format of the data that you want Amazon S3 to return in response.

', 'SelectParameters$OutputSerialization' => '

Describes how the results of the Select job are serialized.

', ], ], 'Owner' => [ 'base' => '

Container for the owner\'s display name and ID.

', 'refs' => [ 'AccessControlPolicy$Owner' => '

Container for the bucket owner\'s display name and ID.

', 'DeleteMarkerEntry$Owner' => '

The account that created the delete marker.>

', 'GetBucketAclOutput$Owner' => '

Container for the bucket owner\'s display name and ID.

', 'GetObjectAclOutput$Owner' => '

Container for the bucket owner\'s display name and ID.

', 'ListBucketsOutput$Owner' => '

The owner of the buckets listed.

', 'ListPartsOutput$Owner' => '

Container element that identifies the object owner, after the object is created. If multipart upload is initiated by an IAM user, this element provides the parent account ID and display name.

Directory buckets - The bucket owner is returned as the object owner for all the parts.

', 'MultipartUpload$Owner' => '

Specifies the owner of the object that is part of the multipart upload.

Directory buckets - The bucket owner is returned as the object owner for all the objects.

', 'Object$Owner' => '

The owner of the object

Directory buckets - The bucket owner is returned as the object owner.

', 'ObjectVersion$Owner' => '

Specifies the owner of the object.

', ], ], 'OwnerOverride' => [ 'base' => NULL, 'refs' => [ 'AccessControlTranslation$Owner' => '

Specifies the replica ownership. For default and valid values, see PUT bucket replication in the Amazon S3 API Reference.

', ], ], 'OwnershipControls' => [ 'base' => '

The container element for a bucket\'s ownership controls.

', 'refs' => [ 'GetBucketOwnershipControlsOutput$OwnershipControls' => '

The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) currently in effect for this Amazon S3 bucket.

', 'PutBucketOwnershipControlsRequest$OwnershipControls' => '

The OwnershipControls (BucketOwnerEnforced, BucketOwnerPreferred, or ObjectWriter) that you want to apply to this Amazon S3 bucket.

', ], ], 'OwnershipControlsRule' => [ 'base' => '

The container element for an ownership control rule.

', 'refs' => [ 'OwnershipControlsRules$member' => NULL, ], ], 'OwnershipControlsRules' => [ 'base' => NULL, 'refs' => [ 'OwnershipControls$Rules' => '

The container element for an ownership control rule.

', ], ], 'ParquetInput' => [ 'base' => '

Container for Parquet.

', 'refs' => [ 'InputSerialization$Parquet' => '

Specifies Parquet as object\'s input serialization format.

', ], ], 'Part' => [ 'base' => '

Container for elements related to a part.

', 'refs' => [ 'Parts$member' => NULL, ], ], 'PartNumber' => [ 'base' => NULL, 'refs' => [ 'CompletedPart$PartNumber' => '

Part number that identifies the part. This is a positive integer between 1 and 10,000.

', 'GetObjectRequest$PartNumber' => '

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a \'ranged\' GET request for the part specified. Useful for downloading just a part of an object.

', 'HeadObjectRequest$PartNumber' => '

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a \'ranged\' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

', 'ObjectPart$PartNumber' => '

The part number identifying the part. This value is a positive integer between 1 and 10,000.

', 'Part$PartNumber' => '

Part number identifying the part. This is a positive integer between 1 and 10,000.

', 'UploadPartCopyRequest$PartNumber' => '

Part number of part being copied. This is a positive integer between 1 and 10,000.

', 'UploadPartRequest$PartNumber' => '

Part number of part being uploaded. This is a positive integer between 1 and 10,000.

', ], ], 'PartNumberMarker' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesParts$PartNumberMarker' => '

The marker for the current part.

', 'GetObjectAttributesRequest$PartNumberMarker' => '

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

', 'ListPartsOutput$PartNumberMarker' => '

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

', 'ListPartsRequest$PartNumberMarker' => '

Specifies the part after which listing should begin. Only parts with higher part numbers will be listed.

', ], ], 'PartitionDateSource' => [ 'base' => NULL, 'refs' => [ 'PartitionedPrefix$PartitionDateSource' => '

Specifies the partition date source for the partitioned prefix. PartitionDateSource can be EventTime or DeliveryTime.

For DeliveryTime, the time in the log file names corresponds to the delivery time for the log files.

For EventTime, The logs delivered are for a specific day only. The year, month, and day correspond to the day on which the event occurred, and the hour, minutes and seconds are set to 00 in the key.

', ], ], 'PartitionedPrefix' => [ 'base' => '

Amazon S3 keys for log objects are partitioned in the following format:

[DestinationPrefix][SourceAccountId]/[SourceRegion]/[SourceBucket]/[YYYY]/[MM]/[DD]/[YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]

PartitionedPrefix defaults to EventTime delivery when server access logs are delivered.

', 'refs' => [ 'TargetObjectKeyFormat$PartitionedPrefix' => '

Partitioned S3 key for log objects.

', ], ], 'Parts' => [ 'base' => NULL, 'refs' => [ 'ListPartsOutput$Parts' => '

Container for elements related to a particular part. A response can contain zero or more Part elements.

', ], ], 'PartsCount' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesParts$TotalPartsCount' => '

The total number of parts.

', 'GetObjectOutput$PartsCount' => '

The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

', 'HeadObjectOutput$PartsCount' => '

The count of parts this object has. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

', 'WriteGetObjectResponseRequest$PartsCount' => '

The count of parts this object has.

', ], ], 'PartsList' => [ 'base' => NULL, 'refs' => [ 'GetObjectAttributesParts$Parts' => '

A container for elements related to a particular part. A response can contain zero or more Parts elements.

', ], ], 'Payer' => [ 'base' => NULL, 'refs' => [ 'GetBucketRequestPaymentOutput$Payer' => '

Specifies who pays for the download and request fees.

', 'RequestPaymentConfiguration$Payer' => '

Specifies who pays for the download and request fees.

', ], ], 'Permission' => [ 'base' => NULL, 'refs' => [ 'Grant$Permission' => '

Specifies the permission given to the grantee.

', ], ], 'Policy' => [ 'base' => NULL, 'refs' => [ 'GetBucketPolicyOutput$Policy' => '

The bucket policy as a JSON document.

', 'PutBucketPolicyRequest$Policy' => '

The bucket policy as a JSON document.

For directory buckets, the only IAM action supported in the bucket policy is s3express:CreateSession.

', ], ], 'PolicyStatus' => [ 'base' => '

The container element for a bucket\'s policy status.

', 'refs' => [ 'GetBucketPolicyStatusOutput$PolicyStatus' => '

The policy status for the specified bucket.

', ], ], 'Prefix' => [ 'base' => NULL, 'refs' => [ 'AnalyticsAndOperator$Prefix' => '

The prefix to use when evaluating an AND predicate: The prefix that an object must have to be included in the metrics results.

', 'AnalyticsFilter$Prefix' => '

The prefix to use when evaluating an analytics filter.

', 'AnalyticsS3BucketDestination$Prefix' => '

The prefix to use when exporting data. The prefix is prepended to all results.

', 'CommonPrefix$Prefix' => '

Container for the specified common prefix.

', 'IntelligentTieringAndOperator$Prefix' => '

An object key name prefix that identifies the subset of objects to which the configuration applies.

', 'IntelligentTieringFilter$Prefix' => '

An object key name prefix that identifies the subset of objects to which the rule applies.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'InventoryFilter$Prefix' => '

The prefix that an object must have to be included in the inventory results.

', 'InventoryS3BucketDestination$Prefix' => '

The prefix that is prepended to all inventory results.

', 'LifecycleRule$Prefix' => '

Prefix identifying one or more objects to which the rule applies. This is no longer used; use Filter instead.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'LifecycleRuleAndOperator$Prefix' => '

Prefix identifying one or more objects to which the rule applies.

', 'LifecycleRuleFilter$Prefix' => '

Prefix identifying one or more objects to which the rule applies.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'ListBucketsOutput$Prefix' => '

If Prefix was sent with the request, it is included in the response.

All bucket names in the response begin with the specified bucket name prefix.

', 'ListBucketsRequest$Prefix' => '

Limits the response to bucket names that begin with the specified bucket name prefix.

', 'ListMultipartUploadsOutput$Prefix' => '

When a prefix is provided in the request, this field contains the specified prefix. The result contains only keys starting with the specified prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

', 'ListMultipartUploadsRequest$Prefix' => '

Lists in-progress uploads only for those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different grouping of keys. (You can think of using prefix to make groups in the same way that you\'d use a folder in a file system.)

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

', 'ListObjectVersionsOutput$Prefix' => '

Selects objects that start with the value supplied by this parameter.

', 'ListObjectVersionsRequest$Prefix' => '

Use this parameter to select only those keys that begin with the specified prefix. You can use prefixes to separate a bucket into different groupings of keys. (You can think of using prefix to make groups in the same way that you\'d use a folder in a file system.) You can use prefix with delimiter to roll up numerous objects into a single result under CommonPrefixes.

', 'ListObjectsOutput$Prefix' => '

Keys that begin with the indicated prefix.

', 'ListObjectsRequest$Prefix' => '

Limits the response to keys that begin with the specified prefix.

', 'ListObjectsV2Output$Prefix' => '

Keys that begin with the indicated prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

', 'ListObjectsV2Request$Prefix' => '

Limits the response to keys that begin with the specified prefix.

Directory buckets - For directory buckets, only prefixes that end in a delimiter (/) are supported.

', 'MetricsAndOperator$Prefix' => '

The prefix used when evaluating an AND predicate.

', 'MetricsFilter$Prefix' => '

The prefix used when evaluating a metrics filter.

', 'ReplicationRule$Prefix' => '

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.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'ReplicationRuleAndOperator$Prefix' => '

An object key name prefix that identifies the subset of objects to which the rule applies.

', 'ReplicationRuleFilter$Prefix' => '

An object key name prefix that identifies the subset of objects to which the rule applies.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', 'Rule$Prefix' => '

Object key prefix that identifies one or more objects to which this rule applies.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', ], ], 'Priority' => [ 'base' => NULL, 'refs' => [ 'ReplicationRule$Priority' => '

The priority indicates which rule has precedence whenever two or more replication rules conflict. Amazon S3 will attempt to replicate objects according to all replication rules. However, if there are two or more rules with the same destination bucket, then objects will be replicated according to the rule with the highest priority. The higher the number, the higher the priority.

For more information, see Replication in the Amazon S3 User Guide.

', ], ], 'Progress' => [ 'base' => '

This data type contains information about progress of an operation.

', 'refs' => [ 'ProgressEvent$Details' => '

The Progress event details.

', ], ], 'ProgressEvent' => [ 'base' => '

This data type contains information about the progress event of an operation.

', 'refs' => [ 'SelectObjectContentEventStream$Progress' => '

The Progress Event.

', ], ], 'Protocol' => [ 'base' => NULL, 'refs' => [ 'Redirect$Protocol' => '

Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

', 'RedirectAllRequestsTo$Protocol' => '

Protocol to use when redirecting requests. The default is the protocol that is used in the original request.

', ], ], 'PublicAccessBlockConfiguration' => [ 'base' => '

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 S3 User Guide.

', 'refs' => [ 'GetPublicAccessBlockOutput$PublicAccessBlockConfiguration' => '

The PublicAccessBlock configuration currently in effect for this Amazon S3 bucket.

', 'PutPublicAccessBlockRequest$PublicAccessBlockConfiguration' => '

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 S3 User Guide.

', ], ], 'PutBucketAccelerateConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketAclRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketAnalyticsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketCorsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketEncryptionRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketIntelligentTieringConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketInventoryConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketLifecycleConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketLifecycleConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketLifecycleRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketLoggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketMetricsConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketNotificationConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketNotificationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketOwnershipControlsRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketPolicyRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketReplicationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketRequestPaymentRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketTaggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketVersioningRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutBucketWebsiteRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectAclOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectAclRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectLegalHoldOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectLegalHoldRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectLockConfigurationOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectLockConfigurationRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectRetentionOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectRetentionRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectTaggingOutput' => [ 'base' => NULL, 'refs' => [], ], 'PutObjectTaggingRequest' => [ 'base' => NULL, 'refs' => [], ], 'PutPublicAccessBlockRequest' => [ 'base' => NULL, 'refs' => [], ], 'QueueArn' => [ 'base' => NULL, 'refs' => [ 'QueueConfiguration$QueueArn' => '

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.

', 'QueueConfigurationDeprecated$Queue' => '

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.

', ], ], 'QueueConfiguration' => [ 'base' => '

Specifies the configuration for publishing messages to an Amazon Simple Queue Service (Amazon SQS) queue when Amazon S3 detects specified events.

', 'refs' => [ 'QueueConfigurationList$member' => NULL, ], ], 'QueueConfigurationDeprecated' => [ 'base' => '

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.

', 'refs' => [ 'NotificationConfigurationDeprecated$QueueConfiguration' => '

This data type is deprecated. 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' => [ 'base' => NULL, 'refs' => [ 'NotificationConfiguration$QueueConfigurations' => '

The Amazon Simple Queue Service queues to publish messages to and the events for which to publish messages.

', ], ], 'Quiet' => [ 'base' => NULL, 'refs' => [ 'Delete$Quiet' => '

Element to enable quiet mode for the request. When you add this element, you must set its value to true.

', ], ], 'QuoteCharacter' => [ 'base' => NULL, 'refs' => [ 'CSVInput$QuoteCharacter' => '

A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

Type: String

Default: "

Ancestors: CSV

', 'CSVOutput$QuoteCharacter' => '

A single character used for escaping when the field delimiter is part of the value. For example, if the value is a, b, Amazon S3 wraps this field value in quotation marks, as follows: " a , b ".

', ], ], 'QuoteEscapeCharacter' => [ 'base' => NULL, 'refs' => [ 'CSVInput$QuoteEscapeCharacter' => '

A single character used for escaping the quotation mark character inside an already escaped value. For example, the value """ a , b """ is parsed as " a , b ".

', 'CSVOutput$QuoteEscapeCharacter' => '

The single character used for escaping the quote character inside an already escaped value.

', ], ], 'QuoteFields' => [ 'base' => NULL, 'refs' => [ 'CSVOutput$QuoteFields' => '

Indicates whether to use quotation marks around output fields.

', ], ], 'Range' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$Range' => '

Downloads the specified byte range of an object. For more information about the HTTP Range header, see https://www.rfc-editor.org/rfc/rfc9110.html#name-range.

Amazon S3 doesn\'t support retrieving multiple ranges of data per GET request.

', 'HeadObjectRequest$Range' => '

HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

', ], ], 'RecordDelimiter' => [ 'base' => NULL, 'refs' => [ 'CSVInput$RecordDelimiter' => '

A single character used to separate individual records in the input. Instead of the default value, you can specify an arbitrary delimiter.

', 'CSVOutput$RecordDelimiter' => '

A single character used to separate individual records in the output. Instead of the default value, you can specify an arbitrary delimiter.

', 'JSONOutput$RecordDelimiter' => '

The value used to separate individual records in the output. If no value is specified, Amazon S3 uses a newline character (\'\\n\').

', ], ], 'RecordsEvent' => [ 'base' => '

The container for the records event.

', 'refs' => [ 'SelectObjectContentEventStream$Records' => '

The Records Event.

', ], ], 'Redirect' => [ 'base' => '

Specifies how requests are redirected. In the event of an error, you can specify a different error code to return.

', 'refs' => [ 'RoutingRule$Redirect' => '

Container for redirect information. You can redirect requests to another host, to another page, or with another protocol. In the event of an error, you can specify a different error code to return.

', ], ], 'RedirectAllRequestsTo' => [ 'base' => '

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

', 'refs' => [ 'GetBucketWebsiteOutput$RedirectAllRequestsTo' => '

Specifies the redirect behavior of all requests to a website endpoint of an Amazon S3 bucket.

', 'WebsiteConfiguration$RedirectAllRequestsTo' => '

The redirect behavior for every request to this bucket\'s website endpoint.

If you specify this property, you can\'t specify any other property.

', ], ], 'Region' => [ 'base' => NULL, 'refs' => [ 'HeadBucketOutput$BucketRegion' => '

The Region that the bucket is located.

', ], ], 'ReplaceKeyPrefixWith' => [ 'base' => NULL, 'refs' => [ 'Redirect$ReplaceKeyPrefixWith' => '

The object key prefix to use in the redirect request. For example, to redirect requests for all pages with prefix docs/ (objects in the docs/ folder) to documents/, you can set a condition block with KeyPrefixEquals set to docs/ and in the Redirect set ReplaceKeyPrefixWith to /documents. Not required if one of the siblings is present. Can be present only if ReplaceKeyWith is not provided.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', ], ], 'ReplaceKeyWith' => [ 'base' => NULL, 'refs' => [ 'Redirect$ReplaceKeyWith' => '

The specific object key to use in the redirect request. For example, redirect request to error.html. Not required if one of the siblings is present. Can be present only if ReplaceKeyPrefixWith is not provided.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', ], ], 'ReplicaKmsKeyID' => [ 'base' => NULL, 'refs' => [ 'EncryptionConfiguration$ReplicaKmsKeyID' => '

Specifies the ID (Key ARN or Alias ARN) of the customer managed Amazon Web Services KMS key stored in Amazon Web Services Key Management Service (KMS) for the destination bucket. Amazon S3 uses this key to encrypt replica objects. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', ], ], 'ReplicaModifications' => [ 'base' => '

A filter that you can specify for selection for modifications on replicas. Amazon S3 doesn\'t replicate replica modifications by default. In the latest version of replication configuration (when Filter is specified), you can specify this element and set the status to Enabled to replicate modifications on replicas.

If you don\'t specify the Filter element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, this element is not allowed.

', 'refs' => [ 'SourceSelectionCriteria$ReplicaModifications' => '

A filter that you can specify for selections for modifications on replicas. Amazon S3 doesn\'t replicate replica modifications by default. In the latest version of replication configuration (when Filter is specified), you can specify this element and set the status to Enabled to replicate modifications on replicas.

If you don\'t specify the Filter element, Amazon S3 assumes that the replication configuration is the earlier version, V1. In the earlier version, this element is not allowed

', ], ], 'ReplicaModificationsStatus' => [ 'base' => NULL, 'refs' => [ 'ReplicaModifications$Status' => '

Specifies whether Amazon S3 replicates modifications on replicas.

', ], ], 'ReplicationConfiguration' => [ 'base' => '

A container for replication rules. You can add up to 1,000 rules. The maximum size of a replication configuration is 2 MB.

', 'refs' => [ 'GetBucketReplicationOutput$ReplicationConfiguration' => NULL, 'PutBucketReplicationRequest$ReplicationConfiguration' => NULL, ], ], 'ReplicationRule' => [ 'base' => '

Specifies which Amazon S3 objects to replicate and where to store the replicas.

', 'refs' => [ 'ReplicationRules$member' => NULL, ], ], 'ReplicationRuleAndOperator' => [ 'base' => '

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:

', 'refs' => [ 'ReplicationRuleFilter$And' => '

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:

', ], ], 'ReplicationRuleFilter' => [ 'base' => '

A filter that identifies the subset of objects to which the replication rule applies. A Filter must specify exactly one Prefix, Tag, or an And child element.

', 'refs' => [ 'ReplicationRule$Filter' => NULL, ], ], 'ReplicationRuleStatus' => [ 'base' => NULL, 'refs' => [ 'ReplicationRule$Status' => '

Specifies whether the rule is enabled.

', ], ], 'ReplicationRules' => [ 'base' => NULL, 'refs' => [ 'ReplicationConfiguration$Rules' => '

A container for one or more replication rules. A replication configuration must have at least one rule and can contain a maximum of 1,000 rules.

', ], ], 'ReplicationStatus' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$ReplicationStatus' => '

Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$ReplicationStatus' => '

Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.

In replication, you have a source bucket on which you configure replication and destination bucket or buckets 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:

For more information, see Replication.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$ReplicationStatus' => '

Indicates if request involves bucket that is either a source or destination in a Replication rule. For more information about S3 Replication, see Replication.

', ], ], 'ReplicationTime' => [ 'base' => '

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.

', 'refs' => [ 'Destination$ReplicationTime' => '

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.

', ], ], 'ReplicationTimeStatus' => [ 'base' => NULL, 'refs' => [ 'ReplicationTime$Status' => '

Specifies whether the replication time is enabled.

', ], ], 'ReplicationTimeValue' => [ 'base' => '

A container specifying the time value for S3 Replication Time Control (S3 RTC) and replication metrics EventThreshold.

', 'refs' => [ 'Metrics$EventThreshold' => '

A container specifying the time threshold for emitting the s3:Replication:OperationMissedThreshold event.

', 'ReplicationTime$Time' => '

A container specifying the time by which replication should be complete for all objects and operations on objects.

', ], ], 'RequestCharged' => [ 'base' => '

If present, indicates that the requester was successfully charged for the request.

This functionality is not supported for directory buckets.

', 'refs' => [ 'AbortMultipartUploadOutput$RequestCharged' => NULL, 'CompleteMultipartUploadOutput$RequestCharged' => NULL, 'CopyObjectOutput$RequestCharged' => NULL, 'CreateMultipartUploadOutput$RequestCharged' => NULL, 'DeleteObjectOutput$RequestCharged' => NULL, 'DeleteObjectsOutput$RequestCharged' => NULL, 'GetBucketAccelerateConfigurationOutput$RequestCharged' => NULL, 'GetObjectAclOutput$RequestCharged' => NULL, 'GetObjectAttributesOutput$RequestCharged' => NULL, 'GetObjectOutput$RequestCharged' => NULL, 'GetObjectTorrentOutput$RequestCharged' => NULL, 'HeadObjectOutput$RequestCharged' => NULL, 'ListMultipartUploadsOutput$RequestCharged' => NULL, 'ListObjectVersionsOutput$RequestCharged' => NULL, 'ListObjectsOutput$RequestCharged' => NULL, 'ListObjectsV2Output$RequestCharged' => NULL, 'ListPartsOutput$RequestCharged' => NULL, 'PutObjectAclOutput$RequestCharged' => NULL, 'PutObjectLegalHoldOutput$RequestCharged' => NULL, 'PutObjectLockConfigurationOutput$RequestCharged' => NULL, 'PutObjectOutput$RequestCharged' => NULL, 'PutObjectRetentionOutput$RequestCharged' => NULL, 'RestoreObjectOutput$RequestCharged' => NULL, 'UploadPartCopyOutput$RequestCharged' => NULL, 'UploadPartOutput$RequestCharged' => NULL, 'WriteGetObjectResponseRequest$RequestCharged' => NULL, ], ], 'RequestPayer' => [ 'base' => '

Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'refs' => [ 'AbortMultipartUploadRequest$RequestPayer' => NULL, 'CompleteMultipartUploadRequest$RequestPayer' => NULL, 'CopyObjectRequest$RequestPayer' => NULL, 'CreateMultipartUploadRequest$RequestPayer' => NULL, 'DeleteObjectRequest$RequestPayer' => NULL, 'DeleteObjectsRequest$RequestPayer' => NULL, 'GetBucketAccelerateConfigurationRequest$RequestPayer' => NULL, 'GetObjectAclRequest$RequestPayer' => NULL, 'GetObjectAttributesRequest$RequestPayer' => NULL, 'GetObjectLegalHoldRequest$RequestPayer' => NULL, 'GetObjectRequest$RequestPayer' => NULL, 'GetObjectRetentionRequest$RequestPayer' => NULL, 'GetObjectTaggingRequest$RequestPayer' => NULL, 'GetObjectTorrentRequest$RequestPayer' => NULL, 'HeadObjectRequest$RequestPayer' => NULL, 'ListMultipartUploadsRequest$RequestPayer' => NULL, 'ListObjectVersionsRequest$RequestPayer' => NULL, 'ListObjectsRequest$RequestPayer' => '

Confirms that the requester knows that she or he will be charged for the list objects request. Bucket owners need not specify this parameter in their requests.

', 'ListObjectsV2Request$RequestPayer' => '

Confirms that the requester knows that she or he will be charged for the list objects request in V2 style. Bucket owners need not specify this parameter in their requests.

This functionality is not supported for directory buckets.

', 'ListPartsRequest$RequestPayer' => NULL, 'PutObjectAclRequest$RequestPayer' => NULL, 'PutObjectLegalHoldRequest$RequestPayer' => NULL, 'PutObjectLockConfigurationRequest$RequestPayer' => NULL, 'PutObjectRequest$RequestPayer' => NULL, 'PutObjectRetentionRequest$RequestPayer' => NULL, 'PutObjectTaggingRequest$RequestPayer' => NULL, 'RestoreObjectRequest$RequestPayer' => NULL, 'UploadPartCopyRequest$RequestPayer' => NULL, 'UploadPartRequest$RequestPayer' => NULL, ], ], 'RequestPaymentConfiguration' => [ 'base' => '

Container for Payer.

', 'refs' => [ 'PutBucketRequestPaymentRequest$RequestPaymentConfiguration' => '

Container for Payer.

', ], ], 'RequestProgress' => [ 'base' => '

Container for specifying if periodic QueryProgress messages should be sent.

', 'refs' => [ 'SelectObjectContentRequest$RequestProgress' => '

Specifies if periodic request progress information should be enabled.

', ], ], 'RequestRoute' => [ 'base' => NULL, 'refs' => [ 'WriteGetObjectResponseRequest$RequestRoute' => '

Route prefix to the HTTP URL generated.

', ], ], 'RequestToken' => [ 'base' => NULL, 'refs' => [ 'WriteGetObjectResponseRequest$RequestToken' => '

A single use encrypted token that maps WriteGetObjectResponse to the end user GetObject request.

', ], ], 'ResponseCacheControl' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ResponseCacheControl' => '

Sets the Cache-Control header of the response.

', 'HeadObjectRequest$ResponseCacheControl' => '

Sets the Cache-Control header of the response.

', ], ], 'ResponseContentDisposition' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ResponseContentDisposition' => '

Sets the Content-Disposition header of the response.

', 'HeadObjectRequest$ResponseContentDisposition' => '

Sets the Content-Disposition header of the response.

', ], ], 'ResponseContentEncoding' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ResponseContentEncoding' => '

Sets the Content-Encoding header of the response.

', 'HeadObjectRequest$ResponseContentEncoding' => '

Sets the Content-Encoding header of the response.

', ], ], 'ResponseContentLanguage' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ResponseContentLanguage' => '

Sets the Content-Language header of the response.

', 'HeadObjectRequest$ResponseContentLanguage' => '

Sets the Content-Language header of the response.

', ], ], 'ResponseContentType' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ResponseContentType' => '

Sets the Content-Type header of the response.

', 'HeadObjectRequest$ResponseContentType' => '

Sets the Content-Type header of the response.

', ], ], 'ResponseExpires' => [ 'base' => NULL, 'refs' => [ 'GetObjectRequest$ResponseExpires' => '

Sets the Expires header of the response.

', 'HeadObjectRequest$ResponseExpires' => '

Sets the Expires header of the response.

', ], ], 'Restore' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$Restore' => '

Provides information about object restoration action and expiration time of the restored object copy.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'HeadObjectOutput$Restore' => '

If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object restoration is in progress, the header returns the value ongoing-request="true".

For more information about archiving objects, see Transitioning Objects: General Considerations.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'WriteGetObjectResponseRequest$Restore' => '

Provides information about object restoration operation and expiration time of the restored object copy.

', ], ], 'RestoreExpiryDate' => [ 'base' => NULL, 'refs' => [ 'RestoreStatus$RestoreExpiryDate' => '

Indicates when the restored copy will expire. This value is populated only if the object has already been restored. For example:

x-amz-optional-object-attributes: IsRestoreInProgress="false", RestoreExpiryDate="2012-12-21T00:00:00.000Z"

', ], ], 'RestoreObjectOutput' => [ 'base' => NULL, 'refs' => [], ], 'RestoreObjectRequest' => [ 'base' => NULL, 'refs' => [], ], 'RestoreOutputPath' => [ 'base' => NULL, 'refs' => [ 'RestoreObjectOutput$RestoreOutputPath' => '

Indicates the path in the provided S3 output location where Select results will be restored to.

', ], ], 'RestoreRequest' => [ 'base' => '

Container for restore job parameters.

', 'refs' => [ 'RestoreObjectRequest$RestoreRequest' => NULL, ], ], 'RestoreRequestType' => [ 'base' => NULL, 'refs' => [ 'RestoreRequest$Type' => '

Type of restore request.

', ], ], 'RestoreStatus' => [ 'base' => '

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'refs' => [ 'Object$RestoreStatus' => '

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'ObjectVersion$RestoreStatus' => '

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see Working with archived objects in the Amazon S3 User Guide.

', ], ], 'Role' => [ 'base' => NULL, 'refs' => [ 'ReplicationConfiguration$Role' => '

The Amazon Resource Name (ARN) of the Identity and Access Management (IAM) role that Amazon S3 assumes when replicating objects. For more information, see How to Set Up Replication in the Amazon S3 User Guide.

', ], ], 'RoutingRule' => [ 'base' => '

Specifies the redirect behavior and when a redirect is applied. For more information about routing rules, see Configuring advanced conditional redirects in the Amazon S3 User Guide.

', 'refs' => [ 'RoutingRules$member' => NULL, ], ], 'RoutingRules' => [ 'base' => NULL, 'refs' => [ 'GetBucketWebsiteOutput$RoutingRules' => '

Rules that define when a redirect is applied and the redirect behavior.

', 'WebsiteConfiguration$RoutingRules' => '

Rules that define when a redirect is applied and the redirect behavior.

', ], ], 'Rule' => [ 'base' => '

Specifies lifecycle rules for an Amazon S3 bucket. For more information, see Put Bucket Lifecycle Configuration in the Amazon S3 API Reference. For examples, see Put Bucket Lifecycle Configuration Examples.

', 'refs' => [ 'Rules$member' => NULL, ], ], 'Rules' => [ 'base' => NULL, 'refs' => [ 'GetBucketLifecycleOutput$Rules' => '

Container for a lifecycle rule.

', 'LifecycleConfiguration$Rules' => '

Specifies lifecycle configuration rules for an Amazon S3 bucket.

', ], ], 'S3KeyFilter' => [ 'base' => '

A container for object key name prefix and suffix filtering rules.

', 'refs' => [ 'NotificationConfigurationFilter$Key' => NULL, ], ], 'S3Location' => [ 'base' => '

Describes an Amazon S3 location that will receive the results of the restore request.

', 'refs' => [ 'OutputLocation$S3' => '

Describes an S3 location that will receive the results of the restore request.

', ], ], 'SSECustomerAlgorithm' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadRequest$SSECustomerAlgorithm' => '

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is required only when the object was created using a checksum algorithm or if your bucket policy requires the use of SSE-C. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'CopyObjectOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'CopyObjectRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

When you perform a CopyObject operation, if you want to use a different type of encryption setting for the target object, you can specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in your request is different from the default encryption configuration of the destination bucket, the encryption setting in your request takes precedence.

This functionality is not supported when the destination bucket is a directory bucket.

', 'CreateMultipartUploadOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

', 'GetObjectAttributesRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

', 'GetObjectOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'GetObjectRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when decrypting the object (for example, AES256).

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:

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'HeadObjectRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

', 'ListPartsRequest$SSECustomerAlgorithm' => '

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'PutObjectOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

', 'SelectObjectContentRequest$SSECustomerAlgorithm' => '

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

', 'UploadPartCopyOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'UploadPartCopyRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported when the destination bucket is a directory bucket.

', 'UploadPartOutput$SSECustomerAlgorithm' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that\'s used.

This functionality is not supported for directory buckets.

', 'UploadPartRequest$SSECustomerAlgorithm' => '

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$SSECustomerAlgorithm' => '

Encryption algorithm used if server-side encryption with a customer-provided encryption key was specified for object stored in Amazon S3.

', ], ], 'SSECustomerKey' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadRequest$SSECustomerKey' => '

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'CopyObjectRequest$SSECustomerKey' => '

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 functionality is not supported when the destination bucket is a directory bucket.

', 'CreateMultipartUploadRequest$SSECustomerKey' => '

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 functionality is not supported for directory buckets.

', 'GetObjectAttributesRequest$SSECustomerKey' => '

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 functionality is not supported for directory buckets.

', 'GetObjectRequest$SSECustomerKey' => '

Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data before storing it. This value is used to decrypt the object when recovering it and must match the one used when storing the data. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

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:

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'HeadObjectRequest$SSECustomerKey' => '

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 functionality is not supported for directory buckets.

', 'ListPartsRequest$SSECustomerKey' => '

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$SSECustomerKey' => '

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 functionality is not supported for directory buckets.

', 'SelectObjectContentRequest$SSECustomerKey' => '

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

', 'UploadPartCopyRequest$SSECustomerKey' => '

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.

This functionality is not supported when the destination bucket is a directory bucket.

', 'UploadPartRequest$SSECustomerKey' => '

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.

This functionality is not supported for directory buckets.

', ], ], 'SSECustomerKeyMD5' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadRequest$SSECustomerKeyMD5' => '

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'CopyObjectOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'CopyObjectRequest$SSECustomerKeyMD5' => '

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.

This functionality is not supported when the destination bucket is a directory bucket.

', 'CreateMultipartUploadOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$SSECustomerKeyMD5' => '

Specifies the 128-bit MD5 digest of the customer-provided 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.

This functionality is not supported for directory buckets.

', 'GetObjectAttributesRequest$SSECustomerKeyMD5' => '

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.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'GetObjectRequest$SSECustomerKeyMD5' => '

Specifies the 128-bit MD5 digest of the customer-provided 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.

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:

For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'HeadObjectRequest$SSECustomerKeyMD5' => '

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.

This functionality is not supported for directory buckets.

', 'ListPartsRequest$SSECustomerKeyMD5' => '

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', 'PutObjectOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$SSECustomerKeyMD5' => '

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.

This functionality is not supported for directory buckets.

', 'SelectObjectContentRequest$SSECustomerKeyMD5' => '

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

', 'UploadPartCopyOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'UploadPartCopyRequest$SSECustomerKeyMD5' => '

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.

This functionality is not supported when the destination bucket is a directory bucket.

', 'UploadPartOutput$SSECustomerKeyMD5' => '

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

', 'UploadPartRequest$SSECustomerKeyMD5' => '

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.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$SSECustomerKeyMD5' => '

128-bit MD5 digest of customer-provided encryption key used in Amazon S3 to encrypt data stored in S3. For more information, see Protecting data using server-side encryption with customer-provided encryption keys (SSE-C).

', ], ], 'SSEKMS' => [ 'base' => '

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

', 'refs' => [ 'InventoryEncryption$SSEKMS' => '

Specifies the use of SSE-KMS to encrypt delivered inventory reports.

', ], ], 'SSEKMSEncryptionContext' => [ 'base' => NULL, 'refs' => [ 'CopyObjectOutput$SSEKMSEncryptionContext' => '

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

', 'CopyObjectRequest$SSEKMSEncryptionContext' => '

Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for the destination object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

General purpose buckets - This value must be explicitly added to specify encryption context for CopyObject requests if you want an additional encryption context for your destination object. The additional encryption context of the source object won\'t be copied to the destination object. For more information, see Encryption context in the Amazon S3 User Guide.

Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

', 'CreateMultipartUploadOutput$SSEKMSEncryptionContext' => '

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.

', 'CreateMultipartUploadRequest$SSEKMSEncryptionContext' => '

Specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.

Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

', 'CreateSessionOutput$SSEKMSEncryptionContext' => '

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.

', 'CreateSessionRequest$SSEKMSEncryptionContext' => '

Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.

General purpose buckets - This value must be explicitly added during CopyObject operations if you want an additional encryption context for your object. For more information, see Encryption context in the Amazon S3 User Guide.

Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

', 'PutObjectOutput$SSEKMSEncryptionContext' => '

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.

', 'PutObjectRequest$SSEKMSEncryptionContext' => '

Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future GetObject operations on this object.

General purpose buckets - This value must be explicitly added during CopyObject operations if you want an additional encryption context for your object. For more information, see Encryption context in the Amazon S3 User Guide.

Directory buckets - You can optionally provide an explicit encryption context value. The value must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is not supported.

', ], ], 'SSEKMSKeyId' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'CopyObjectOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'CopyObjectRequest$SSEKMSKeyId' => '

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they\'re not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.

Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, the x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that\'s configured for your directory bucket\'s default encryption setting. If you want to specify the x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that\'s configured for your directory bucket\'s default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn\'t supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn\'t supported.

', 'CreateMultipartUploadOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'CreateMultipartUploadRequest$SSEKMSKeyId' => '

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn\'t exist in the same account that\'s issuing the command, you must use the full Key ARN not the Key ID.

General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify x-amz-server-side-encryption:aws:kms or x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3) to protect the data.

Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, the x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that\'s configured for your directory bucket\'s default encryption setting. If you want to specify the x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that\'s configured for your directory bucket\'s default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn\'t supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn\'t supported.

', 'CreateSessionOutput$SSEKMSKeyId' => '

If you specify x-amz-server-side-encryption with aws:kms, this header indicates the ID of the KMS symmetric encryption customer managed key that was used for object encryption.

', 'CreateSessionRequest$SSEKMSKeyId' => '

If you specify x-amz-server-side-encryption with aws:kms, you must specify the x-amz-server-side-encryption-aws-kms-key-id header with the ID (Key ID or Key ARN) of the KMS symmetric encryption customer managed key to use. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn\'t supported. Also, if the KMS key doesn\'t exist in the same account that\'t issuing the command, you must use the full Key ARN not the Key ID.

Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn\'t supported.

', 'Encryption$KMSKeyId' => '

If the encryption type is aws:kms, this optional value specifies the ID of the symmetric encryption customer managed key to use for encryption of job results. Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'GetObjectOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'HeadObjectOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'PutObjectOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'PutObjectRequest$SSEKMSKeyId' => '

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn\'t exist in the same account that\'s issuing the command, you must use the full Key ARN not the Key ID.

General purpose buckets - If you specify x-amz-server-side-encryption with aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias) of the KMS key to use. If you specify x-amz-server-side-encryption:aws:kms or x-amz-server-side-encryption:aws:kms:dsse, but do not provide x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (aws/s3) to protect the data.

Directory buckets - If you specify x-amz-server-side-encryption with aws:kms, the x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS symmetric encryption customer managed key that\'s configured for your directory bucket\'s default encryption setting. If you want to specify the x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that\'s configured for your directory bucket\'s default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn\'t supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. The Amazon Web Services managed key (aws/s3) isn\'t supported.

', 'SSEKMS$KeyId' => '

Specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key to use for encrypting inventory reports.

', 'ServerSideEncryptionByDefault$KMSMasterKeyID' => '

Amazon Web Services Key Management Service (KMS) customer managed key ID to use for the default encryption.

You can specify the key ID, key alias, or the Amazon Resource Name (ARN) of the KMS key.

If you are using encryption with cross-account or Amazon Web Services service operations, you must use a fully qualified KMS key ARN. For more information, see Using encryption for cross-account operations.

Amazon S3 only supports symmetric encryption KMS keys. For more information, see Asymmetric keys in Amazon Web Services KMS in the Amazon Web Services Key Management Service Developer Guide.

', 'UploadPartCopyOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'UploadPartOutput$SSEKMSKeyId' => '

If present, indicates the ID of the KMS key that was used for object encryption.

', 'WriteGetObjectResponseRequest$SSEKMSKeyId' => '

If present, specifies the ID (Key ID, Key ARN, or Key Alias) of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for stored in Amazon S3 object.

', ], ], 'SSES3' => [ 'base' => '

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

', 'refs' => [ 'InventoryEncryption$SSES3' => '

Specifies the use of SSE-S3 to encrypt delivered inventory reports.

', ], ], 'ScanRange' => [ 'base' => '

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.

', 'refs' => [ 'SelectObjectContentRequest$ScanRange' => '

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.

ScanRangemay be used in the following ways:

', ], ], 'SelectObjectContentEventStream' => [ 'base' => '

The container for selecting objects from a content event stream.

', 'refs' => [ 'SelectObjectContentOutput$Payload' => '

The array of results.

', ], ], 'SelectObjectContentOutput' => [ 'base' => NULL, 'refs' => [], ], 'SelectObjectContentRequest' => [ 'base' => '

Request to filter the contents of an Amazon S3 object based on a simple Structured Query Language (SQL) statement. In the request, along with the SQL expression, you must specify a data serialization format (JSON or CSV) of the object. Amazon S3 uses this to parse object data into records. It returns only records that match the specified SQL expression. You must also specify the data serialization format for the response. For more information, see S3Select API Documentation.

', 'refs' => [], ], 'SelectParameters' => [ 'base' => '

Describes the parameters for Select job types.

', 'refs' => [ 'RestoreRequest$SelectParameters' => '

Describes the parameters for Select job types.

', ], ], 'ServerSideEncryption' => [ 'base' => NULL, 'refs' => [ 'CompleteMultipartUploadOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

', 'CopyObjectOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

', 'CopyObjectRequest$ServerSideEncryption' => '

The server-side encryption algorithm used when storing this object in Amazon S3. Unrecognized or unsupported values won’t write a destination object and will receive a 400 Bad Request response.

Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if you don\'t specify encryption information in your copy request, the encryption setting of the target object is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a different default encryption configuration, Amazon S3 uses the corresponding encryption key to encrypt the target object copy.

With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side Encryption in the Amazon S3 User Guide.

General purpose buckets

Directory buckets

', 'CreateMultipartUploadOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

', 'CreateMultipartUploadRequest$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

', 'CreateSessionOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store objects in the directory bucket.

', 'CreateSessionRequest$ServerSideEncryption' => '

The server-side encryption algorithm to use when you store objects in the directory bucket.

For directory buckets, there are only two supported options for server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). By default, Amazon S3 encrypts data with SSE-S3. For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide.

', 'Encryption$EncryptionType' => '

The server-side encryption algorithm used when storing job results in Amazon S3 (for example, AES256, aws:kms).

', 'GetObjectOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3.

', 'HeadObjectOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

', 'PutObjectOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3.

', 'PutObjectRequest$ServerSideEncryption' => '

The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).

', 'ServerSideEncryptionByDefault$SSEAlgorithm' => '

Server-side encryption algorithm to use for the default encryption.

For directory buckets, there are only two supported values for server-side encryption: AES256 and aws:kms.

', 'UploadPartCopyOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

', 'UploadPartOutput$ServerSideEncryption' => '

The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms).

', 'WriteGetObjectResponseRequest$ServerSideEncryption' => '

The server-side encryption algorithm used when storing requested object in Amazon S3 (for example, AES256, aws:kms).

', ], ], 'ServerSideEncryptionByDefault' => [ 'base' => '

Describes the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn\'t specify any server-side encryption, this default encryption will be applied. For more information, see PutBucketEncryption.

', 'refs' => [ 'ServerSideEncryptionRule$ApplyServerSideEncryptionByDefault' => '

Specifies the default server-side encryption to apply to new objects in the bucket. If a PUT Object request doesn\'t specify any server-side encryption, this default encryption will be applied.

', ], ], 'ServerSideEncryptionConfiguration' => [ 'base' => '

Specifies the default server-side-encryption configuration.

', 'refs' => [ 'GetBucketEncryptionOutput$ServerSideEncryptionConfiguration' => NULL, 'PutBucketEncryptionRequest$ServerSideEncryptionConfiguration' => NULL, ], ], 'ServerSideEncryptionRule' => [ 'base' => '

Specifies the default server-side encryption configuration.

', 'refs' => [ 'ServerSideEncryptionRules$member' => NULL, ], ], 'ServerSideEncryptionRules' => [ 'base' => NULL, 'refs' => [ 'ServerSideEncryptionConfiguration$Rules' => '

Container for information about a particular server-side encryption configuration rule.

', ], ], 'SessionCredentialValue' => [ 'base' => NULL, 'refs' => [ 'SessionCredentials$SecretAccessKey' => '

A key that\'s used with the access key ID to cryptographically sign programmatic Amazon Web Services requests. Signing a request identifies the sender and prevents the request from being altered.

', 'SessionCredentials$SessionToken' => '

A part of the temporary security credentials. The session token is used to validate the temporary security credentials.

', ], ], 'SessionCredentials' => [ 'base' => '

The established temporary security credentials of the session.

Directory buckets - These session credentials are only supported for the authentication and authorization of Zonal endpoint API operations on directory buckets.

', 'refs' => [ 'CreateSessionOutput$Credentials' => '

The established temporary security credentials for the created session.

', ], ], 'SessionExpiration' => [ 'base' => NULL, 'refs' => [ 'SessionCredentials$Expiration' => '

Temporary security credentials expire after a specified interval. After temporary credentials expire, any calls that you make with those credentials will fail. So you must generate a new set of temporary credentials. Temporary credentials cannot be extended or refreshed beyond the original specified interval.

', ], ], 'SessionMode' => [ 'base' => NULL, 'refs' => [ 'CreateSessionRequest$SessionMode' => '

Specifies the mode of the session that will be created, either ReadWrite or ReadOnly. By default, a ReadWrite session is created. A ReadWrite session is capable of executing all the Zonal endpoint API operations on a directory bucket. A ReadOnly session is constrained to execute the following Zonal endpoint API operations: GetObject, HeadObject, ListObjectsV2, GetObjectAttributes, ListParts, and ListMultipartUploads.

', ], ], 'Setting' => [ 'base' => NULL, 'refs' => [ 'PublicAccessBlockConfiguration$BlockPublicAcls' => '

Specifies whether Amazon S3 should block public access control lists (ACLs) for this bucket and objects in this bucket. Setting this element to TRUE causes the following behavior:

Enabling this setting doesn\'t affect existing policies or ACLs.

', 'PublicAccessBlockConfiguration$IgnorePublicAcls' => '

Specifies whether Amazon S3 should ignore public ACLs for this bucket and objects in this bucket. Setting this element to TRUE causes Amazon S3 to ignore all public ACLs on this bucket and objects in this bucket.

Enabling this setting doesn\'t affect the persistence of any existing ACLs and doesn\'t prevent new public ACLs from being set.

', 'PublicAccessBlockConfiguration$BlockPublicPolicy' => '

Specifies whether Amazon S3 should block public bucket policies for this bucket. Setting this element to TRUE causes Amazon S3 to reject calls to PUT Bucket policy if the specified bucket policy allows public access.

Enabling this setting doesn\'t affect existing bucket policies.

', 'PublicAccessBlockConfiguration$RestrictPublicBuckets' => '

Specifies whether Amazon S3 should restrict public bucket policies for this bucket. Setting this element to TRUE restricts access to this bucket to only Amazon Web Services service principals and authorized users within this account if the bucket has a public policy.

Enabling this setting doesn\'t affect previously stored bucket policies, except that public and cross-account access within any public bucket policy, including non-public delegation to specific accounts, is blocked.

', ], ], 'SimplePrefix' => [ 'base' => '

To use simple format for S3 keys for log objects, set SimplePrefix to an empty object.

[DestinationPrefix][YYYY]-[MM]-[DD]-[hh]-[mm]-[ss]-[UniqueString]

', 'refs' => [ 'TargetObjectKeyFormat$SimplePrefix' => '

To use the simple format for S3 keys for log objects. To specify SimplePrefix format, set SimplePrefix to {}.

', ], ], 'Size' => [ 'base' => NULL, 'refs' => [ 'Object$Size' => '

Size in bytes of the object

', 'ObjectIdentifier$Size' => '

If present, the objects are deleted only if its size matches the provided size in bytes.

This functionality is only supported for directory buckets.

', 'ObjectPart$Size' => '

The size of the uploaded part in bytes.

', 'ObjectVersion$Size' => '

Size in bytes of the object.

', 'Part$Size' => '

Size in bytes of the uploaded part data.

', 'PutObjectOutput$Size' => '

The size of the object in bytes. This will only be present if you append to an object.

This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.

', ], ], 'SkipValidation' => [ 'base' => NULL, 'refs' => [ 'PutBucketNotificationConfigurationRequest$SkipDestinationValidation' => '

Skips validation of Amazon SQS, Amazon SNS, and Lambda destinations. True or false value.

', ], ], 'SourceSelectionCriteria' => [ 'base' => '

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

', 'refs' => [ 'ReplicationRule$SourceSelectionCriteria' => '

A container that describes additional filters for identifying the source objects that you want to replicate. You can choose to enable or disable the replication of these objects. Currently, Amazon S3 supports only the filter that you can specify for objects created with server-side encryption using a customer managed key stored in Amazon Web Services Key Management Service (SSE-KMS).

', ], ], 'SseKmsEncryptedObjects' => [ 'base' => '

A container for filter information for the selection of S3 objects encrypted with Amazon Web Services KMS.

', 'refs' => [ 'SourceSelectionCriteria$SseKmsEncryptedObjects' => '

A container for filter information for the selection of Amazon S3 objects encrypted with Amazon Web Services KMS. If you include SourceSelectionCriteria in the replication configuration, this element is required.

', ], ], 'SseKmsEncryptedObjectsStatus' => [ 'base' => NULL, 'refs' => [ 'SseKmsEncryptedObjects$Status' => '

Specifies whether Amazon S3 replicates objects created with server-side encryption using an Amazon Web Services KMS key stored in Amazon Web Services Key Management Service.

', ], ], 'Start' => [ 'base' => NULL, 'refs' => [ 'ScanRange$Start' => '

Specifies the start of the byte range. This parameter is optional. Valid values: non-negative integers. The default value is 0. If only start is supplied, it means scan from that point to the end of the file. For example, <scanrange><start>50</start></scanrange> means scan from byte 50 until the end of the file.

', ], ], 'StartAfter' => [ 'base' => NULL, 'refs' => [ 'ListObjectsV2Output$StartAfter' => '

If StartAfter was sent with the request, it is included in the response.

This functionality is not supported for directory buckets.

', 'ListObjectsV2Request$StartAfter' => '

StartAfter is where you want Amazon S3 to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.

This functionality is not supported for directory buckets.

', ], ], 'Stats' => [ 'base' => '

Container for the stats details.

', 'refs' => [ 'StatsEvent$Details' => '

The Stats event details.

', ], ], 'StatsEvent' => [ 'base' => '

Container for the Stats Event.

', 'refs' => [ 'SelectObjectContentEventStream$Stats' => '

The Stats Event.

', ], ], 'StorageClass' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$StorageClass' => '

If the x-amz-storage-class header is not used, the copied object will be stored in the STANDARD Storage Class by default. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class.

You can use the CopyObject action to change the storage class of an object that is already stored in Amazon S3 by using the x-amz-storage-class header. For more information, see Storage Classes in the Amazon S3 User Guide.

Before using an object as a source object for the copy operation, you must restore a copy of it if it meets any of the following conditions:

For more information, see RestoreObject and Copying Objects in the Amazon S3 User Guide.

', 'CreateMultipartUploadRequest$StorageClass' => '

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

', 'Destination$StorageClass' => '

The storage class to use when replicating objects, such as S3 Standard or reduced redundancy. By default, Amazon S3 uses the storage class of the source object to create the object replica.

For valid values, see the StorageClass element of the PUT Bucket replication action in the Amazon S3 API Reference.

', 'GetObjectAttributesOutput$StorageClass' => '

Provides the storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'GetObjectOutput$StorageClass' => '

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'HeadObjectOutput$StorageClass' => '

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'InvalidObjectState$StorageClass' => NULL, 'ListPartsOutput$StorageClass' => '

The class of storage used to store the uploaded object.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'MultipartUpload$StorageClass' => '

The class of storage used to store the object.

Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

', 'PutObjectRequest$StorageClass' => '

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

', 'S3Location$StorageClass' => '

The class of storage used to store the restore results.

', 'WriteGetObjectResponseRequest$StorageClass' => '

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

For more information, see Storage Classes.

', ], ], 'StorageClassAnalysis' => [ 'base' => '

Specifies data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes for an Amazon S3 bucket.

', 'refs' => [ 'AnalyticsConfiguration$StorageClassAnalysis' => '

Contains data related to access patterns to be collected and made available to analyze the tradeoffs between different storage classes.

', ], ], 'StorageClassAnalysisDataExport' => [ 'base' => '

Container for data related to the storage class analysis for an Amazon S3 bucket for export.

', 'refs' => [ 'StorageClassAnalysis$DataExport' => '

Specifies how data related to the storage class analysis for an Amazon S3 bucket should be exported.

', ], ], 'StorageClassAnalysisSchemaVersion' => [ 'base' => NULL, 'refs' => [ 'StorageClassAnalysisDataExport$OutputSchemaVersion' => '

The version of the output schema to use when exporting data. Must be V_1.

', ], ], 'Suffix' => [ 'base' => NULL, 'refs' => [ 'IndexDocument$Suffix' => '

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.

Replacement must be made for object keys containing special characters (such as carriage returns) when using XML requests. For more information, see XML related object key constraints.

', ], ], 'Tag' => [ 'base' => '

A container of a key value name pair.

', 'refs' => [ 'AnalyticsFilter$Tag' => '

The tag to use when evaluating an analytics filter.

', 'IntelligentTieringFilter$Tag' => NULL, 'LifecycleRuleFilter$Tag' => '

This tag must exist in the object\'s tag set in order for the rule to apply.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'MetricsFilter$Tag' => '

The tag used when evaluating a metrics filter.

', 'ReplicationRuleFilter$Tag' => '

A container for specifying a tag key and value.

The rule applies only to objects that have the tag in their tag set.

', 'TagSet$member' => NULL, ], ], 'TagCount' => [ 'base' => NULL, 'refs' => [ 'GetObjectOutput$TagCount' => '

The number of tags, if any, on the object, when you have the relevant permission to read object tags.

You can use GetObjectTagging to retrieve the tag set associated with an object.

This functionality is not supported for directory buckets.

', 'WriteGetObjectResponseRequest$TagCount' => '

The number of tags, if any, on the object.

', ], ], 'TagSet' => [ 'base' => NULL, 'refs' => [ 'AnalyticsAndOperator$Tags' => '

The list of tags to use when evaluating an AND predicate.

', 'GetBucketTaggingOutput$TagSet' => '

Contains the tag set.

', 'GetObjectTaggingOutput$TagSet' => '

Contains the tag set.

', 'IntelligentTieringAndOperator$Tags' => '

All of these tags must exist in the object\'s tag set in order for the configuration to apply.

', 'LifecycleRuleAndOperator$Tags' => '

All of these tags must exist in the object\'s tag set in order for the rule to apply.

', 'MetricsAndOperator$Tags' => '

The list of tags used when evaluating an AND predicate.

', 'ReplicationRuleAndOperator$Tags' => '

An array of tags containing key and value pairs.

', 'Tagging$TagSet' => '

A collection for a set of tags

', ], ], 'Tagging' => [ 'base' => '

Container for TagSet elements.

', 'refs' => [ 'PutBucketTaggingRequest$Tagging' => '

Container for the TagSet and Tag elements.

', 'PutObjectTaggingRequest$Tagging' => '

Container for the TagSet and Tag elements

', 'S3Location$Tagging' => '

The tag-set that is applied to the restore results.

', ], ], 'TaggingDirective' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$TaggingDirective' => '

Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that\'s provided in the request.

The default value is COPY.

Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the following situations:

Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the following situations are allowed:

', ], ], 'TaggingHeader' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$Tagging' => '

The tag-set for the object copy in the destination bucket. This value must be used in conjunction with the x-amz-tagging-directive if you choose REPLACE for the x-amz-tagging-directive. If you choose COPY for the x-amz-tagging-directive, you don\'t need to set the x-amz-tagging header, because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query parameters.

The default value is the empty value.

Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented response in any of the following situations:

Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the following situations are allowed:

', 'CreateMultipartUploadRequest$Tagging' => '

The tag-set for the object. The tag-set must be encoded as URL Query parameters.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$Tagging' => '

The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")

This functionality is not supported for directory buckets.

', ], ], 'TargetBucket' => [ 'base' => NULL, 'refs' => [ 'LoggingEnabled$TargetBucket' => '

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.

', ], ], 'TargetGrant' => [ 'base' => '

Container for granting information.

Buckets that use the bucket owner enforced setting for Object Ownership don\'t support target grants. For more information, see Permissions server access log delivery in the Amazon S3 User Guide.

', 'refs' => [ 'TargetGrants$member' => NULL, ], ], 'TargetGrants' => [ 'base' => NULL, 'refs' => [ 'LoggingEnabled$TargetGrants' => '

Container for granting information.

Buckets that use the bucket owner enforced setting for Object Ownership don\'t support target grants. For more information, see Permissions for server access log delivery in the Amazon S3 User Guide.

', ], ], 'TargetObjectKeyFormat' => [ 'base' => '

Amazon S3 key format for log objects. Only one format, PartitionedPrefix or SimplePrefix, is allowed.

', 'refs' => [ 'LoggingEnabled$TargetObjectKeyFormat' => '

Amazon S3 key format for log objects.

', ], ], 'TargetPrefix' => [ 'base' => NULL, 'refs' => [ 'LoggingEnabled$TargetPrefix' => '

A prefix for all log object keys. If you store log files from multiple Amazon S3 buckets in a single bucket, you can use a prefix to distinguish which log files came from which bucket.

', ], ], 'Tier' => [ 'base' => NULL, 'refs' => [ 'GlacierJobParameters$Tier' => '

Retrieval tier at which the restore will be processed.

', 'RestoreRequest$Tier' => '

Retrieval tier at which the restore will be processed.

', ], ], 'Tiering' => [ 'base' => '

The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead.

', 'refs' => [ 'TieringList$member' => NULL, ], ], 'TieringList' => [ 'base' => NULL, 'refs' => [ 'IntelligentTieringConfiguration$Tierings' => '

Specifies the S3 Intelligent-Tiering storage class tier of the configuration.

', ], ], 'Token' => [ 'base' => NULL, 'refs' => [ 'ListBucketAnalyticsConfigurationsOutput$ContinuationToken' => '

The marker that is used as a starting point for this analytics configuration list response. This value is present if it was sent in the request.

', 'ListBucketAnalyticsConfigurationsRequest$ContinuationToken' => '

The ContinuationToken that represents a placeholder from where this request should begin.

', 'ListBucketIntelligentTieringConfigurationsOutput$ContinuationToken' => '

The ContinuationToken that represents a placeholder from where this request should begin.

', 'ListBucketIntelligentTieringConfigurationsRequest$ContinuationToken' => '

The ContinuationToken that represents a placeholder from where this request should begin.

', 'ListBucketInventoryConfigurationsOutput$ContinuationToken' => '

If sent in the request, the marker that is used as a starting point for this inventory configuration list response.

', 'ListBucketInventoryConfigurationsRequest$ContinuationToken' => '

The marker used to continue an inventory configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

', 'ListBucketMetricsConfigurationsOutput$ContinuationToken' => '

The marker that is used as a starting point for this metrics configuration list response. This value is present if it was sent in the request.

', 'ListBucketMetricsConfigurationsRequest$ContinuationToken' => '

The marker that is used to continue a metrics configuration listing that has been truncated. Use the NextContinuationToken from a previously truncated list response to continue the listing. The continuation token is an opaque value that Amazon S3 understands.

', 'ListBucketsRequest$ContinuationToken' => '

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No.

If you specify the bucket-region, prefix, or continuation-token query parameters without using max-buckets to set the maximum number of buckets returned in the response, Amazon S3 applies a default page size of 10,000 and provides a continuation token if there are more buckets.

', 'ListObjectsV2Output$ContinuationToken' => '

If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response. You can use this ContinuationToken for pagination of the list results.

', 'ListObjectsV2Request$ContinuationToken' => '

ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.

', ], ], 'TooManyParts' => [ 'base' => '

You have attempted to add more parts than the maximum of 10000 that are allowed for this object. You can use the CopyObject operation to copy this object to another and then add more data to the newly copied object.

', 'refs' => [], ], 'TopicArn' => [ 'base' => NULL, 'refs' => [ 'TopicConfiguration$TopicArn' => '

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Amazon S3 publishes a message when it detects events of the specified type.

', 'TopicConfigurationDeprecated$Topic' => '

Amazon SNS topic to which Amazon S3 will publish a message to report the specified events for the bucket.

', ], ], 'TopicConfiguration' => [ 'base' => '

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.

', 'refs' => [ 'TopicConfigurationList$member' => NULL, ], ], 'TopicConfigurationDeprecated' => [ 'base' => '

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.

', 'refs' => [ 'NotificationConfigurationDeprecated$TopicConfiguration' => '

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.

', ], ], 'TopicConfigurationList' => [ 'base' => NULL, 'refs' => [ 'NotificationConfiguration$TopicConfigurations' => '

The topic to which notifications are sent and the events for which notifications are generated.

', ], ], 'Transition' => [ 'base' => '

Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.

', 'refs' => [ 'Rule$Transition' => '

Specifies when an object transitions to a specified storage class. For more information about Amazon S3 lifecycle configuration rules, see Transitioning Objects Using Amazon S3 Lifecycle in the Amazon S3 User Guide.

', 'TransitionList$member' => NULL, ], ], 'TransitionDefaultMinimumObjectSize' => [ 'base' => NULL, 'refs' => [ 'GetBucketLifecycleConfigurationOutput$TransitionDefaultMinimumObjectSize' => '

Indicates which default minimum object size behavior is applied to the lifecycle configuration.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

', 'PutBucketLifecycleConfigurationOutput$TransitionDefaultMinimumObjectSize' => '

Indicates which default minimum object size behavior is applied to the lifecycle configuration.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

', 'PutBucketLifecycleConfigurationRequest$TransitionDefaultMinimumObjectSize' => '

Indicates which default minimum object size behavior is applied to the lifecycle configuration.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

To customize the minimum object size for any transition you can add a filter that specifies a custom ObjectSizeGreaterThan or ObjectSizeLessThan in the body of your transition rule. Custom filters always take precedence over the default transition behavior.

', ], ], 'TransitionList' => [ 'base' => NULL, 'refs' => [ 'LifecycleRule$Transitions' => '

Specifies when an Amazon S3 object transitions to a specified storage class.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', ], ], 'TransitionStorageClass' => [ 'base' => NULL, 'refs' => [ 'NoncurrentVersionTransition$StorageClass' => '

The class of storage used to store the object.

', 'Transition$StorageClass' => '

The storage class to which you want the object to transition.

', ], ], 'Type' => [ 'base' => NULL, 'refs' => [ 'Grantee$Type' => '

Type of grantee

', ], ], 'URI' => [ 'base' => NULL, 'refs' => [ 'Grantee$URI' => '

URI of the grantee group.

', ], ], 'UploadIdMarker' => [ 'base' => NULL, 'refs' => [ 'ListMultipartUploadsOutput$UploadIdMarker' => '

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.

This functionality is not supported for directory buckets.

', 'ListMultipartUploadsRequest$UploadIdMarker' => '

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.

This functionality is not supported for directory buckets.

', ], ], 'UploadPartCopyOutput' => [ 'base' => NULL, 'refs' => [], ], 'UploadPartCopyRequest' => [ 'base' => NULL, 'refs' => [], ], 'UploadPartOutput' => [ 'base' => NULL, 'refs' => [], ], 'UploadPartRequest' => [ 'base' => NULL, 'refs' => [], ], 'UserMetadata' => [ 'base' => NULL, 'refs' => [ 'S3Location$UserMetadata' => '

A list of metadata to store with the restore results in S3.

', ], ], 'Value' => [ 'base' => NULL, 'refs' => [ 'Tag$Value' => '

Value of the tag.

', ], ], 'VersionCount' => [ 'base' => NULL, 'refs' => [ 'NoncurrentVersionExpiration$NewerNoncurrentVersions' => '

Specifies how many noncurrent versions Amazon S3 will retain. You can specify up to 100 noncurrent versions to retain. Amazon S3 will permanently delete any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.

This parameter applies to general purpose buckets only. It is not supported for directory bucket lifecycle configurations.

', 'NoncurrentVersionTransition$NewerNoncurrentVersions' => '

Specifies how many noncurrent versions Amazon S3 will retain in the same storage class before transitioning objects. You can specify up to 100 noncurrent versions to retain. Amazon S3 will transition any additional noncurrent versions beyond the specified number to retain. For more information about noncurrent versions, see Lifecycle configuration elements in the Amazon S3 User Guide.

', ], ], 'VersionIdMarker' => [ 'base' => NULL, 'refs' => [ 'ListObjectVersionsOutput$VersionIdMarker' => '

Marks the last version of the key returned in a truncated response.

', 'ListObjectVersionsRequest$VersionIdMarker' => '

Specifies the object version you want to start listing from.

', ], ], 'VersioningConfiguration' => [ 'base' => '

Describes the versioning state of an Amazon S3 bucket. For more information, see PUT Bucket versioning in the Amazon S3 API Reference.

', 'refs' => [ 'PutBucketVersioningRequest$VersioningConfiguration' => '

Container for setting the versioning state.

', ], ], 'WebsiteConfiguration' => [ 'base' => '

Specifies website configuration parameters for an Amazon S3 bucket.

', 'refs' => [ 'PutBucketWebsiteRequest$WebsiteConfiguration' => '

Container for the request.

', ], ], 'WebsiteRedirectLocation' => [ 'base' => NULL, 'refs' => [ 'CopyObjectRequest$WebsiteRedirectLocation' => '

If the destination bucket is configured as a website, redirects requests for this object copy to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the x-amz-metadata-directive header. Instead, you may opt to provide this header in combination with the x-amz-metadata-directive header.

This functionality is not supported for directory buckets.

', 'CreateMultipartUploadRequest$WebsiteRedirectLocation' => '

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.

This functionality is not supported for directory buckets.

', 'GetObjectOutput$WebsiteRedirectLocation' => '

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.

This functionality is not supported for directory buckets.

', 'HeadObjectOutput$WebsiteRedirectLocation' => '

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.

This functionality is not supported for directory buckets.

', 'PutObjectRequest$WebsiteRedirectLocation' => '

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 Amazon S3 User Guide.

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 in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

', ], ], 'WriteGetObjectResponseRequest' => [ 'base' => NULL, 'refs' => [], ], 'WriteOffsetBytes' => [ 'base' => NULL, 'refs' => [ 'PutObjectRequest$WriteOffsetBytes' => '

Specifies the offset for appending data to existing objects in bytes. The offset must be equal to the size of the existing object being appended to. If no object exists, setting this header to 0 will create a new object.

This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.

', ], ], 'Years' => [ 'base' => NULL, 'refs' => [ 'DefaultRetention$Years' => '

The number of years that you want to specify for the default retention period. Must be used with Mode.

', ], ], ],]; diff --git a/src/data/s3/2006-03-01/examples-1.json b/src/data/s3/2006-03-01/examples-1.json index f0570ca8c1..53cd63a467 100644 --- a/src/data/s3/2006-03-01/examples-1.json +++ b/src/data/s3/2006-03-01/examples-1.json @@ -257,10 +257,8 @@ "DeleteObject": [ { "input": { - "Bucket": "examplebucket", - "Key": "objectkey.jpg" - }, - "output": { + "Bucket": "ExampleBucket", + "Key": "HappyFace.jpg" }, "comments": { "input": { @@ -268,14 +266,16 @@ "output": { } }, - "description": "The following example deletes an object from an S3 bucket.", - "id": "to-delete-an-object-1472850136595", - "title": "To delete an object" + "description": "The following example deletes an object from a non-versioned bucket.", + "id": "to-delete-an-object-from-a-non-versioned-bucket-1481588533089", + "title": "To delete an object (from a non-versioned bucket)" }, { "input": { - "Bucket": "ExampleBucket", - "Key": "HappyFace.jpg" + "Bucket": "examplebucket", + "Key": "objectkey.jpg" + }, + "output": { }, "comments": { "input": { @@ -283,9 +283,9 @@ "output": { } }, - "description": "The following example deletes an object from a non-versioned bucket.", - "id": "to-delete-an-object-from-a-non-versioned-bucket-1481588533089", - "title": "To delete an object (from a non-versioned bucket)" + "description": "The following example deletes an object from an S3 bucket.", + "id": "to-delete-an-object-1472850136595", + "title": "To delete an object" } ], "DeleteObjectTagging": [ @@ -728,18 +728,17 @@ { "input": { "Bucket": "examplebucket", - "Key": "SampleFile.txt", - "Range": "bytes=0-9" + "Key": "HappyFace.jpg" }, "output": { "AcceptRanges": "bytes", - "ContentLength": "10", - "ContentRange": "bytes 0-9/43", - "ContentType": "text/plain", - "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"", - "LastModified": "2014-10-09T22:57:28.000Z", + "ContentLength": "3191", + "ContentType": "image/jpeg", + "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", + "LastModified": "2016-12-15T01:19:41.000Z", "Metadata": { }, + "TagCount": 2, "VersionId": "null" }, "comments": { @@ -748,24 +747,25 @@ "output": { } }, - "description": "The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.", - "id": "to-retrieve-a-byte-range-of-an-object--1481832674603", - "title": "To retrieve a byte range of an object " + "description": "The following example retrieves an object for an S3 bucket.", + "id": "to-retrieve-an-object-1481827837012", + "title": "To retrieve an object" }, { "input": { "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "SampleFile.txt", + "Range": "bytes=0-9" }, "output": { "AcceptRanges": "bytes", - "ContentLength": "3191", - "ContentType": "image/jpeg", - "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "LastModified": "2016-12-15T01:19:41.000Z", + "ContentLength": "10", + "ContentRange": "bytes 0-9/43", + "ContentType": "text/plain", + "ETag": "\"0d94420ffd0bc68cd3d152506b97a9cc\"", + "LastModified": "2014-10-09T22:57:28.000Z", "Metadata": { }, - "TagCount": 2, "VersionId": "null" }, "comments": { @@ -774,9 +774,9 @@ "output": { } }, - "description": "The following example retrieves an object for an S3 bucket.", - "id": "to-retrieve-an-object-1481827837012", - "title": "To retrieve an object" + "description": "The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.", + "id": "to-retrieve-a-byte-range-of-an-object--1481832674603", + "title": "To retrieve a byte range of an object " } ], "GetObjectAcl": [ @@ -840,20 +840,17 @@ { "input": { "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "exampleobject", + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" }, "output": { "TagSet": [ { - "Key": "Key4", - "Value": "Value4" - }, - { - "Key": "Key3", - "Value": "Value3" + "Key": "Key1", + "Value": "Value1" } ], - "VersionId": "null" + "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" }, "comments": { "input": { @@ -861,24 +858,27 @@ "output": { } }, - "description": "The following example retrieves tag set of an object.", - "id": "to-retrieve-tag-set-of-an-object-1481833847896", - "title": "To retrieve tag set of an object" + "description": "The following example retrieves tag set of an object. The request specifies object version.", + "id": "to-retrieve-tag-set-of-a-specific-object-version-1483400283663", + "title": "To retrieve tag set of a specific object version" }, { "input": { "Bucket": "examplebucket", - "Key": "exampleobject", - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + "Key": "HappyFace.jpg" }, "output": { "TagSet": [ { - "Key": "Key1", - "Value": "Value1" + "Key": "Key4", + "Value": "Value4" + }, + { + "Key": "Key3", + "Value": "Value3" } ], - "VersionId": "ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI" + "VersionId": "null" }, "comments": { "input": { @@ -886,9 +886,9 @@ "output": { } }, - "description": "The following example retrieves tag set of an object. The request specifies object version.", - "id": "to-retrieve-tag-set-of-a-specific-object-version-1483400283663", - "title": "To retrieve tag set of a specific object version" + "description": "The following example retrieves tag set of an object.", + "id": "to-retrieve-tag-set-of-an-object-1481833847896", + "title": "To retrieve tag set of an object" } ], "GetObjectTorrent": [ @@ -1567,14 +1567,16 @@ "PutObject": [ { "input": { - "Body": "c:\\HappyFace.jpg", + "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "HappyFace.jpg", + "Key": "exampleobject", + "ServerSideEncryption": "AES256", "Tagging": "key1=value1&key2=value2" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a" + "ServerSideEncryption": "AES256", + "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt" }, "comments": { "input": { @@ -1582,20 +1584,19 @@ "output": { } }, - "description": "The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.", - "id": "to-upload-an-object-and-specify-optional-tags-1481762310955", - "title": "To upload an object and specify optional tags" + "description": "The following example uploads an 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" }, { "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": { @@ -1603,19 +1604,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", + "Body": "c:\\HappyFace.jpg", "Bucket": "examplebucket", - "Key": "HappyFace.jpg" + "Key": "HappyFace.jpg", + "Tagging": "key1=value1&key2=value2" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "tpf3zF08nBplQK1XLOefGskR7mGDwcDk" + "VersionId": "psM2sYY4.o1501dSx8wMvnkOzSBB.V4a" }, "comments": { "input": { @@ -1623,9 +1625,9 @@ "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 uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.", + "id": "to-upload-an-object-and-specify-optional-tags-1481762310955", + "title": "To upload an object and specify optional tags" }, { "input": { @@ -1653,13 +1655,14 @@ }, { "input": { + "ACL": "authenticated-read", "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "objectkey" + "Key": "exampleobject" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ" + "VersionId": "Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr" }, "comments": { "input": { @@ -1667,9 +1670,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 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": { @@ -1698,14 +1701,11 @@ "input": { "Body": "filetoupload", "Bucket": "examplebucket", - "Key": "exampleobject", - "ServerSideEncryption": "AES256", - "Tagging": "key1=value1&key2=value2" + "Key": "objectkey" }, "output": { "ETag": "\"6805f2cfc46c0f04559748bb039d69ae\"", - "ServerSideEncryption": "AES256", - "VersionId": "Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt" + "VersionId": "Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ" }, "comments": { "input": { @@ -1713,9 +1713,9 @@ "output": { } }, - "description": "The following example uploads an 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. If the bucket is versioning enabled, S3 returns version ID in response.", + "id": "to-create-an-object-1483147613675", + "title": "To create an object." } ], "PutObjectAcl": [ diff --git a/src/data/s3/2006-03-01/examples-1.json.php b/src/data/s3/2006-03-01/examples-1.json.php index 4cb85bb4fd..ac61da16e0 100644 --- a/src/data/s3/2006-03-01/examples-1.json.php +++ b/src/data/s3/2006-03-01/examples-1.json.php @@ -1,3 +1,3 @@ '1.0', 'examples' => [ 'AbortMultipartUpload' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'bigobject', 'UploadId' => 'xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--', ], 'output' => [], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example aborts a multipart upload.', 'id' => 'to-abort-a-multipart-upload-1481853354987', 'title' => 'To abort a multipart upload', ], ], 'CompleteMultipartUpload' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'bigobject', 'MultipartUpload' => [ 'Parts' => [ [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', 'PartNumber' => '1', ], [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', 'PartNumber' => '2', ], ], ], 'UploadId' => '7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--', ], 'output' => [ 'Bucket' => 'acexamplebucket', 'ETag' => '"4d9031c7644d8081c2829f4ea23c55f7-2"', 'Key' => 'bigobject', 'Location' => 'https://examplebucket.s3..amazonaws.com/bigobject', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example completes a multipart upload.', 'id' => 'to-complete-multipart-upload-1481851590483', 'title' => 'To complete multipart upload', ], ], 'CopyObject' => [ [ 'input' => [ 'Bucket' => 'destinationbucket', 'CopySource' => '/sourcebucket/HappyFacejpg', 'Key' => 'HappyFaceCopyjpg', ], 'output' => [ 'CopyObjectResult' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'LastModified' => '2016-12-15T17:38:53.000Z', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example copies an object from one bucket to another.', 'id' => 'to-copy-an-object-1481823186878', 'title' => 'To copy an object', ], ], 'CreateBucket' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'Location' => '/examplebucket', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example creates a bucket.', 'id' => 'to-create-a-bucket--1472851826060', 'title' => 'To create a bucket ', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'CreateBucketConfiguration' => [ 'LocationConstraint' => 'eu-west-1', ], ], 'output' => [ 'Location' => 'http://examplebucket..s3.amazonaws.com/', ], 'comments' => [ 'input' => [], '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', ], ], 'CreateMultipartUpload' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'largeobject', ], 'output' => [ 'Bucket' => 'examplebucket', 'Key' => 'largeobject', 'UploadId' => 'ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example initiates a multipart upload.', 'id' => 'to-initiate-a-multipart-upload-1481836794513', 'title' => 'To initiate a multipart upload', ], ], 'DeleteBucket' => [ [ 'input' => [ 'Bucket' => 'forrandall2', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes the specified bucket.', 'id' => 'to-delete-a-bucket-1473108514262', 'title' => 'To delete a bucket', ], ], 'DeleteBucketCors' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes CORS configuration on a bucket.', 'id' => 'to-delete-cors-configuration-on-a-bucket-1483042856112', 'title' => 'To delete cors configuration on a bucket.', ], ], 'DeleteBucketLifecycle' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes lifecycle configuration on a bucket.', 'id' => 'to-delete-lifecycle-configuration-on-a-bucket-1483043310583', 'title' => 'To delete lifecycle configuration on a bucket.', ], ], 'DeleteBucketPolicy' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes bucket policy on the specified bucket.', 'id' => 'to-delete-bucket-policy-1483043406577', 'title' => 'To delete bucket policy', ], ], 'DeleteBucketReplication' => [ [ 'input' => [ 'Bucket' => 'example', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes replication configuration set on bucket.', 'id' => 'to-delete-bucket-replication-configuration-1483043684668', 'title' => 'To delete bucket replication configuration', ], ], 'DeleteBucketTagging' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes bucket tags.', 'id' => 'to-delete-bucket-tags-1483043846509', 'title' => 'To delete bucket tags', ], ], 'DeleteBucketWebsite' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes bucket website configuration.', 'id' => 'to-delete-bucket-website-configuration-1483043937825', 'title' => 'To delete bucket website configuration', ], ], 'DeleteObject' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'objectkey.jpg', ], 'output' => [], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes an object from an S3 bucket.', 'id' => 'to-delete-an-object-1472850136595', 'title' => 'To delete an object', ], [ 'input' => [ 'Bucket' => 'ExampleBucket', 'Key' => 'HappyFace.jpg', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes an object from a non-versioned bucket.', 'id' => 'to-delete-an-object-from-a-non-versioned-bucket-1481588533089', 'title' => 'To delete an object (from a non-versioned bucket)', ], ], 'DeleteObjectTagging' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [ 'VersionId' => 'null', ], 'comments' => [ 'input' => [], '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', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', 'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI', ], 'output' => [ 'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI', ], 'comments' => [ 'input' => [], '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', ], ], 'DeleteObjects' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Delete' => [ 'Objects' => [ [ 'Key' => 'HappyFace.jpg', 'VersionId' => '2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b', ], [ 'Key' => 'HappyFace.jpg', 'VersionId' => 'yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd', ], ], 'Quiet' => false, ], ], 'output' => [ 'Deleted' => [ [ 'Key' => 'HappyFace.jpg', 'VersionId' => 'yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd', ], [ 'Key' => 'HappyFace.jpg', 'VersionId' => '2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b', ], ], ], 'comments' => [ 'input' => [], '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', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'Delete' => [ 'Objects' => [ [ 'Key' => 'objectkey1', ], [ 'Key' => 'objectkey2', ], ], 'Quiet' => false, ], ], 'output' => [ 'Deleted' => [ [ 'DeleteMarker' => 'true', 'DeleteMarkerVersionId' => 'A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F', 'Key' => 'objectkey1', ], [ 'DeleteMarker' => 'true', 'DeleteMarkerVersionId' => 'iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt', 'Key' => 'objectkey2', ], ], ], 'comments' => [ 'input' => [], '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', ], ], 'GetBucketCors' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'CORSRules' => [ [ 'AllowedHeaders' => [ 'Authorization', ], 'AllowedMethods' => [ 'GET', ], 'AllowedOrigins' => [ '*', ], 'MaxAgeSeconds' => 3000, ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.', 'id' => 'to-get-cors-configuration-set-on-a-bucket-1481596855475', 'title' => 'To get cors configuration set on a bucket', ], ], 'GetBucketLifecycle' => [ [ 'input' => [ 'Bucket' => 'acl1', ], 'output' => [ 'Rules' => [ [ 'Expiration' => [ 'Days' => 1, ], 'ID' => 'delete logs', 'Prefix' => '123/', 'Status' => 'Enabled', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example gets ACL on the specified bucket.', 'id' => 'to-get-a-bucket-acl-1474413606503', 'title' => 'To get a bucket acl', ], ], 'GetBucketLifecycleConfiguration' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'Rules' => [ [ 'ID' => 'Rule for TaxDocs/', 'Prefix' => 'TaxDocs', 'Status' => 'Enabled', 'Transitions' => [ [ 'Days' => 365, 'StorageClass' => 'STANDARD_IA', ], ], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves lifecycle configuration on set on a bucket. ', 'id' => 'to-get-lifecycle-configuration-on-a-bucket-1481666063200', 'title' => 'To get lifecycle configuration on a bucket', ], ], 'GetBucketLocation' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'LocationConstraint' => 'us-west-2', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns bucket location.', 'id' => 'to-get-bucket-location-1481594573609', 'title' => 'To get bucket location', ], ], 'GetBucketNotification' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'QueueConfiguration' => [ 'Event' => 's3:ObjectCreated:Put', 'Events' => [ 's3:ObjectCreated:Put', ], 'Id' => 'MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx', 'Queue' => 'arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue', ], 'TopicConfiguration' => [ 'Event' => 's3:ObjectCreated:Copy', 'Events' => [ 's3:ObjectCreated:Copy', ], 'Id' => 'YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi', 'Topic' => 'arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns notification configuration set on a bucket.', 'id' => 'to-get-notification-configuration-set-on-a-bucket-1481594028667', 'title' => 'To get notification configuration set on a bucket', ], [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'QueueConfiguration' => [ 'Event' => 's3:ObjectCreated:Put', 'Events' => [ 's3:ObjectCreated:Put', ], 'Id' => 'MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx', 'Queue' => 'arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue', ], 'TopicConfiguration' => [ 'Event' => 's3:ObjectCreated:Copy', 'Events' => [ 's3:ObjectCreated:Copy', ], 'Id' => 'YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi', 'Topic' => 'arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns notification configuration set on a bucket.', 'id' => 'to-get-notification-configuration-set-on-a-bucket-1481594028667', 'title' => 'To get notification configuration set on a bucket', ], ], 'GetBucketPolicy' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'Policy' => '{"Version":"2008-10-17","Id":"LogPolicy","Statement":[{"Sid":"Enables the log delivery group to publish logs to your bucket ","Effect":"Allow","Principal":{"AWS":"111122223333"},"Action":["s3:GetBucketAcl","s3:GetObjectAcl","s3:PutObject"],"Resource":["arn:aws:s3:::policytest1/*","arn:aws:s3:::policytest1"]}]}', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns bucket policy associated with a bucket.', 'id' => 'to-get-bucket-policy-1481595098424', 'title' => 'To get bucket policy', ], ], 'GetBucketReplication' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'ReplicationConfiguration' => [ 'Role' => 'arn:aws:iam::acct-id:role/example-role', 'Rules' => [ [ 'Destination' => [ 'Bucket' => 'arn:aws:s3:::destination-bucket', ], 'ID' => 'MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy', 'Prefix' => 'Tax', 'Status' => 'Enabled', ], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns replication configuration set on a bucket.', 'id' => 'to-get-replication-configuration-set-on-a-bucket-1481593597175', 'title' => 'To get replication configuration set on a bucket', ], ], 'GetBucketRequestPayment' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'Payer' => 'BucketOwner', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves bucket versioning configuration.', 'id' => 'to-get-bucket-versioning-configuration-1483037183929', 'title' => 'To get bucket versioning configuration', ], ], 'GetBucketTagging' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'TagSet' => [ [ 'Key' => 'key1', 'Value' => 'value1', ], [ 'Key' => 'key2', 'Value' => 'value2', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns tag set associated with a bucket', 'id' => 'to-get-tag-set-associated-with-a-bucket-1481593232107', 'title' => 'To get tag set associated with a bucket', ], ], 'GetBucketVersioning' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'MFADelete' => 'Disabled', 'Status' => 'Enabled', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves bucket versioning configuration.', 'id' => 'to-get-bucket-versioning-configuration-1483037183929', 'title' => 'To get bucket versioning configuration', ], ], 'GetBucketWebsite' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'ErrorDocument' => [ 'Key' => 'error.html', ], 'IndexDocument' => [ 'Suffix' => 'index.html', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves website configuration of a bucket.', 'id' => 'to-get-bucket-website-configuration-1483037016926', 'title' => 'To get bucket website configuration', ], ], 'GetObject' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'SampleFile.txt', 'Range' => 'bytes=0-9', ], 'output' => [ 'AcceptRanges' => 'bytes', 'ContentLength' => '10', 'ContentRange' => 'bytes 0-9/43', 'ContentType' => 'text/plain', 'ETag' => '"0d94420ffd0bc68cd3d152506b97a9cc"', 'LastModified' => '2014-10-09T22:57:28.000Z', 'Metadata' => [], 'VersionId' => 'null', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.', 'id' => 'to-retrieve-a-byte-range-of-an-object--1481832674603', 'title' => 'To retrieve a byte range of an object ', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [ 'AcceptRanges' => 'bytes', 'ContentLength' => '3191', 'ContentType' => 'image/jpeg', 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'LastModified' => '2016-12-15T01:19:41.000Z', 'Metadata' => [], 'TagCount' => 2, 'VersionId' => 'null', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves an object for an S3 bucket.', 'id' => 'to-retrieve-an-object-1481827837012', 'title' => 'To retrieve an object', ], ], 'GetObjectAcl' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [ 'Grants' => [ [ 'Grantee' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', 'Type' => 'CanonicalUser', ], 'Permission' => 'WRITE', ], [ 'Grantee' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', 'Type' => 'CanonicalUser', ], 'Permission' => 'WRITE_ACP', ], [ 'Grantee' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', 'Type' => 'CanonicalUser', ], 'Permission' => 'READ', ], [ 'Grantee' => [ 'DisplayName' => 'owner-display-name', 'ID' => '852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', 'Type' => 'CanonicalUser', ], 'Permission' => 'READ_ACP', ], ], 'Owner' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves access control list (ACL) of an object.', 'id' => 'to-retrieve-object-acl-1481833557740', 'title' => 'To retrieve object ACL', ], ], 'GetObjectTagging' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [ 'TagSet' => [ [ 'Key' => 'Key4', 'Value' => 'Value4', ], [ 'Key' => 'Key3', 'Value' => 'Value3', ], ], 'VersionId' => 'null', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves tag set of an object.', 'id' => 'to-retrieve-tag-set-of-an-object-1481833847896', 'title' => 'To retrieve tag set of an object', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'exampleobject', 'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI', ], 'output' => [ 'TagSet' => [ [ 'Key' => 'Key1', 'Value' => 'Value1', ], ], 'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves tag set of an object. The request specifies object version.', 'id' => 'to-retrieve-tag-set-of-a-specific-object-version-1483400283663', 'title' => 'To retrieve tag set of a specific object version', ], ], 'GetObjectTorrent' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves torrent files of an object.', 'id' => 'to-retrieve-torrent-files-for-an-object-1481834115959', 'title' => 'To retrieve torrent files for an object', ], ], 'HeadBucket' => [ [ 'input' => [ 'Bucket' => 'acl1', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation checks to see if a bucket exists.', 'id' => 'to-determine-if-bucket-exists-1473110292262', 'title' => 'To determine if bucket exists', ], ], 'HeadObject' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [ 'AcceptRanges' => 'bytes', 'ContentLength' => '3191', 'ContentType' => 'image/jpeg', 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'LastModified' => '2016-12-15T01:19:41.000Z', 'Metadata' => [], 'VersionId' => 'null', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves an object metadata.', 'id' => 'to-retrieve-metadata-of-an-object-without-returning-the-object-itself-1481834820480', 'title' => 'To retrieve metadata of an object without returning the object itself', ], ], 'ListBuckets' => [ [ 'output' => [ 'Buckets' => [ [ 'CreationDate' => '2012-02-15T21:03:02.000Z', 'Name' => 'examplebucket', ], [ 'CreationDate' => '2011-07-24T19:33:50.000Z', 'Name' => 'examplebucket2', ], [ 'CreationDate' => '2010-12-17T00:56:49.000Z', 'Name' => 'examplebucket3', ], ], 'Owner' => [ 'DisplayName' => 'own-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns all the buckets owned by the sender of this request.', 'id' => 'to-list-buckets-1481910996058', 'title' => 'To list all buckets', ], ], 'ListMultipartUploads' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'Uploads' => [ [ 'Initiated' => '2014-05-01T05:40:58.000Z', 'Initiator' => [ 'DisplayName' => 'display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Key' => 'JavaFile', 'Owner' => [ 'DisplayName' => 'display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'StorageClass' => 'STANDARD', 'UploadId' => 'examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--', ], [ 'Initiated' => '2014-05-01T05:41:27.000Z', 'Initiator' => [ 'DisplayName' => 'display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Key' => 'JavaFile', 'Owner' => [ 'DisplayName' => 'display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'StorageClass' => 'STANDARD', 'UploadId' => 'examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example lists in-progress multipart uploads on a specific bucket.', 'id' => 'to-list-in-progress-multipart-uploads-on-a-bucket-1481852775260', 'title' => 'To list in-progress multipart uploads on a bucket', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'KeyMarker' => 'nextkeyfrompreviousresponse', 'MaxUploads' => '2', 'UploadIdMarker' => 'valuefrompreviousresponse', ], 'output' => [ 'Bucket' => 'acl1', 'IsTruncated' => true, 'KeyMarker' => '', 'MaxUploads' => '2', 'NextKeyMarker' => 'someobjectkey', 'NextUploadIdMarker' => 'examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--', 'UploadIdMarker' => '', 'Uploads' => [ [ 'Initiated' => '2014-05-01T05:40:58.000Z', 'Initiator' => [ 'DisplayName' => 'ownder-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Key' => 'JavaFile', 'Owner' => [ 'DisplayName' => 'mohanataws', 'ID' => '852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'StorageClass' => 'STANDARD', 'UploadId' => 'gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--', ], [ 'Initiated' => '2014-05-01T05:41:27.000Z', 'Initiator' => [ 'DisplayName' => 'ownder-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Key' => 'JavaFile', 'Owner' => [ 'DisplayName' => 'ownder-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'StorageClass' => 'STANDARD', 'UploadId' => 'b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads.', 'id' => 'list-next-set-of-multipart-uploads-when-previous-result-is-truncated-1482428106748', 'title' => 'List next set of multipart uploads when previous result is truncated', ], ], 'ListObjectVersions' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Prefix' => 'HappyFace.jpg', ], 'output' => [ 'Versions' => [ [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'IsLatest' => true, 'Key' => 'HappyFace.jpg', 'LastModified' => '2016-12-15T01:19:41.000Z', 'Owner' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Size' => 3191, 'StorageClass' => 'STANDARD', 'VersionId' => 'null', ], [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'IsLatest' => false, 'Key' => 'HappyFace.jpg', 'LastModified' => '2016-12-13T00:58:26.000Z', 'Owner' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Size' => 3191, 'StorageClass' => 'STANDARD', 'VersionId' => 'PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns versions of an object with specific key name prefix.', 'id' => 'to-list-object-versions-1481910996058', 'title' => 'To list object versions', ], ], 'ListObjects' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'MaxKeys' => '2', ], 'output' => [ 'Contents' => [ [ 'ETag' => '"70ee1738b6b21e2c8a43f3a5ab0eee71"', 'Key' => 'example1.jpg', 'LastModified' => '2014-11-21T19:40:05.000Z', 'Owner' => [ 'DisplayName' => 'myname', 'ID' => '12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Size' => 11, 'StorageClass' => 'STANDARD', ], [ 'ETag' => '"9c8af9a76df052144598c115ef33e511"', 'Key' => 'example2.jpg', 'LastModified' => '2013-11-15T01:10:49.000Z', 'Owner' => [ 'DisplayName' => 'myname', 'ID' => '12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Size' => 713193, 'StorageClass' => 'STANDARD', ], ], 'NextMarker' => 'eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example list two objects in a bucket.', 'id' => 'to-list-objects-in-a-bucket-1473447646507', 'title' => 'To list objects in a bucket', ], ], 'ListObjectsV2' => [ [ 'input' => [ 'Bucket' => 'DOC-EXAMPLE-BUCKET', 'MaxKeys' => '2', ], 'output' => [ 'Contents' => [ [ 'ETag' => '"70ee1738b6b21e2c8a43f3a5ab0eee71"', 'Key' => 'happyface.jpg', 'LastModified' => '2014-11-21T19:40:05.000Z', 'Size' => 11, 'StorageClass' => 'STANDARD', ], [ 'ETag' => '"becf17f89c30367a9a44495d62ed521a-1"', 'Key' => 'test.jpg', 'LastModified' => '2014-05-02T04:51:50.000Z', 'Size' => 4192256, 'StorageClass' => 'STANDARD', ], ], 'IsTruncated' => true, 'KeyCount' => '2', 'MaxKeys' => '2', 'Name' => 'DOC-EXAMPLE-BUCKET', 'NextContinuationToken' => '1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==', 'Prefix' => '', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys. ', 'id' => 'to-get-object-list', 'title' => 'To get object list', ], ], 'ListParts' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'bigobject', 'UploadId' => 'example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--', ], 'output' => [ 'Initiator' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Owner' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Parts' => [ [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', 'LastModified' => '2016-12-16T00:11:42.000Z', 'PartNumber' => '1', 'Size' => 26246026, ], [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', 'LastModified' => '2016-12-16T00:15:01.000Z', 'PartNumber' => '2', 'Size' => 26246026, ], ], 'StorageClass' => 'STANDARD', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example lists parts uploaded for a specific multipart upload.', 'id' => 'to-list-parts-of-a-multipart-upload-1481852006923', 'title' => 'To list parts of a multipart upload.', ], ], 'PutBucketAcl' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'GrantFullControl' => 'id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484', 'GrantWrite' => 'uri=http://acs.amazonaws.com/groups/s3/LogDelivery', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID) and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in your request. To incrementally add or remove ACL grants, you might use the console.', 'id' => 'put-bucket-acl-1482260397033', 'title' => 'Put bucket acl', ], ], 'PutBucketCors' => [ [ 'input' => [ 'Bucket' => '', 'CORSConfiguration' => [ 'CORSRules' => [ [ 'AllowedHeaders' => [ '*', ], 'AllowedMethods' => [ 'PUT', 'POST', 'DELETE', ], 'AllowedOrigins' => [ 'http://www.example.com', ], 'ExposeHeaders' => [ 'x-amz-server-side-encryption', ], 'MaxAgeSeconds' => 3000, ], [ 'AllowedHeaders' => [ 'Authorization', ], 'AllowedMethods' => [ 'GET', ], 'AllowedOrigins' => [ '*', ], 'MaxAgeSeconds' => 3000, ], ], ], 'ContentMD5' => '', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain.', 'id' => 'to-set-cors-configuration-on-a-bucket-1483037818805', 'title' => 'To set cors configuration on a bucket.', ], ], 'PutBucketLifecycleConfiguration' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'LifecycleConfiguration' => [ 'Rules' => [ [ 'Expiration' => [ 'Days' => 3650, ], 'Filter' => [ 'Prefix' => 'documents/', ], 'ID' => 'TestOnly', 'Status' => 'Enabled', 'Transitions' => [ [ 'Days' => 365, 'StorageClass' => 'GLACIER', ], ], ], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example replaces existing lifecycle configuration, if any, on the specified bucket. ', 'id' => 'put-bucket-lifecycle-1482264533092', 'title' => 'Put bucket lifecycle', ], ], 'PutBucketLogging' => [ [ 'input' => [ 'Bucket' => 'sourcebucket', 'BucketLoggingStatus' => [ 'LoggingEnabled' => [ 'TargetBucket' => 'targetbucket', 'TargetGrants' => [ [ 'Grantee' => [ 'Type' => 'Group', 'URI' => 'http://acs.amazonaws.com/groups/global/AllUsers', ], 'Permission' => 'READ', ], ], 'TargetPrefix' => 'MyBucketLogs/', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants.', 'id' => 'set-logging-configuration-for-a-bucket-1482269119909', 'title' => 'Set logging configuration for a bucket', ], ], 'PutBucketNotificationConfiguration' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'NotificationConfiguration' => [ 'TopicConfigurations' => [ [ 'Events' => [ 's3:ObjectCreated:*', ], 'TopicArn' => 'arn:aws:sns:us-west-2:123456789012:s3-notification-topic', ], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.', 'id' => 'set-notification-configuration-for-a-bucket-1482270296426', 'title' => 'Set notification configuration for a bucket', ], ], 'PutBucketPolicy' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Policy' => '{"Version": "2012-10-17", "Statement": [{ "Sid": "id-1","Effect": "Allow","Principal": {"AWS": "arn:aws:iam::123456789012:root"}, "Action": [ "s3:PutObject","s3:PutObjectAcl"], "Resource": ["arn:aws:s3:::acl3/*" ] } ]}', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets a permission policy on a bucket.', 'id' => 'set-bucket-policy-1482448903302', 'title' => 'Set bucket policy', ], ], 'PutBucketReplication' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'ReplicationConfiguration' => [ 'Role' => 'arn:aws:iam::123456789012:role/examplerole', 'Rules' => [ [ 'Destination' => [ 'Bucket' => 'arn:aws:s3:::destinationbucket', 'StorageClass' => 'STANDARD', ], 'Prefix' => '', 'Status' => 'Enabled', ], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets replication configuration on a bucket.', 'id' => 'id-1', 'title' => 'Set replication configuration on a bucket', ], ], 'PutBucketRequestPayment' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'RequestPaymentConfiguration' => [ 'Payer' => 'Requester', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets request payment configuration on a bucket so that person requesting the download is charged.', 'id' => 'set-request-payment-configuration-on-a-bucket-1482343596680', 'title' => 'Set request payment configuration on a bucket.', ], ], 'PutBucketTagging' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Tagging' => [ 'TagSet' => [ [ 'Key' => 'Key1', 'Value' => 'Value1', ], [ 'Key' => 'Key2', 'Value' => 'Value2', ], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets tags on a bucket. Any existing tags are replaced.', 'id' => 'set-tags-on-a-bucket-1482346269066', 'title' => 'Set tags on a bucket', ], ], 'PutBucketVersioning' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'VersioningConfiguration' => [ 'MFADelete' => 'Disabled', 'Status' => 'Enabled', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket.', 'id' => 'set-versioning-configuration-on-a-bucket-1482344186279', 'title' => 'Set versioning configuration on a bucket', ], ], 'PutBucketWebsite' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'ContentMD5' => '', 'WebsiteConfiguration' => [ 'ErrorDocument' => [ 'Key' => 'error.html', ], 'IndexDocument' => [ 'Suffix' => 'index.html', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example adds website configuration to a bucket.', 'id' => 'set-website-configuration-on-a-bucket-1482346836261', 'title' => 'Set website configuration on a bucket', ], ], 'PutObject' => [ [ 'input' => [ 'Body' => 'c:\\HappyFace.jpg', 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', 'Tagging' => 'key1=value1&key2=value2', ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'VersionId' => 'psM2sYY4.o1501dSx8wMvnkOzSBB.V4a', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.', 'id' => 'to-upload-an-object-and-specify-optional-tags-1481762310955', 'title' => 'To upload an object and specify optional tags', ], [ 'input' => [ 'ACL' => 'authenticated-read', 'Body' => 'filetoupload', 'Bucket' => 'examplebucket', 'Key' => 'exampleobject', ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'VersionId' => 'Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr', ], 'comments' => [ 'input' => [], '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.', ], [ 'input' => [ 'Body' => 'HappyFace.jpg', 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'VersionId' => 'tpf3zF08nBplQK1XLOefGskR7mGDwcDk', ], 'comments' => [ 'input' => [], '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', ], [ 'input' => [ 'Body' => 'filetoupload', 'Bucket' => 'examplebucket', 'Key' => 'exampleobject', 'Metadata' => [ 'metadata1' => 'value1', 'metadata2' => 'value2', ], ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'VersionId' => 'pSKidl4pHBiNwukdbcPXAIs.sshFFOc0', ], 'comments' => [ 'input' => [], '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', ], [ 'input' => [ 'Body' => 'filetoupload', 'Bucket' => 'examplebucket', 'Key' => 'objectkey', ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'VersionId' => 'Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ', ], 'comments' => [ 'input' => [], '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.', ], [ 'input' => [ 'Body' => 'HappyFace.jpg', 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', 'ServerSideEncryption' => 'AES256', 'StorageClass' => 'STANDARD_IA', ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'ServerSideEncryption' => 'AES256', 'VersionId' => 'CG612hodqujkf8FaaNfp8U..FIhLROcp', ], 'comments' => [ 'input' => [], '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)', ], [ 'input' => [ 'Body' => 'filetoupload', 'Bucket' => 'examplebucket', 'Key' => 'exampleobject', 'ServerSideEncryption' => 'AES256', 'Tagging' => 'key1=value1&key2=value2', ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'ServerSideEncryption' => 'AES256', 'VersionId' => 'Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example uploads an 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' => [ [ 'input' => [ 'AccessControlPolicy' => [], 'Bucket' => 'examplebucket', 'GrantFullControl' => 'emailaddress=user1@example.com,emailaddress=user2@example.com', 'GrantRead' => 'uri=http://acs.amazonaws.com/groups/global/AllUsers', 'Key' => 'HappyFace.jpg', ], 'output' => [], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example adds grants to an object ACL. The first permission grants user1 and user2 FULL_CONTROL and the AllUsers group READ permission.', 'id' => 'to-grant-permissions-using-object-acl-1481835549285', 'title' => 'To grant permissions using object ACL', ], ], 'PutObjectTagging' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', 'Tagging' => [ 'TagSet' => [ [ 'Key' => 'Key3', 'Value' => 'Value3', ], [ 'Key' => 'Key4', 'Value' => 'Value4', ], ], ], ], 'output' => [ 'VersionId' => 'null', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example adds tags to an existing object.', 'id' => 'to-add-tags-to-an-existing-object-1481764668793', 'title' => 'To add tags to an existing object', ], ], 'RestoreObject' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'archivedobjectkey', 'RestoreRequest' => [ 'Days' => 1, 'GlacierJobParameters' => [ 'Tier' => 'Expedited', ], ], ], 'output' => [], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example restores for one day an archived copy of an object back into Amazon S3 bucket.', 'id' => 'to-restore-an-archived-object-1483049329953', 'title' => 'To restore an archived object', ], ], 'UploadPart' => [ [ 'input' => [ 'Body' => 'fileToUpload', 'Bucket' => 'examplebucket', 'Key' => 'examplelargeobject', 'PartNumber' => '1', 'UploadId' => 'xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--', ], 'output' => [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example uploads part 1 of a multipart upload. The example specifies a file name for the part data. The Upload ID is same that is returned by the initiate multipart upload.', 'id' => 'to-upload-a-part-1481847914943', 'title' => 'To upload a part', ], ], 'UploadPartCopy' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'CopySource' => '/bucketname/sourceobjectkey', 'Key' => 'examplelargeobject', 'PartNumber' => '1', 'UploadId' => 'exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--', ], 'output' => [ 'CopyPartResult' => [ 'ETag' => '"b0c6f0e7e054ab8fa2536a2677f8734d"', 'LastModified' => '2016-12-29T21:24:43.000Z', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example uploads a part of a multipart upload by copying data from an existing object as data source.', 'id' => 'to-upload-a-part-by-copying-data-from-an-existing-object-as-data-source-1483046746348', 'title' => 'To upload a part by copying data from an existing object as data source', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'CopySource' => '/bucketname/sourceobjectkey', 'CopySourceRange' => 'bytes=1-100000', 'Key' => 'examplelargeobject', 'PartNumber' => '2', 'UploadId' => 'exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--', ], 'output' => [ 'CopyPartResult' => [ 'ETag' => '"65d16d19e65a7508a51f043180edcc36"', 'LastModified' => '2016-12-29T21:44:28.000Z', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.', 'id' => 'to-upload-a-part-by-copying-byte-range-from-an-existing-object-as-data-source-1483048068594', 'title' => 'To upload a part by copying byte range from an existing object as data source', ], ], ],]; +return [ 'version' => '1.0', 'examples' => [ 'AbortMultipartUpload' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'bigobject', 'UploadId' => 'xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--', ], 'output' => [], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example aborts a multipart upload.', 'id' => 'to-abort-a-multipart-upload-1481853354987', 'title' => 'To abort a multipart upload', ], ], 'CompleteMultipartUpload' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'bigobject', 'MultipartUpload' => [ 'Parts' => [ [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', 'PartNumber' => '1', ], [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', 'PartNumber' => '2', ], ], ], 'UploadId' => '7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--', ], 'output' => [ 'Bucket' => 'acexamplebucket', 'ETag' => '"4d9031c7644d8081c2829f4ea23c55f7-2"', 'Key' => 'bigobject', 'Location' => 'https://examplebucket.s3..amazonaws.com/bigobject', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example completes a multipart upload.', 'id' => 'to-complete-multipart-upload-1481851590483', 'title' => 'To complete multipart upload', ], ], 'CopyObject' => [ [ 'input' => [ 'Bucket' => 'destinationbucket', 'CopySource' => '/sourcebucket/HappyFacejpg', 'Key' => 'HappyFaceCopyjpg', ], 'output' => [ 'CopyObjectResult' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'LastModified' => '2016-12-15T17:38:53.000Z', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example copies an object from one bucket to another.', 'id' => 'to-copy-an-object-1481823186878', 'title' => 'To copy an object', ], ], 'CreateBucket' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'Location' => '/examplebucket', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example creates a bucket.', 'id' => 'to-create-a-bucket--1472851826060', 'title' => 'To create a bucket ', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'CreateBucketConfiguration' => [ 'LocationConstraint' => 'eu-west-1', ], ], 'output' => [ 'Location' => 'http://examplebucket..s3.amazonaws.com/', ], 'comments' => [ 'input' => [], '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', ], ], 'CreateMultipartUpload' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'largeobject', ], 'output' => [ 'Bucket' => 'examplebucket', 'Key' => 'largeobject', 'UploadId' => 'ibZBv_75gd9r8lH_gqXatLdxMVpAlj6ZQjEs.OwyF3953YdwbcQnMA2BLGn8Lx12fQNICtMw5KyteFeHw.Sjng--', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example initiates a multipart upload.', 'id' => 'to-initiate-a-multipart-upload-1481836794513', 'title' => 'To initiate a multipart upload', ], ], 'DeleteBucket' => [ [ 'input' => [ 'Bucket' => 'forrandall2', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes the specified bucket.', 'id' => 'to-delete-a-bucket-1473108514262', 'title' => 'To delete a bucket', ], ], 'DeleteBucketCors' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes CORS configuration on a bucket.', 'id' => 'to-delete-cors-configuration-on-a-bucket-1483042856112', 'title' => 'To delete cors configuration on a bucket.', ], ], 'DeleteBucketLifecycle' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes lifecycle configuration on a bucket.', 'id' => 'to-delete-lifecycle-configuration-on-a-bucket-1483043310583', 'title' => 'To delete lifecycle configuration on a bucket.', ], ], 'DeleteBucketPolicy' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes bucket policy on the specified bucket.', 'id' => 'to-delete-bucket-policy-1483043406577', 'title' => 'To delete bucket policy', ], ], 'DeleteBucketReplication' => [ [ 'input' => [ 'Bucket' => 'example', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes replication configuration set on bucket.', 'id' => 'to-delete-bucket-replication-configuration-1483043684668', 'title' => 'To delete bucket replication configuration', ], ], 'DeleteBucketTagging' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes bucket tags.', 'id' => 'to-delete-bucket-tags-1483043846509', 'title' => 'To delete bucket tags', ], ], 'DeleteBucketWebsite' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes bucket website configuration.', 'id' => 'to-delete-bucket-website-configuration-1483043937825', 'title' => 'To delete bucket website configuration', ], ], 'DeleteObject' => [ [ 'input' => [ 'Bucket' => 'ExampleBucket', 'Key' => 'HappyFace.jpg', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes an object from a non-versioned bucket.', 'id' => 'to-delete-an-object-from-a-non-versioned-bucket-1481588533089', 'title' => 'To delete an object (from a non-versioned bucket)', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'objectkey.jpg', ], 'output' => [], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example deletes an object from an S3 bucket.', 'id' => 'to-delete-an-object-1472850136595', 'title' => 'To delete an object', ], ], 'DeleteObjectTagging' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [ 'VersionId' => 'null', ], 'comments' => [ 'input' => [], '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', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', 'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI', ], 'output' => [ 'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI', ], 'comments' => [ 'input' => [], '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', ], ], 'DeleteObjects' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Delete' => [ 'Objects' => [ [ 'Key' => 'HappyFace.jpg', 'VersionId' => '2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b', ], [ 'Key' => 'HappyFace.jpg', 'VersionId' => 'yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd', ], ], 'Quiet' => false, ], ], 'output' => [ 'Deleted' => [ [ 'Key' => 'HappyFace.jpg', 'VersionId' => 'yoz3HB.ZhCS_tKVEmIOr7qYyyAaZSKVd', ], [ 'Key' => 'HappyFace.jpg', 'VersionId' => '2LWg7lQLnY41.maGB5Z6SWW.dcq0vx7b', ], ], ], 'comments' => [ 'input' => [], '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', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'Delete' => [ 'Objects' => [ [ 'Key' => 'objectkey1', ], [ 'Key' => 'objectkey2', ], ], 'Quiet' => false, ], ], 'output' => [ 'Deleted' => [ [ 'DeleteMarker' => 'true', 'DeleteMarkerVersionId' => 'A._w1z6EFiCF5uhtQMDal9JDkID9tQ7F', 'Key' => 'objectkey1', ], [ 'DeleteMarker' => 'true', 'DeleteMarkerVersionId' => 'iOd_ORxhkKe_e8G8_oSGxt2PjsCZKlkt', 'Key' => 'objectkey2', ], ], ], 'comments' => [ 'input' => [], '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', ], ], 'GetBucketCors' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'CORSRules' => [ [ 'AllowedHeaders' => [ 'Authorization', ], 'AllowedMethods' => [ 'GET', ], 'AllowedOrigins' => [ '*', ], 'MaxAgeSeconds' => 3000, ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns cross-origin resource sharing (CORS) configuration set on a bucket.', 'id' => 'to-get-cors-configuration-set-on-a-bucket-1481596855475', 'title' => 'To get cors configuration set on a bucket', ], ], 'GetBucketLifecycle' => [ [ 'input' => [ 'Bucket' => 'acl1', ], 'output' => [ 'Rules' => [ [ 'Expiration' => [ 'Days' => 1, ], 'ID' => 'delete logs', 'Prefix' => '123/', 'Status' => 'Enabled', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example gets ACL on the specified bucket.', 'id' => 'to-get-a-bucket-acl-1474413606503', 'title' => 'To get a bucket acl', ], ], 'GetBucketLifecycleConfiguration' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'Rules' => [ [ 'ID' => 'Rule for TaxDocs/', 'Prefix' => 'TaxDocs', 'Status' => 'Enabled', 'Transitions' => [ [ 'Days' => 365, 'StorageClass' => 'STANDARD_IA', ], ], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves lifecycle configuration on set on a bucket. ', 'id' => 'to-get-lifecycle-configuration-on-a-bucket-1481666063200', 'title' => 'To get lifecycle configuration on a bucket', ], ], 'GetBucketLocation' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'LocationConstraint' => 'us-west-2', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns bucket location.', 'id' => 'to-get-bucket-location-1481594573609', 'title' => 'To get bucket location', ], ], 'GetBucketNotification' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'QueueConfiguration' => [ 'Event' => 's3:ObjectCreated:Put', 'Events' => [ 's3:ObjectCreated:Put', ], 'Id' => 'MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx', 'Queue' => 'arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue', ], 'TopicConfiguration' => [ 'Event' => 's3:ObjectCreated:Copy', 'Events' => [ 's3:ObjectCreated:Copy', ], 'Id' => 'YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi', 'Topic' => 'arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns notification configuration set on a bucket.', 'id' => 'to-get-notification-configuration-set-on-a-bucket-1481594028667', 'title' => 'To get notification configuration set on a bucket', ], [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'QueueConfiguration' => [ 'Event' => 's3:ObjectCreated:Put', 'Events' => [ 's3:ObjectCreated:Put', ], 'Id' => 'MDQ2OGQ4NDEtOTBmNi00YTM4LTk0NzYtZDIwN2I3NWQ1NjIx', 'Queue' => 'arn:aws:sqs:us-east-1:acct-id:S3ObjectCreatedEventQueue', ], 'TopicConfiguration' => [ 'Event' => 's3:ObjectCreated:Copy', 'Events' => [ 's3:ObjectCreated:Copy', ], 'Id' => 'YTVkMWEzZGUtNTY1NS00ZmE2LWJjYjktMmRlY2QwODFkNTJi', 'Topic' => 'arn:aws:sns:us-east-1:acct-id:S3ObjectCreatedEventTopic', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns notification configuration set on a bucket.', 'id' => 'to-get-notification-configuration-set-on-a-bucket-1481594028667', 'title' => 'To get notification configuration set on a bucket', ], ], 'GetBucketPolicy' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'Policy' => '{"Version":"2008-10-17","Id":"LogPolicy","Statement":[{"Sid":"Enables the log delivery group to publish logs to your bucket ","Effect":"Allow","Principal":{"AWS":"111122223333"},"Action":["s3:GetBucketAcl","s3:GetObjectAcl","s3:PutObject"],"Resource":["arn:aws:s3:::policytest1/*","arn:aws:s3:::policytest1"]}]}', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns bucket policy associated with a bucket.', 'id' => 'to-get-bucket-policy-1481595098424', 'title' => 'To get bucket policy', ], ], 'GetBucketReplication' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'ReplicationConfiguration' => [ 'Role' => 'arn:aws:iam::acct-id:role/example-role', 'Rules' => [ [ 'Destination' => [ 'Bucket' => 'arn:aws:s3:::destination-bucket', ], 'ID' => 'MWIwNTkwZmItMTE3MS00ZTc3LWJkZDEtNzRmODQwYzc1OTQy', 'Prefix' => 'Tax', 'Status' => 'Enabled', ], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns replication configuration set on a bucket.', 'id' => 'to-get-replication-configuration-set-on-a-bucket-1481593597175', 'title' => 'To get replication configuration set on a bucket', ], ], 'GetBucketRequestPayment' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'Payer' => 'BucketOwner', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves bucket versioning configuration.', 'id' => 'to-get-bucket-versioning-configuration-1483037183929', 'title' => 'To get bucket versioning configuration', ], ], 'GetBucketTagging' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'TagSet' => [ [ 'Key' => 'key1', 'Value' => 'value1', ], [ 'Key' => 'key2', 'Value' => 'value2', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns tag set associated with a bucket', 'id' => 'to-get-tag-set-associated-with-a-bucket-1481593232107', 'title' => 'To get tag set associated with a bucket', ], ], 'GetBucketVersioning' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'MFADelete' => 'Disabled', 'Status' => 'Enabled', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves bucket versioning configuration.', 'id' => 'to-get-bucket-versioning-configuration-1483037183929', 'title' => 'To get bucket versioning configuration', ], ], 'GetBucketWebsite' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'ErrorDocument' => [ 'Key' => 'error.html', ], 'IndexDocument' => [ 'Suffix' => 'index.html', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves website configuration of a bucket.', 'id' => 'to-get-bucket-website-configuration-1483037016926', 'title' => 'To get bucket website configuration', ], ], 'GetObject' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [ 'AcceptRanges' => 'bytes', 'ContentLength' => '3191', 'ContentType' => 'image/jpeg', 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'LastModified' => '2016-12-15T01:19:41.000Z', 'Metadata' => [], 'TagCount' => 2, 'VersionId' => 'null', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves an object for an S3 bucket.', 'id' => 'to-retrieve-an-object-1481827837012', 'title' => 'To retrieve an object', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'SampleFile.txt', 'Range' => 'bytes=0-9', ], 'output' => [ 'AcceptRanges' => 'bytes', 'ContentLength' => '10', 'ContentRange' => 'bytes 0-9/43', 'ContentType' => 'text/plain', 'ETag' => '"0d94420ffd0bc68cd3d152506b97a9cc"', 'LastModified' => '2014-10-09T22:57:28.000Z', 'Metadata' => [], 'VersionId' => 'null', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves an object for an S3 bucket. The request specifies the range header to retrieve a specific byte range.', 'id' => 'to-retrieve-a-byte-range-of-an-object--1481832674603', 'title' => 'To retrieve a byte range of an object ', ], ], 'GetObjectAcl' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [ 'Grants' => [ [ 'Grantee' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', 'Type' => 'CanonicalUser', ], 'Permission' => 'WRITE', ], [ 'Grantee' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', 'Type' => 'CanonicalUser', ], 'Permission' => 'WRITE_ACP', ], [ 'Grantee' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', 'Type' => 'CanonicalUser', ], 'Permission' => 'READ', ], [ 'Grantee' => [ 'DisplayName' => 'owner-display-name', 'ID' => '852b113eexamplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', 'Type' => 'CanonicalUser', ], 'Permission' => 'READ_ACP', ], ], 'Owner' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves access control list (ACL) of an object.', 'id' => 'to-retrieve-object-acl-1481833557740', 'title' => 'To retrieve object ACL', ], ], 'GetObjectTagging' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'exampleobject', 'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI', ], 'output' => [ 'TagSet' => [ [ 'Key' => 'Key1', 'Value' => 'Value1', ], ], 'VersionId' => 'ydlaNkwWm0SfKJR.T1b1fIdPRbldTYRI', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves tag set of an object. The request specifies object version.', 'id' => 'to-retrieve-tag-set-of-a-specific-object-version-1483400283663', 'title' => 'To retrieve tag set of a specific object version', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [ 'TagSet' => [ [ 'Key' => 'Key4', 'Value' => 'Value4', ], [ 'Key' => 'Key3', 'Value' => 'Value3', ], ], 'VersionId' => 'null', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves tag set of an object.', 'id' => 'to-retrieve-tag-set-of-an-object-1481833847896', 'title' => 'To retrieve tag set of an object', ], ], 'GetObjectTorrent' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves torrent files of an object.', 'id' => 'to-retrieve-torrent-files-for-an-object-1481834115959', 'title' => 'To retrieve torrent files for an object', ], ], 'HeadBucket' => [ [ 'input' => [ 'Bucket' => 'acl1', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'This operation checks to see if a bucket exists.', 'id' => 'to-determine-if-bucket-exists-1473110292262', 'title' => 'To determine if bucket exists', ], ], 'HeadObject' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [ 'AcceptRanges' => 'bytes', 'ContentLength' => '3191', 'ContentType' => 'image/jpeg', 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'LastModified' => '2016-12-15T01:19:41.000Z', 'Metadata' => [], 'VersionId' => 'null', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves an object metadata.', 'id' => 'to-retrieve-metadata-of-an-object-without-returning-the-object-itself-1481834820480', 'title' => 'To retrieve metadata of an object without returning the object itself', ], ], 'ListBuckets' => [ [ 'output' => [ 'Buckets' => [ [ 'CreationDate' => '2012-02-15T21:03:02.000Z', 'Name' => 'examplebucket', ], [ 'CreationDate' => '2011-07-24T19:33:50.000Z', 'Name' => 'examplebucket2', ], [ 'CreationDate' => '2010-12-17T00:56:49.000Z', 'Name' => 'examplebucket3', ], ], 'Owner' => [ 'DisplayName' => 'own-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns all the buckets owned by the sender of this request.', 'id' => 'to-list-buckets-1481910996058', 'title' => 'To list all buckets', ], ], 'ListMultipartUploads' => [ [ 'input' => [ 'Bucket' => 'examplebucket', ], 'output' => [ 'Uploads' => [ [ 'Initiated' => '2014-05-01T05:40:58.000Z', 'Initiator' => [ 'DisplayName' => 'display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Key' => 'JavaFile', 'Owner' => [ 'DisplayName' => 'display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'StorageClass' => 'STANDARD', 'UploadId' => 'examplelUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--', ], [ 'Initiated' => '2014-05-01T05:41:27.000Z', 'Initiator' => [ 'DisplayName' => 'display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Key' => 'JavaFile', 'Owner' => [ 'DisplayName' => 'display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'StorageClass' => 'STANDARD', 'UploadId' => 'examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example lists in-progress multipart uploads on a specific bucket.', 'id' => 'to-list-in-progress-multipart-uploads-on-a-bucket-1481852775260', 'title' => 'To list in-progress multipart uploads on a bucket', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'KeyMarker' => 'nextkeyfrompreviousresponse', 'MaxUploads' => '2', 'UploadIdMarker' => 'valuefrompreviousresponse', ], 'output' => [ 'Bucket' => 'acl1', 'IsTruncated' => true, 'KeyMarker' => '', 'MaxUploads' => '2', 'NextKeyMarker' => 'someobjectkey', 'NextUploadIdMarker' => 'examplelo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--', 'UploadIdMarker' => '', 'Uploads' => [ [ 'Initiated' => '2014-05-01T05:40:58.000Z', 'Initiator' => [ 'DisplayName' => 'ownder-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Key' => 'JavaFile', 'Owner' => [ 'DisplayName' => 'mohanataws', 'ID' => '852b113e7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'StorageClass' => 'STANDARD', 'UploadId' => 'gZ30jIqlUa.CInXklLQtSMJITdUnoZ1Y5GACB5UckOtspm5zbDMCkPF_qkfZzMiFZ6dksmcnqxJyIBvQMG9X9Q--', ], [ 'Initiated' => '2014-05-01T05:41:27.000Z', 'Initiator' => [ 'DisplayName' => 'ownder-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Key' => 'JavaFile', 'Owner' => [ 'DisplayName' => 'ownder-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'StorageClass' => 'STANDARD', 'UploadId' => 'b7tZSqIlo91lv1iwvWpvCiJWugw2xXLPAD7Z8cJyX9.WiIRgNrdG6Ldsn.9FtS63TCl1Uf5faTB.1U5Ckcbmdw--', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example specifies the upload-id-marker and key-marker from previous truncated response to retrieve next setup of multipart uploads.', 'id' => 'list-next-set-of-multipart-uploads-when-previous-result-is-truncated-1482428106748', 'title' => 'List next set of multipart uploads when previous result is truncated', ], ], 'ListObjectVersions' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Prefix' => 'HappyFace.jpg', ], 'output' => [ 'Versions' => [ [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'IsLatest' => true, 'Key' => 'HappyFace.jpg', 'LastModified' => '2016-12-15T01:19:41.000Z', 'Owner' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Size' => 3191, 'StorageClass' => 'STANDARD', 'VersionId' => 'null', ], [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'IsLatest' => false, 'Key' => 'HappyFace.jpg', 'LastModified' => '2016-12-13T00:58:26.000Z', 'Owner' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Size' => 3191, 'StorageClass' => 'STANDARD', 'VersionId' => 'PHtexPGjH2y.zBgT8LmB7wwLI2mpbz.k', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example returns versions of an object with specific key name prefix.', 'id' => 'to-list-object-versions-1481910996058', 'title' => 'To list object versions', ], ], 'ListObjects' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'MaxKeys' => '2', ], 'output' => [ 'Contents' => [ [ 'ETag' => '"70ee1738b6b21e2c8a43f3a5ab0eee71"', 'Key' => 'example1.jpg', 'LastModified' => '2014-11-21T19:40:05.000Z', 'Owner' => [ 'DisplayName' => 'myname', 'ID' => '12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Size' => 11, 'StorageClass' => 'STANDARD', ], [ 'ETag' => '"9c8af9a76df052144598c115ef33e511"', 'Key' => 'example2.jpg', 'LastModified' => '2013-11-15T01:10:49.000Z', 'Owner' => [ 'DisplayName' => 'myname', 'ID' => '12345example25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Size' => 713193, 'StorageClass' => 'STANDARD', ], ], 'NextMarker' => 'eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAyfQ==', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example list two objects in a bucket.', 'id' => 'to-list-objects-in-a-bucket-1473447646507', 'title' => 'To list objects in a bucket', ], ], 'ListObjectsV2' => [ [ 'input' => [ 'Bucket' => 'DOC-EXAMPLE-BUCKET', 'MaxKeys' => '2', ], 'output' => [ 'Contents' => [ [ 'ETag' => '"70ee1738b6b21e2c8a43f3a5ab0eee71"', 'Key' => 'happyface.jpg', 'LastModified' => '2014-11-21T19:40:05.000Z', 'Size' => 11, 'StorageClass' => 'STANDARD', ], [ 'ETag' => '"becf17f89c30367a9a44495d62ed521a-1"', 'Key' => 'test.jpg', 'LastModified' => '2014-05-02T04:51:50.000Z', 'Size' => 4192256, 'StorageClass' => 'STANDARD', ], ], 'IsTruncated' => true, 'KeyCount' => '2', 'MaxKeys' => '2', 'Name' => 'DOC-EXAMPLE-BUCKET', 'NextContinuationToken' => '1w41l63U0xa8q7smH50vCxyTQqdxo69O3EmK28Bi5PcROI4wI/EyIJg==', 'Prefix' => '', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example retrieves object list. The request specifies max keys to limit response to include only 2 object keys. ', 'id' => 'to-get-object-list', 'title' => 'To get object list', ], ], 'ListParts' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'bigobject', 'UploadId' => 'example7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--', ], 'output' => [ 'Initiator' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Owner' => [ 'DisplayName' => 'owner-display-name', 'ID' => 'examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484be31bebcc', ], 'Parts' => [ [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', 'LastModified' => '2016-12-16T00:11:42.000Z', 'PartNumber' => '1', 'Size' => 26246026, ], [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', 'LastModified' => '2016-12-16T00:15:01.000Z', 'PartNumber' => '2', 'Size' => 26246026, ], ], 'StorageClass' => 'STANDARD', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example lists parts uploaded for a specific multipart upload.', 'id' => 'to-list-parts-of-a-multipart-upload-1481852006923', 'title' => 'To list parts of a multipart upload.', ], ], 'PutBucketAcl' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'GrantFullControl' => 'id=examplee7a2f25102679df27bb0ae12b3f85be6f290b936c4393484', 'GrantWrite' => 'uri=http://acs.amazonaws.com/groups/s3/LogDelivery', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example replaces existing ACL on a bucket. The ACL grants the bucket owner (specified using the owner ID) and write permission to the LogDelivery group. Because this is a replace operation, you must specify all the grants in your request. To incrementally add or remove ACL grants, you might use the console.', 'id' => 'put-bucket-acl-1482260397033', 'title' => 'Put bucket acl', ], ], 'PutBucketCors' => [ [ 'input' => [ 'Bucket' => '', 'CORSConfiguration' => [ 'CORSRules' => [ [ 'AllowedHeaders' => [ '*', ], 'AllowedMethods' => [ 'PUT', 'POST', 'DELETE', ], 'AllowedOrigins' => [ 'http://www.example.com', ], 'ExposeHeaders' => [ 'x-amz-server-side-encryption', ], 'MaxAgeSeconds' => 3000, ], [ 'AllowedHeaders' => [ 'Authorization', ], 'AllowedMethods' => [ 'GET', ], 'AllowedOrigins' => [ '*', ], 'MaxAgeSeconds' => 3000, ], ], ], 'ContentMD5' => '', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example enables PUT, POST, and DELETE requests from www.example.com, and enables GET requests from any domain.', 'id' => 'to-set-cors-configuration-on-a-bucket-1483037818805', 'title' => 'To set cors configuration on a bucket.', ], ], 'PutBucketLifecycleConfiguration' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'LifecycleConfiguration' => [ 'Rules' => [ [ 'Expiration' => [ 'Days' => 3650, ], 'Filter' => [ 'Prefix' => 'documents/', ], 'ID' => 'TestOnly', 'Status' => 'Enabled', 'Transitions' => [ [ 'Days' => 365, 'StorageClass' => 'GLACIER', ], ], ], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example replaces existing lifecycle configuration, if any, on the specified bucket. ', 'id' => 'put-bucket-lifecycle-1482264533092', 'title' => 'Put bucket lifecycle', ], ], 'PutBucketLogging' => [ [ 'input' => [ 'Bucket' => 'sourcebucket', 'BucketLoggingStatus' => [ 'LoggingEnabled' => [ 'TargetBucket' => 'targetbucket', 'TargetGrants' => [ [ 'Grantee' => [ 'Type' => 'Group', 'URI' => 'http://acs.amazonaws.com/groups/global/AllUsers', ], 'Permission' => 'READ', ], ], 'TargetPrefix' => 'MyBucketLogs/', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets logging policy on a bucket. For the Log Delivery group to deliver logs to the destination bucket, it needs permission for the READ_ACP action which the policy grants.', 'id' => 'set-logging-configuration-for-a-bucket-1482269119909', 'title' => 'Set logging configuration for a bucket', ], ], 'PutBucketNotificationConfiguration' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'NotificationConfiguration' => [ 'TopicConfigurations' => [ [ 'Events' => [ 's3:ObjectCreated:*', ], 'TopicArn' => 'arn:aws:sns:us-west-2:123456789012:s3-notification-topic', ], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets notification configuration on a bucket to publish the object created events to an SNS topic.', 'id' => 'set-notification-configuration-for-a-bucket-1482270296426', 'title' => 'Set notification configuration for a bucket', ], ], 'PutBucketPolicy' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Policy' => '{"Version": "2012-10-17", "Statement": [{ "Sid": "id-1","Effect": "Allow","Principal": {"AWS": "arn:aws:iam::123456789012:root"}, "Action": [ "s3:PutObject","s3:PutObjectAcl"], "Resource": ["arn:aws:s3:::acl3/*" ] } ]}', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets a permission policy on a bucket.', 'id' => 'set-bucket-policy-1482448903302', 'title' => 'Set bucket policy', ], ], 'PutBucketReplication' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'ReplicationConfiguration' => [ 'Role' => 'arn:aws:iam::123456789012:role/examplerole', 'Rules' => [ [ 'Destination' => [ 'Bucket' => 'arn:aws:s3:::destinationbucket', 'StorageClass' => 'STANDARD', ], 'Prefix' => '', 'Status' => 'Enabled', ], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets replication configuration on a bucket.', 'id' => 'id-1', 'title' => 'Set replication configuration on a bucket', ], ], 'PutBucketRequestPayment' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'RequestPaymentConfiguration' => [ 'Payer' => 'Requester', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets request payment configuration on a bucket so that person requesting the download is charged.', 'id' => 'set-request-payment-configuration-on-a-bucket-1482343596680', 'title' => 'Set request payment configuration on a bucket.', ], ], 'PutBucketTagging' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Tagging' => [ 'TagSet' => [ [ 'Key' => 'Key1', 'Value' => 'Value1', ], [ 'Key' => 'Key2', 'Value' => 'Value2', ], ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets tags on a bucket. Any existing tags are replaced.', 'id' => 'set-tags-on-a-bucket-1482346269066', 'title' => 'Set tags on a bucket', ], ], 'PutBucketVersioning' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'VersioningConfiguration' => [ 'MFADelete' => 'Disabled', 'Status' => 'Enabled', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example sets versioning configuration on bucket. The configuration enables versioning on the bucket.', 'id' => 'set-versioning-configuration-on-a-bucket-1482344186279', 'title' => 'Set versioning configuration on a bucket', ], ], 'PutBucketWebsite' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'ContentMD5' => '', 'WebsiteConfiguration' => [ 'ErrorDocument' => [ 'Key' => 'error.html', ], 'IndexDocument' => [ 'Suffix' => 'index.html', ], ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example adds website configuration to a bucket.', 'id' => 'set-website-configuration-on-a-bucket-1482346836261', 'title' => 'Set website configuration on a bucket', ], ], 'PutObject' => [ [ 'input' => [ 'Body' => 'filetoupload', 'Bucket' => 'examplebucket', 'Key' => 'exampleobject', 'ServerSideEncryption' => 'AES256', 'Tagging' => 'key1=value1&key2=value2', ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'ServerSideEncryption' => 'AES256', 'VersionId' => 'Ri.vC6qVlA4dEnjgRV4ZHsHoFIjqEMNt', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example uploads an 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', ], [ 'input' => [ 'Body' => 'HappyFace.jpg', 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'VersionId' => 'tpf3zF08nBplQK1XLOefGskR7mGDwcDk', ], 'comments' => [ 'input' => [], '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', ], [ 'input' => [ 'Body' => 'c:\\HappyFace.jpg', 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', 'Tagging' => 'key1=value1&key2=value2', ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'VersionId' => 'psM2sYY4.o1501dSx8wMvnkOzSBB.V4a', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example uploads an object. The request specifies optional object tags. The bucket is versioned, therefore S3 returns version ID of the newly created object.', 'id' => 'to-upload-an-object-and-specify-optional-tags-1481762310955', 'title' => 'To upload an object and specify optional tags', ], [ 'input' => [ 'Body' => 'filetoupload', 'Bucket' => 'examplebucket', 'Key' => 'exampleobject', 'Metadata' => [ 'metadata1' => 'value1', 'metadata2' => 'value2', ], ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'VersionId' => 'pSKidl4pHBiNwukdbcPXAIs.sshFFOc0', ], 'comments' => [ 'input' => [], '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', ], [ 'input' => [ 'ACL' => 'authenticated-read', 'Body' => 'filetoupload', 'Bucket' => 'examplebucket', 'Key' => 'exampleobject', ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'VersionId' => 'Kirh.unyZwjQ69YxcQLA8z4F5j3kJJKr', ], 'comments' => [ 'input' => [], '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.', ], [ 'input' => [ 'Body' => 'HappyFace.jpg', 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', 'ServerSideEncryption' => 'AES256', 'StorageClass' => 'STANDARD_IA', ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'ServerSideEncryption' => 'AES256', 'VersionId' => 'CG612hodqujkf8FaaNfp8U..FIhLROcp', ], 'comments' => [ 'input' => [], '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)', ], [ 'input' => [ 'Body' => 'filetoupload', 'Bucket' => 'examplebucket', 'Key' => 'objectkey', ], 'output' => [ 'ETag' => '"6805f2cfc46c0f04559748bb039d69ae"', 'VersionId' => 'Bvq0EDKxOcXLJXNo_Lkz37eM3R4pfzyQ', ], 'comments' => [ 'input' => [], '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.', ], ], 'PutObjectAcl' => [ [ 'input' => [ 'AccessControlPolicy' => [], 'Bucket' => 'examplebucket', 'GrantFullControl' => 'emailaddress=user1@example.com,emailaddress=user2@example.com', 'GrantRead' => 'uri=http://acs.amazonaws.com/groups/global/AllUsers', 'Key' => 'HappyFace.jpg', ], 'output' => [], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example adds grants to an object ACL. The first permission grants user1 and user2 FULL_CONTROL and the AllUsers group READ permission.', 'id' => 'to-grant-permissions-using-object-acl-1481835549285', 'title' => 'To grant permissions using object ACL', ], ], 'PutObjectTagging' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'HappyFace.jpg', 'Tagging' => [ 'TagSet' => [ [ 'Key' => 'Key3', 'Value' => 'Value3', ], [ 'Key' => 'Key4', 'Value' => 'Value4', ], ], ], ], 'output' => [ 'VersionId' => 'null', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example adds tags to an existing object.', 'id' => 'to-add-tags-to-an-existing-object-1481764668793', 'title' => 'To add tags to an existing object', ], ], 'RestoreObject' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'Key' => 'archivedobjectkey', 'RestoreRequest' => [ 'Days' => 1, 'GlacierJobParameters' => [ 'Tier' => 'Expedited', ], ], ], 'output' => [], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example restores for one day an archived copy of an object back into Amazon S3 bucket.', 'id' => 'to-restore-an-archived-object-1483049329953', 'title' => 'To restore an archived object', ], ], 'UploadPart' => [ [ 'input' => [ 'Body' => 'fileToUpload', 'Bucket' => 'examplebucket', 'Key' => 'examplelargeobject', 'PartNumber' => '1', 'UploadId' => 'xadcOB_7YPBOJuoFiQ9cz4P3Pe6FIZwO4f7wN93uHsNBEw97pl5eNwzExg0LAT2dUN91cOmrEQHDsP3WA60CEg--', ], 'output' => [ 'ETag' => '"d8c2eafd90c266e19ab9dcacc479f8af"', ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example uploads part 1 of a multipart upload. The example specifies a file name for the part data. The Upload ID is same that is returned by the initiate multipart upload.', 'id' => 'to-upload-a-part-1481847914943', 'title' => 'To upload a part', ], ], 'UploadPartCopy' => [ [ 'input' => [ 'Bucket' => 'examplebucket', 'CopySource' => '/bucketname/sourceobjectkey', 'Key' => 'examplelargeobject', 'PartNumber' => '1', 'UploadId' => 'exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--', ], 'output' => [ 'CopyPartResult' => [ 'ETag' => '"b0c6f0e7e054ab8fa2536a2677f8734d"', 'LastModified' => '2016-12-29T21:24:43.000Z', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example uploads a part of a multipart upload by copying data from an existing object as data source.', 'id' => 'to-upload-a-part-by-copying-data-from-an-existing-object-as-data-source-1483046746348', 'title' => 'To upload a part by copying data from an existing object as data source', ], [ 'input' => [ 'Bucket' => 'examplebucket', 'CopySource' => '/bucketname/sourceobjectkey', 'CopySourceRange' => 'bytes=1-100000', 'Key' => 'examplelargeobject', 'PartNumber' => '2', 'UploadId' => 'exampleuoh_10OhKhT7YukE9bjzTPRiuaCotmZM_pFngJFir9OZNrSr5cWa3cq3LZSUsfjI4FI7PkP91We7Nrw--', ], 'output' => [ 'CopyPartResult' => [ 'ETag' => '"65d16d19e65a7508a51f043180edcc36"', 'LastModified' => '2016-12-29T21:44:28.000Z', ], ], 'comments' => [ 'input' => [], 'output' => [], ], 'description' => 'The following example uploads a part of a multipart upload by copying a specified byte range from an existing object as data source.', 'id' => 'to-upload-a-part-by-copying-byte-range-from-an-existing-object-as-data-source-1483048068594', 'title' => 'To upload a part by copying byte range from an existing object as data source', ], ], ],];