/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace Aws { namespace Http { class HttpClient; class HttpClientFactory; } // namespace Http namespace Utils { template< typename R, typename E> class Outcome; namespace Threading { class Executor; } // namespace Threading namespace Xml { class XmlDocument; } // namespace Xml } // namespace Utils namespace Auth { class AWSCredentials; class AWSCredentialsProvider; } // namespace Auth namespace Client { class RetryStrategy; } // namespace Client namespace S3 { namespace Model { class AbortMultipartUploadRequest; class CompleteMultipartUploadRequest; class CopyObjectRequest; class CreateBucketRequest; class CreateMultipartUploadRequest; class DeleteBucketRequest; class DeleteBucketAnalyticsConfigurationRequest; class DeleteBucketCorsRequest; class DeleteBucketEncryptionRequest; class DeleteBucketInventoryConfigurationRequest; class DeleteBucketLifecycleRequest; class DeleteBucketMetricsConfigurationRequest; class DeleteBucketPolicyRequest; class DeleteBucketReplicationRequest; class DeleteBucketTaggingRequest; class DeleteBucketWebsiteRequest; class DeleteObjectRequest; class DeleteObjectTaggingRequest; class DeleteObjectsRequest; class DeletePublicAccessBlockRequest; class GetBucketAccelerateConfigurationRequest; class GetBucketAclRequest; class GetBucketAnalyticsConfigurationRequest; class GetBucketCorsRequest; class GetBucketEncryptionRequest; class GetBucketInventoryConfigurationRequest; class GetBucketLifecycleConfigurationRequest; class GetBucketLocationRequest; class GetBucketLoggingRequest; class GetBucketMetricsConfigurationRequest; class GetBucketNotificationConfigurationRequest; class GetBucketPolicyRequest; class GetBucketPolicyStatusRequest; class GetBucketReplicationRequest; class GetBucketRequestPaymentRequest; class GetBucketTaggingRequest; class GetBucketVersioningRequest; class GetBucketWebsiteRequest; class GetObjectRequest; class GetObjectAclRequest; class GetObjectLegalHoldRequest; class GetObjectLockConfigurationRequest; class GetObjectRetentionRequest; class GetObjectTaggingRequest; class GetObjectTorrentRequest; class GetPublicAccessBlockRequest; class HeadBucketRequest; class HeadObjectRequest; class ListBucketAnalyticsConfigurationsRequest; class ListBucketInventoryConfigurationsRequest; class ListBucketMetricsConfigurationsRequest; class ListMultipartUploadsRequest; class ListObjectVersionsRequest; class ListObjectsRequest; class ListObjectsV2Request; class ListPartsRequest; class PutBucketAccelerateConfigurationRequest; class PutBucketAclRequest; class PutBucketAnalyticsConfigurationRequest; class PutBucketCorsRequest; class PutBucketEncryptionRequest; class PutBucketInventoryConfigurationRequest; class PutBucketLifecycleConfigurationRequest; class PutBucketLoggingRequest; class PutBucketMetricsConfigurationRequest; class PutBucketNotificationConfigurationRequest; class PutBucketPolicyRequest; class PutBucketReplicationRequest; class PutBucketRequestPaymentRequest; class PutBucketTaggingRequest; class PutBucketVersioningRequest; class PutBucketWebsiteRequest; class PutObjectRequest; class PutObjectAclRequest; class PutObjectLegalHoldRequest; class PutObjectLockConfigurationRequest; class PutObjectRetentionRequest; class PutObjectTaggingRequest; class PutPublicAccessBlockRequest; class RestoreObjectRequest; class SelectObjectContentRequest; class UploadPartRequest; class UploadPartCopyRequest; typedef Aws::Utils::Outcome AbortMultipartUploadOutcome; typedef Aws::Utils::Outcome CompleteMultipartUploadOutcome; typedef Aws::Utils::Outcome CopyObjectOutcome; typedef Aws::Utils::Outcome CreateBucketOutcome; typedef Aws::Utils::Outcome CreateMultipartUploadOutcome; typedef Aws::Utils::Outcome DeleteBucketOutcome; typedef Aws::Utils::Outcome DeleteBucketAnalyticsConfigurationOutcome; typedef Aws::Utils::Outcome DeleteBucketCorsOutcome; typedef Aws::Utils::Outcome DeleteBucketEncryptionOutcome; typedef Aws::Utils::Outcome DeleteBucketInventoryConfigurationOutcome; typedef Aws::Utils::Outcome DeleteBucketLifecycleOutcome; typedef Aws::Utils::Outcome DeleteBucketMetricsConfigurationOutcome; typedef Aws::Utils::Outcome DeleteBucketPolicyOutcome; typedef Aws::Utils::Outcome DeleteBucketReplicationOutcome; typedef Aws::Utils::Outcome DeleteBucketTaggingOutcome; typedef Aws::Utils::Outcome DeleteBucketWebsiteOutcome; typedef Aws::Utils::Outcome DeleteObjectOutcome; typedef Aws::Utils::Outcome DeleteObjectTaggingOutcome; typedef Aws::Utils::Outcome DeleteObjectsOutcome; typedef Aws::Utils::Outcome DeletePublicAccessBlockOutcome; typedef Aws::Utils::Outcome GetBucketAccelerateConfigurationOutcome; typedef Aws::Utils::Outcome GetBucketAclOutcome; typedef Aws::Utils::Outcome GetBucketAnalyticsConfigurationOutcome; typedef Aws::Utils::Outcome GetBucketCorsOutcome; typedef Aws::Utils::Outcome GetBucketEncryptionOutcome; typedef Aws::Utils::Outcome GetBucketInventoryConfigurationOutcome; typedef Aws::Utils::Outcome GetBucketLifecycleConfigurationOutcome; typedef Aws::Utils::Outcome GetBucketLocationOutcome; typedef Aws::Utils::Outcome GetBucketLoggingOutcome; typedef Aws::Utils::Outcome GetBucketMetricsConfigurationOutcome; typedef Aws::Utils::Outcome GetBucketNotificationConfigurationOutcome; typedef Aws::Utils::Outcome GetBucketPolicyOutcome; typedef Aws::Utils::Outcome GetBucketPolicyStatusOutcome; typedef Aws::Utils::Outcome GetBucketReplicationOutcome; typedef Aws::Utils::Outcome GetBucketRequestPaymentOutcome; typedef Aws::Utils::Outcome GetBucketTaggingOutcome; typedef Aws::Utils::Outcome GetBucketVersioningOutcome; typedef Aws::Utils::Outcome GetBucketWebsiteOutcome; typedef Aws::Utils::Outcome GetObjectOutcome; typedef Aws::Utils::Outcome GetObjectAclOutcome; typedef Aws::Utils::Outcome GetObjectLegalHoldOutcome; typedef Aws::Utils::Outcome GetObjectLockConfigurationOutcome; typedef Aws::Utils::Outcome GetObjectRetentionOutcome; typedef Aws::Utils::Outcome GetObjectTaggingOutcome; typedef Aws::Utils::Outcome GetObjectTorrentOutcome; typedef Aws::Utils::Outcome GetPublicAccessBlockOutcome; typedef Aws::Utils::Outcome HeadBucketOutcome; typedef Aws::Utils::Outcome HeadObjectOutcome; typedef Aws::Utils::Outcome ListBucketAnalyticsConfigurationsOutcome; typedef Aws::Utils::Outcome ListBucketInventoryConfigurationsOutcome; typedef Aws::Utils::Outcome ListBucketMetricsConfigurationsOutcome; typedef Aws::Utils::Outcome ListBucketsOutcome; typedef Aws::Utils::Outcome ListMultipartUploadsOutcome; typedef Aws::Utils::Outcome ListObjectVersionsOutcome; typedef Aws::Utils::Outcome ListObjectsOutcome; typedef Aws::Utils::Outcome ListObjectsV2Outcome; typedef Aws::Utils::Outcome ListPartsOutcome; typedef Aws::Utils::Outcome PutBucketAccelerateConfigurationOutcome; typedef Aws::Utils::Outcome PutBucketAclOutcome; typedef Aws::Utils::Outcome PutBucketAnalyticsConfigurationOutcome; typedef Aws::Utils::Outcome PutBucketCorsOutcome; typedef Aws::Utils::Outcome PutBucketEncryptionOutcome; typedef Aws::Utils::Outcome PutBucketInventoryConfigurationOutcome; typedef Aws::Utils::Outcome PutBucketLifecycleConfigurationOutcome; typedef Aws::Utils::Outcome PutBucketLoggingOutcome; typedef Aws::Utils::Outcome PutBucketMetricsConfigurationOutcome; typedef Aws::Utils::Outcome PutBucketNotificationConfigurationOutcome; typedef Aws::Utils::Outcome PutBucketPolicyOutcome; typedef Aws::Utils::Outcome PutBucketReplicationOutcome; typedef Aws::Utils::Outcome PutBucketRequestPaymentOutcome; typedef Aws::Utils::Outcome PutBucketTaggingOutcome; typedef Aws::Utils::Outcome PutBucketVersioningOutcome; typedef Aws::Utils::Outcome PutBucketWebsiteOutcome; typedef Aws::Utils::Outcome PutObjectOutcome; typedef Aws::Utils::Outcome PutObjectAclOutcome; typedef Aws::Utils::Outcome PutObjectLegalHoldOutcome; typedef Aws::Utils::Outcome PutObjectLockConfigurationOutcome; typedef Aws::Utils::Outcome PutObjectRetentionOutcome; typedef Aws::Utils::Outcome PutObjectTaggingOutcome; typedef Aws::Utils::Outcome PutPublicAccessBlockOutcome; typedef Aws::Utils::Outcome RestoreObjectOutcome; typedef Aws::Utils::Outcome SelectObjectContentOutcome; typedef Aws::Utils::Outcome UploadPartOutcome; typedef Aws::Utils::Outcome UploadPartCopyOutcome; typedef std::future AbortMultipartUploadOutcomeCallable; typedef std::future CompleteMultipartUploadOutcomeCallable; typedef std::future CopyObjectOutcomeCallable; typedef std::future CreateBucketOutcomeCallable; typedef std::future CreateMultipartUploadOutcomeCallable; typedef std::future DeleteBucketOutcomeCallable; typedef std::future DeleteBucketAnalyticsConfigurationOutcomeCallable; typedef std::future DeleteBucketCorsOutcomeCallable; typedef std::future DeleteBucketEncryptionOutcomeCallable; typedef std::future DeleteBucketInventoryConfigurationOutcomeCallable; typedef std::future DeleteBucketLifecycleOutcomeCallable; typedef std::future DeleteBucketMetricsConfigurationOutcomeCallable; typedef std::future DeleteBucketPolicyOutcomeCallable; typedef std::future DeleteBucketReplicationOutcomeCallable; typedef std::future DeleteBucketTaggingOutcomeCallable; typedef std::future DeleteBucketWebsiteOutcomeCallable; typedef std::future DeleteObjectOutcomeCallable; typedef std::future DeleteObjectTaggingOutcomeCallable; typedef std::future DeleteObjectsOutcomeCallable; typedef std::future DeletePublicAccessBlockOutcomeCallable; typedef std::future GetBucketAccelerateConfigurationOutcomeCallable; typedef std::future GetBucketAclOutcomeCallable; typedef std::future GetBucketAnalyticsConfigurationOutcomeCallable; typedef std::future GetBucketCorsOutcomeCallable; typedef std::future GetBucketEncryptionOutcomeCallable; typedef std::future GetBucketInventoryConfigurationOutcomeCallable; typedef std::future GetBucketLifecycleConfigurationOutcomeCallable; typedef std::future GetBucketLocationOutcomeCallable; typedef std::future GetBucketLoggingOutcomeCallable; typedef std::future GetBucketMetricsConfigurationOutcomeCallable; typedef std::future GetBucketNotificationConfigurationOutcomeCallable; typedef std::future GetBucketPolicyOutcomeCallable; typedef std::future GetBucketPolicyStatusOutcomeCallable; typedef std::future GetBucketReplicationOutcomeCallable; typedef std::future GetBucketRequestPaymentOutcomeCallable; typedef std::future GetBucketTaggingOutcomeCallable; typedef std::future GetBucketVersioningOutcomeCallable; typedef std::future GetBucketWebsiteOutcomeCallable; typedef std::future GetObjectOutcomeCallable; typedef std::future GetObjectAclOutcomeCallable; typedef std::future GetObjectLegalHoldOutcomeCallable; typedef std::future GetObjectLockConfigurationOutcomeCallable; typedef std::future GetObjectRetentionOutcomeCallable; typedef std::future GetObjectTaggingOutcomeCallable; typedef std::future GetObjectTorrentOutcomeCallable; typedef std::future GetPublicAccessBlockOutcomeCallable; typedef std::future HeadBucketOutcomeCallable; typedef std::future HeadObjectOutcomeCallable; typedef std::future ListBucketAnalyticsConfigurationsOutcomeCallable; typedef std::future ListBucketInventoryConfigurationsOutcomeCallable; typedef std::future ListBucketMetricsConfigurationsOutcomeCallable; typedef std::future ListBucketsOutcomeCallable; typedef std::future ListMultipartUploadsOutcomeCallable; typedef std::future ListObjectVersionsOutcomeCallable; typedef std::future ListObjectsOutcomeCallable; typedef std::future ListObjectsV2OutcomeCallable; typedef std::future ListPartsOutcomeCallable; typedef std::future PutBucketAccelerateConfigurationOutcomeCallable; typedef std::future PutBucketAclOutcomeCallable; typedef std::future PutBucketAnalyticsConfigurationOutcomeCallable; typedef std::future PutBucketCorsOutcomeCallable; typedef std::future PutBucketEncryptionOutcomeCallable; typedef std::future PutBucketInventoryConfigurationOutcomeCallable; typedef std::future PutBucketLifecycleConfigurationOutcomeCallable; typedef std::future PutBucketLoggingOutcomeCallable; typedef std::future PutBucketMetricsConfigurationOutcomeCallable; typedef std::future PutBucketNotificationConfigurationOutcomeCallable; typedef std::future PutBucketPolicyOutcomeCallable; typedef std::future PutBucketReplicationOutcomeCallable; typedef std::future PutBucketRequestPaymentOutcomeCallable; typedef std::future PutBucketTaggingOutcomeCallable; typedef std::future PutBucketVersioningOutcomeCallable; typedef std::future PutBucketWebsiteOutcomeCallable; typedef std::future PutObjectOutcomeCallable; typedef std::future PutObjectAclOutcomeCallable; typedef std::future PutObjectLegalHoldOutcomeCallable; typedef std::future PutObjectLockConfigurationOutcomeCallable; typedef std::future PutObjectRetentionOutcomeCallable; typedef std::future PutObjectTaggingOutcomeCallable; typedef std::future PutPublicAccessBlockOutcomeCallable; typedef std::future RestoreObjectOutcomeCallable; typedef std::future SelectObjectContentOutcomeCallable; typedef std::future UploadPartOutcomeCallable; typedef std::future UploadPartCopyOutcomeCallable; } // namespace Model namespace SSEHeaders { static const char SERVER_SIDE_ENCRYPTION[] = "x-amz-server-side-encryption"; static const char SERVER_SIDE_ENCRYPTION_AWS_KMS_KEY_ID[] = "x-amz-server-side-encryption-aws-kms-key-id"; static const char SERVER_SIDE_ENCRYPTION_CUSTOMER_ALGORITHM[] = "x-amz-server-side-encryption-customer-algorithm"; static const char SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY[] = "x-amz-server-side-encryption-customer-key"; static const char SERVER_SIDE_ENCRYPTION_CUSTOMER_KEY_MD5[] = "x-amz-server-side-encryption-customer-key-MD5"; } // SS3Headers class S3Client; typedef std::function&) > AbortMultipartUploadResponseReceivedHandler; typedef std::function&) > CompleteMultipartUploadResponseReceivedHandler; typedef std::function&) > CopyObjectResponseReceivedHandler; typedef std::function&) > CreateBucketResponseReceivedHandler; typedef std::function&) > CreateMultipartUploadResponseReceivedHandler; typedef std::function&) > DeleteBucketResponseReceivedHandler; typedef std::function&) > DeleteBucketAnalyticsConfigurationResponseReceivedHandler; typedef std::function&) > DeleteBucketCorsResponseReceivedHandler; typedef std::function&) > DeleteBucketEncryptionResponseReceivedHandler; typedef std::function&) > DeleteBucketInventoryConfigurationResponseReceivedHandler; typedef std::function&) > DeleteBucketLifecycleResponseReceivedHandler; typedef std::function&) > DeleteBucketMetricsConfigurationResponseReceivedHandler; typedef std::function&) > DeleteBucketPolicyResponseReceivedHandler; typedef std::function&) > DeleteBucketReplicationResponseReceivedHandler; typedef std::function&) > DeleteBucketTaggingResponseReceivedHandler; typedef std::function&) > DeleteBucketWebsiteResponseReceivedHandler; typedef std::function&) > DeleteObjectResponseReceivedHandler; typedef std::function&) > DeleteObjectTaggingResponseReceivedHandler; typedef std::function&) > DeleteObjectsResponseReceivedHandler; typedef std::function&) > DeletePublicAccessBlockResponseReceivedHandler; typedef std::function&) > GetBucketAccelerateConfigurationResponseReceivedHandler; typedef std::function&) > GetBucketAclResponseReceivedHandler; typedef std::function&) > GetBucketAnalyticsConfigurationResponseReceivedHandler; typedef std::function&) > GetBucketCorsResponseReceivedHandler; typedef std::function&) > GetBucketEncryptionResponseReceivedHandler; typedef std::function&) > GetBucketInventoryConfigurationResponseReceivedHandler; typedef std::function&) > GetBucketLifecycleConfigurationResponseReceivedHandler; typedef std::function&) > GetBucketLocationResponseReceivedHandler; typedef std::function&) > GetBucketLoggingResponseReceivedHandler; typedef std::function&) > GetBucketMetricsConfigurationResponseReceivedHandler; typedef std::function&) > GetBucketNotificationConfigurationResponseReceivedHandler; typedef std::function&) > GetBucketPolicyResponseReceivedHandler; typedef std::function&) > GetBucketPolicyStatusResponseReceivedHandler; typedef std::function&) > GetBucketReplicationResponseReceivedHandler; typedef std::function&) > GetBucketRequestPaymentResponseReceivedHandler; typedef std::function&) > GetBucketTaggingResponseReceivedHandler; typedef std::function&) > GetBucketVersioningResponseReceivedHandler; typedef std::function&) > GetBucketWebsiteResponseReceivedHandler; typedef std::function&) > GetObjectResponseReceivedHandler; typedef std::function&) > GetObjectAclResponseReceivedHandler; typedef std::function&) > GetObjectLegalHoldResponseReceivedHandler; typedef std::function&) > GetObjectLockConfigurationResponseReceivedHandler; typedef std::function&) > GetObjectRetentionResponseReceivedHandler; typedef std::function&) > GetObjectTaggingResponseReceivedHandler; typedef std::function&) > GetObjectTorrentResponseReceivedHandler; typedef std::function&) > GetPublicAccessBlockResponseReceivedHandler; typedef std::function&) > HeadBucketResponseReceivedHandler; typedef std::function&) > HeadObjectResponseReceivedHandler; typedef std::function&) > ListBucketAnalyticsConfigurationsResponseReceivedHandler; typedef std::function&) > ListBucketInventoryConfigurationsResponseReceivedHandler; typedef std::function&) > ListBucketMetricsConfigurationsResponseReceivedHandler; typedef std::function&) > ListBucketsResponseReceivedHandler; typedef std::function&) > ListMultipartUploadsResponseReceivedHandler; typedef std::function&) > ListObjectVersionsResponseReceivedHandler; typedef std::function&) > ListObjectsResponseReceivedHandler; typedef std::function&) > ListObjectsV2ResponseReceivedHandler; typedef std::function&) > ListPartsResponseReceivedHandler; typedef std::function&) > PutBucketAccelerateConfigurationResponseReceivedHandler; typedef std::function&) > PutBucketAclResponseReceivedHandler; typedef std::function&) > PutBucketAnalyticsConfigurationResponseReceivedHandler; typedef std::function&) > PutBucketCorsResponseReceivedHandler; typedef std::function&) > PutBucketEncryptionResponseReceivedHandler; typedef std::function&) > PutBucketInventoryConfigurationResponseReceivedHandler; typedef std::function&) > PutBucketLifecycleConfigurationResponseReceivedHandler; typedef std::function&) > PutBucketLoggingResponseReceivedHandler; typedef std::function&) > PutBucketMetricsConfigurationResponseReceivedHandler; typedef std::function&) > PutBucketNotificationConfigurationResponseReceivedHandler; typedef std::function&) > PutBucketPolicyResponseReceivedHandler; typedef std::function&) > PutBucketReplicationResponseReceivedHandler; typedef std::function&) > PutBucketRequestPaymentResponseReceivedHandler; typedef std::function&) > PutBucketTaggingResponseReceivedHandler; typedef std::function&) > PutBucketVersioningResponseReceivedHandler; typedef std::function&) > PutBucketWebsiteResponseReceivedHandler; typedef std::function&) > PutObjectResponseReceivedHandler; typedef std::function&) > PutObjectAclResponseReceivedHandler; typedef std::function&) > PutObjectLegalHoldResponseReceivedHandler; typedef std::function&) > PutObjectLockConfigurationResponseReceivedHandler; typedef std::function&) > PutObjectRetentionResponseReceivedHandler; typedef std::function&) > PutObjectTaggingResponseReceivedHandler; typedef std::function&) > PutPublicAccessBlockResponseReceivedHandler; typedef std::function&) > RestoreObjectResponseReceivedHandler; typedef std::function&) > SelectObjectContentResponseReceivedHandler; typedef std::function&) > UploadPartResponseReceivedHandler; typedef std::function&) > UploadPartCopyResponseReceivedHandler; // A pair of endpoint and request region. typedef std::pair EndpointRegionPair; typedef Aws::Utils::Outcome> ComputeEndpointOutcome; //max expiration for presigned urls in s3 is 7 days. static const unsigned MAX_EXPIRATION_SECONDS = 7 * 24 * 60 * 60; /** *

*/ enum class US_EAST_1_REGIONAL_ENDPOINT_OPTION { NOT_SET, LEGACY, //stands for using global endpoint for us-east-1, REGIONAL //stands for using regional endpoint for us-east-1 }; class AWS_S3_API S3Client : public Aws::Client::AWSXMLClient { public: typedef Aws::Client::AWSXMLClient BASECLASS; /** * Initializes client to use DefaultCredentialProviderChain, with default http client factory, and optional client config. If client config * is not specified, it will be initialized to default values. */ S3Client(const Aws::Client::ClientConfiguration& clientConfiguration = Aws::Client::ClientConfiguration(), Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy signPayloads = Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy::Never, bool useVirtualAddressing = true, Aws::S3::US_EAST_1_REGIONAL_ENDPOINT_OPTION USEast1RegionalEndPointOption = Aws::S3::US_EAST_1_REGIONAL_ENDPOINT_OPTION::NOT_SET); /** * Initializes client to use SimpleAWSCredentialsProvider, with default http client factory, and optional client config. If client config * is not specified, it will be initialized to default values. */ S3Client(const Aws::Auth::AWSCredentials& credentials, const Aws::Client::ClientConfiguration& clientConfiguration = Aws::Client::ClientConfiguration(), Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy signPayloads = Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy::Never, bool useVirtualAddressing = true, Aws::S3::US_EAST_1_REGIONAL_ENDPOINT_OPTION USEast1RegionalEndPointOption = Aws::S3::US_EAST_1_REGIONAL_ENDPOINT_OPTION::NOT_SET); /** * Initializes client to use specified credentials provider with specified client config. If http client factory is not supplied, * the default http client factory will be used */ S3Client(const std::shared_ptr& credentialsProvider, const Aws::Client::ClientConfiguration& clientConfiguration = Aws::Client::ClientConfiguration(), Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy signPayloads = Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy::Never, bool useVirtualAddressing = true, Aws::S3::US_EAST_1_REGIONAL_ENDPOINT_OPTION USEast1RegionalEndPointOption = Aws::S3::US_EAST_1_REGIONAL_ENDPOINT_OPTION::NOT_SET); virtual ~S3Client(); /** *

This operation aborts a multipart upload. After a multipart upload is * aborted, no additional parts can be uploaded using that upload ID. The storage * consumed by any previously uploaded parts will be freed. However, if any part * uploads are currently in progress, those part uploads might or might not * succeed. As a result, it might be necessary to abort a given multipart upload * multiple times in order to completely free all storage consumed by all parts. *

To verify that all parts have been removed, so you don't get charged for * the part storage, you should call the ListParts operation and ensure that * the parts list is empty.

For information about permissions required to * use the multipart upload API, see Multipart * Upload API and Permissions.

The following operations are related to * AbortMultipartUpload:

* CreateMultipartUpload
UploadPart
CompleteMultipartUpload
ListParts *
ListMultipartUploads

See * Also:

AWS * API Reference

*/ virtual Model::AbortMultipartUploadOutcome AbortMultipartUpload(const Model::AbortMultipartUploadRequest& request) const; /** *

To verify that all parts have been removed, so you don't get charged for * the part storage, you should call the ListParts operation and ensure that * the parts list is empty.

For information about permissions required to * use the multipart upload API, see Multipart * Upload API and Permissions.

The following operations are related to * AbortMultipartUpload:

* CreateMultipartUpload
UploadPart
CompleteMultipartUpload
ListParts *
ListMultipartUploads

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::AbortMultipartUploadOutcomeCallable AbortMultipartUploadCallable(const Model::AbortMultipartUploadRequest& request) const; /** *

To verify that all parts have been removed, so you don't get charged for * the part storage, you should call the ListParts operation and ensure that * the parts list is empty.

For information about permissions required to * use the multipart upload API, see Multipart * Upload API and Permissions.

The following operations are related to * AbortMultipartUpload:

* CreateMultipartUpload
UploadPart
CompleteMultipartUpload
ListParts *
ListMultipartUploads

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void AbortMultipartUploadAsync(const Model::AbortMultipartUploadRequest& request, const AbortMultipartUploadResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

Completes a multipart upload by assembling previously uploaded parts.

You first initiate the multipart upload and then upload all parts using the * UploadPart operation. After successfully uploading all relevant parts of * an upload, you call this operation to complete the upload. Upon receiving this * request, Amazon S3 concatenates all the parts in ascending order by part number * to create a new object. In the Complete Multipart Upload request, you must * provide the parts list. You must ensure that the parts list is complete. This * operation concatenates the parts that you provide in the list. For each part in * the list, you must provide the part number and the ETag value, * returned after that part was uploaded.

Processing of a Complete Multipart * Upload request could take several minutes to complete. After Amazon S3 begins * processing the request, it sends an HTTP response header that specifies a 200 OK * response. While processing is in progress, Amazon S3 periodically sends white * space characters to keep the connection from timing out. Because a request could * fail after the initial 200 OK response has been sent, it is important that you * check the response body to determine whether the request succeeded.

Note * that if CompleteMultipartUpload fails, applications should be * prepared to retry the failed requests. For more information, see Amazon * S3 Error Best Practices.

For more information about multipart * uploads, see Uploading * Objects Using Multipart Upload.

For information about permissions * required to use the multipart upload API, see Multipart * Upload API and Permissions.

CompleteMultipartUpload has * the following special errors:

Error code: * EntityTooSmall
- Description: Your proposed upload * is smaller than the minimum allowed object size. Each part must be at least 5 MB * in size, except the last part.
- 400 Bad Request
*
Error code: InvalidPart
- *
  Description: One or more of the specified parts could not be found. The part * might not have been uploaded, or the specified entity tag might not have matched * the part's entity tag.
- 400 Bad Request
Error code: InvalidPartOrder
- Description: * The list of parts was not in ascending order. The parts list must be specified * in order by part number.
- 400 Bad Request
Error code: NoSuchUpload
- Description: The * specified multipart upload does not exist. The upload ID might be invalid, or * the multipart upload might have been aborted or completed.
- 404 * Not Found

The following operations are related to * CompleteMultipartUpload:

* CreateMultipartUpload
UploadPart
AbortMultipartUpload
ListParts
*
ListMultipartUploads

See * Also:

AWS * API Reference

*/ virtual Model::DeleteBucketCorsOutcome DeleteBucketCors(const Model::DeleteBucketCorsRequest& request) const; /** *

Deletes the cors configuration information set for the * bucket.

To use this operation, you must have permission to perform the * s3:PutBucketCORS action. The bucket owner has this permission by * default and can grant this permission to others.

For information about * cors, see Enabling * Cross-Origin Resource Sharing in the Amazon Simple Storage Service * Developer Guide.

Related Resources:

RESTOPTIONSobject

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::DeleteBucketCorsOutcomeCallable DeleteBucketCorsCallable(const Model::DeleteBucketCorsRequest& request) const; /** *

Deletes the cors configuration information set for the * bucket.

To use this operation, you must have permission to perform the * s3:PutBucketCORS action. The bucket owner has this permission by * default and can grant this permission to others.

For information about * cors, see Enabling * Cross-Origin Resource Sharing in the Amazon Simple Storage Service * Developer Guide.

Related Resources:

RESTOPTIONSobject

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void DeleteBucketCorsAsync(const Model::DeleteBucketCorsRequest& request, const DeleteBucketCorsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

This implementation of the DELETE operation removes default encryption from * the bucket. For information about the Amazon S3 default encryption feature, see * Amazon * S3 Default Bucket Encryption in the Amazon Simple Storage Service * Developer Guide.

To use this operation, you must have permissions to * perform the s3:PutEncryptionConfiguration action. The bucket owner * has this permission by default. The bucket owner can grant this permission to * others. For more information about permissions, see Permissions * Related to Bucket Subresource Operations and Managing * Access Permissions to your Amazon S3 Resources in the Amazon Simple * Storage Service Developer Guide.

Related * Resources

PutBucketEncryption
* GetBucketEncryption

See * Also:

AWS * API Reference

*/ virtual Model::DeleteObjectsOutcome DeleteObjects(const Model::DeleteObjectsRequest& request) const; /** *

Finally, the Content-MD5 header is required for all * Multi-Object Delete requests. Amazon S3 uses the header value to ensure that * your request body has not been altered in transit.

The following * operations are related to DeleteObjects:

* CreateMultipartUpload
UploadPart
CompleteMultipartUpload
ListParts *
AbortMultipartUpload

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::DeleteObjectsOutcomeCallable DeleteObjectsCallable(const Model::DeleteObjectsRequest& request) const; /** *

Finally, the Content-MD5 header is required for all * Multi-Object Delete requests. Amazon S3 uses the header value to ensure that * your request body has not been altered in transit.

The following * operations are related to DeleteObjects:

* CreateMultipartUpload
UploadPart
CompleteMultipartUpload
ListParts *
AbortMultipartUpload

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void DeleteObjectsAsync(const Model::DeleteObjectsRequest& request, const DeleteObjectsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

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:

*
Using * Amazon S3 Block Public Access
* GetPublicAccessBlock
PutPublicAccessBlock
*
GetBucketPolicyStatus

See * Also:

AWS * API Reference

*/ virtual Model::DeletePublicAccessBlockOutcome DeletePublicAccessBlock(const Model::DeletePublicAccessBlockRequest& request) const; /** *

The following * operations are related to DeletePublicAccessBlock:

*
Using * Amazon S3 Block Public Access
* GetPublicAccessBlock
PutPublicAccessBlock
*
GetBucketPolicyStatus

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::DeletePublicAccessBlockOutcomeCallable DeletePublicAccessBlockCallable(const Model::DeletePublicAccessBlockRequest& request) const; /** *

The following * operations are related to DeletePublicAccessBlock:

*
Using * Amazon S3 Block Public Access
* GetPublicAccessBlock
PutPublicAccessBlock
*
GetBucketPolicyStatus

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void DeletePublicAccessBlockAsync(const Model::DeletePublicAccessBlockRequest& request, const DeletePublicAccessBlockResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

This implementation of the GET operation uses the accelerate * subresource to return the Transfer Acceleration state of a bucket, which is * either Enabled or Suspended. Amazon S3 Transfer * Acceleration is a bucket-level feature that enables you to perform faster data * transfers to and from Amazon S3.

To use this operation, you must have * permission to perform the s3:GetAccelerateConfiguration action. The * bucket owner has this permission by default. The bucket owner can grant this * permission to others. For more information about permissions, see Permissions * Related to Bucket Subresource Operations and Managing * Access Permissions to your Amazon S3 Resources in the Amazon Simple * Storage Service Developer Guide.

You set the Transfer Acceleration * state of an existing bucket to Enabled or Suspended by * using the PutBucketAccelerateConfiguration operation.

A GET * accelerate request does not return a state value for a bucket that * has no transfer acceleration state. A bucket has no Transfer Acceleration state * if a state has never been set on the bucket.

For more information about * transfer acceleration, see Transfer * Acceleration in the Amazon Simple Storage Service Developer Guide.

Related Resources

* PutBucketAccelerateConfiguration

See * Also:

AWS * API Reference

*/ virtual Model::GetBucketAnalyticsConfigurationOutcome GetBucketAnalyticsConfiguration(const Model::GetBucketAnalyticsConfigurationRequest& request) const; /** *

This implementation of the GET operation returns an analytics configuration * (identified by the analytics configuration ID) from the bucket.

For information about Amazon S3 * analytics feature, see Amazon * S3 Analytics – Storage Class Analysis in the Amazon Simple Storage * Service Developer Guide.

Related Resources

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::GetBucketAnalyticsConfigurationOutcomeCallable GetBucketAnalyticsConfigurationCallable(const Model::GetBucketAnalyticsConfigurationRequest& request) const; /** *

This implementation of the GET operation returns an analytics configuration * (identified by the analytics configuration ID) from the bucket.

For information about Amazon S3 * analytics feature, see Amazon * S3 Analytics – Storage Class Analysis in the Amazon Simple Storage * Service Developer Guide.

Related Resources

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void GetBucketAnalyticsConfigurationAsync(const Model::GetBucketAnalyticsConfigurationRequest& request, const GetBucketAnalyticsConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

Returns the cors configuration information set for the bucket.

To use * this operation, you must have permission to perform the s3:GetBucketCORS action. * By default, the bucket owner has this permission and can grant it to others.

For more information about cors, see Enabling * Cross-Origin Resource Sharing.

The following operations are related * to GetBucketCors:

PutBucketCors
DeleteBucketCors

See * Also:

AWS * API Reference

*/ virtual Model::GetBucketLifecycleConfigurationOutcome GetBucketLifecycleConfiguration(const Model::GetBucketLifecycleConfigurationRequest& request) const; /** *

Returns the lifecycle * configuration information set on the bucket. For information about lifecycle * configuration, see Object * Lifecycle Management.

* GetBucketLifecycleConfiguration has the following special * error:

Error code: NoSuchLifecycleConfiguration *
- Description: The lifecycle configuration does not exist.
  *
- HTTP Status Code: 404 Not Found
- SOAP Fault Code * Prefix: Client

The following operations are * related to GetBucketLifecycleConfiguration:

* GetBucketLifecycle
PutBucketLifecycle
*
DeleteBucketLifecycle

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::GetBucketLifecycleConfigurationOutcomeCallable GetBucketLifecycleConfigurationCallable(const Model::GetBucketLifecycleConfigurationRequest& request) const; /** *

Returns the lifecycle * configuration information set on the bucket. For information about lifecycle * configuration, see Object * Lifecycle Management.

* GetBucketLifecycleConfiguration has the following special * error:

Error code: NoSuchLifecycleConfiguration *
- Description: The lifecycle configuration does not exist.
  *
- HTTP Status Code: 404 Not Found
- SOAP Fault Code * Prefix: Client

The following operations are * related to GetBucketLifecycleConfiguration:

* GetBucketLifecycle
PutBucketLifecycle
*
DeleteBucketLifecycle

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void GetBucketLifecycleConfigurationAsync(const Model::GetBucketLifecycleConfigurationRequest& request, const GetBucketLifecycleConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

Returns the Region the bucket resides in. You set the bucket's Region using * the LocationConstraint request parameter in a * CreateBucket request. For more information, see * CreateBucket.

To use this implementation of the operation, you * must be the bucket owner.

The following operations are related to * GetBucketLocation:

GetObject
CreateBucket

See * Also:

AWS * API Reference

*/ virtual Model::GetBucketPolicyStatusOutcome GetBucketPolicyStatus(const Model::GetBucketPolicyStatusRequest& request) const; /** *

For more information about when Amazon S3 * considers a bucket public, see The * Meaning of "Public".

The following operations are related to * GetBucketPolicyStatus:

Using * Amazon S3 Block Public Access
* GetPublicAccessBlock
PutPublicAccessBlock
*
DeletePublicAccessBlock

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::GetBucketPolicyStatusOutcomeCallable GetBucketPolicyStatusCallable(const Model::GetBucketPolicyStatusRequest& request) const; /** *

For more information about when Amazon S3 * considers a bucket public, see The * Meaning of "Public".

The following operations are related to * GetBucketPolicyStatus:

Using * Amazon S3 Block Public Access
* GetPublicAccessBlock
PutPublicAccessBlock
*
DeletePublicAccessBlock

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void GetBucketPolicyStatusAsync(const Model::GetBucketPolicyStatusRequest& request, const GetBucketPolicyStatusResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

Returns the replication configuration of a bucket.

It can take * a while to propagate the put or delete a replication configuration to all Amazon * S3 systems. Therefore, a get request soon after put or delete can return a wrong * result.

For information about replication configuration, see Replication * in the Amazon Simple Storage Service Developer Guide.

This * operation requires permissions for the * s3:GetReplicationConfiguration action. For more information about * permissions, see Using * Bucket Policies and User Policies.

If you include the * Filter element in a replication configuration, you must also * include the DeleteMarkerReplication and Priority * elements. The response also returns those elements.

For information about * GetBucketReplication errors, see ReplicationErrorCodeList *

The following operations are related to * GetBucketReplication:

PutBucketReplication *
DeleteBucketReplication

See * Also:

AWS * API Reference

*/ virtual Model::GetBucketReplicationOutcome GetBucketReplication(const Model::GetBucketReplicationRequest& request) const; /** *

Returns the replication configuration of a bucket.

It can take * a while to propagate the put or delete a replication configuration to all Amazon * S3 systems. Therefore, a get request soon after put or delete can return a wrong * result.

For information about replication configuration, see Replication * in the Amazon Simple Storage Service Developer Guide.

This * operation requires permissions for the * s3:GetReplicationConfiguration action. For more information about * permissions, see Using * Bucket Policies and User Policies.

If you include the * Filter element in a replication configuration, you must also * include the DeleteMarkerReplication and Priority * elements. The response also returns those elements.

For information about * GetBucketReplication errors, see ReplicationErrorCodeList *

The following operations are related to * GetBucketReplication:

PutBucketReplication *
DeleteBucketReplication

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::GetBucketReplicationOutcomeCallable GetBucketReplicationCallable(const Model::GetBucketReplicationRequest& request) const; /** *

Returns the replication configuration of a bucket.

It can take * a while to propagate the put or delete a replication configuration to all Amazon * S3 systems. Therefore, a get request soon after put or delete can return a wrong * result.

For information about replication configuration, see Replication * in the Amazon Simple Storage Service Developer Guide.

This * operation requires permissions for the * s3:GetReplicationConfiguration action. For more information about * permissions, see Using * Bucket Policies and User Policies.

If you include the * Filter element in a replication configuration, you must also * include the DeleteMarkerReplication and Priority * elements. The response also returns those elements.

For information about * GetBucketReplication errors, see ReplicationErrorCodeList *

The following operations are related to * GetBucketReplication:

PutBucketReplication *
DeleteBucketReplication

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void GetBucketReplicationAsync(const Model::GetBucketReplicationRequest& request, const GetBucketReplicationResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

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:

ListObjects
*

See * Also:

AWS * API Reference

*/ virtual Model::GetPublicAccessBlockOutcome GetPublicAccessBlock(const Model::GetPublicAccessBlockRequest& request) const; /** *

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:

Using * Amazon S3 Block Public Access
* PutPublicAccessBlock
GetPublicAccessBlock
*
DeletePublicAccessBlock

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::GetPublicAccessBlockOutcomeCallable GetPublicAccessBlockCallable(const Model::GetPublicAccessBlockRequest& request) const; /** *

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:

Using * Amazon S3 Block Public Access
* PutPublicAccessBlock
GetPublicAccessBlock
*
DeletePublicAccessBlock

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void GetPublicAccessBlockAsync(const Model::GetPublicAccessBlockRequest& request, const GetPublicAccessBlockResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

This operation is useful to determine if a bucket exists and you have * permission to access it. The operation returns a 200 OK if the * bucket exists and you have permission to access it. Otherwise, the operation * might return responses such as 404 Not Found and 403 * Forbidden.

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

See * Also:

AWS * API Reference

*/ virtual Model::ListMultipartUploadsOutcome ListMultipartUploads(const Model::ListMultipartUploadsRequest& request) const; /** *

For more information on multipart * uploads, see Uploading * Objects Using Multipart Upload.

For information on permissions * required to use the multipart upload API, see Multipart * Upload API and Permissions.

The following operations are related to * ListMultipartUploads:

* CreateMultipartUpload
UploadPart
CompleteMultipartUpload
ListParts *
AbortMultipartUpload

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::ListMultipartUploadsOutcomeCallable ListMultipartUploadsCallable(const Model::ListMultipartUploadsRequest& request) const; /** *

For more information on multipart * uploads, see Uploading * Objects Using Multipart Upload.

For information on permissions * required to use the multipart upload API, see Multipart * Upload API and Permissions.

The following operations are related to * ListMultipartUploads:

* CreateMultipartUpload
UploadPart
CompleteMultipartUpload
ListParts *
AbortMultipartUpload

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void ListMultipartUploadsAsync(const Model::ListMultipartUploadsRequest& request, const ListMultipartUploadsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

Returns metadata about all of the versions of objects in a bucket. You can * also use request parameters as selection criteria to return metadata about a * subset of all the object versions.

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:

* ListObjectsV2
GetObject
* PutObject
DeleteObject

See * Also:

AWS API * Reference

*/ virtual Model::ListPartsOutcome ListParts(const Model::ListPartsRequest& request) const; /** *

For more information on multipart uploads, see Uploading * Objects Using Multipart Upload.

For information on permissions * required to use the multipart upload API, see Multipart * Upload API and Permissions.

The following operations are related to * ListParts:

CreateMultipartUpload
*
UploadPart
* CompleteMultipartUpload
AbortMultipartUpload *
ListMultipartUploads

See * Also:

AWS API * Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::ListPartsOutcomeCallable ListPartsCallable(const Model::ListPartsRequest& request) const; /** *

For more information on multipart uploads, see Uploading * Objects Using Multipart Upload.

For information on permissions * required to use the multipart upload API, see Multipart * Upload API and Permissions.

The following operations are related to * ListParts:

CreateMultipartUpload
*
UploadPart
* CompleteMultipartUpload
AbortMultipartUpload *
ListMultipartUploads

See * Also:

AWS API * Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void ListPartsAsync(const Model::ListPartsRequest& request, const ListPartsResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

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:

Enabled – Enables accelerated data transfers to the * bucket.
Suspended – Disables accelerated data transfers to * the bucket.

The GetBucketAccelerateConfiguration * operation 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:

* GetBucketAccelerateConfiguration
CreateBucket *

See * Also:

AWS * API Reference

*/ virtual Model::PutBucketLoggingOutcome PutBucketLogging(const Model::PutBucketLoggingRequest& request) const; /** *

Grantee * Values

You can specify the person (grantee) to whom you're assigning * access rights (using request elements) in the following ways:

*
By the person's ID:

<Grantee * xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" * xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> * </Grantee>

DisplayName is optional and ignored in the * request.
By Email address:

<Grantee * xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" * xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> *

The grantee is resolved to the CanonicalUser and, in a response to a GET * Object acl request, appears as the CanonicalUser.
By URI:
*
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" * xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> *

To enable logging, you use LoggingEnabled and its children * request elements. To disable logging, you use an empty BucketLoggingStatus * request element:

<BucketLoggingStatus * xmlns="http://doc.s3.amazonaws.com/2006-03-01" />

For more * information about server access logging, see Server * Access Logging.

For more information about creating a bucket, see * CreateBucket. For more information about returning the logging status of * a bucket, see GetBucketLogging.

The following operations are * related to PutBucketLogging:

PutObject *
DeleteBucket
CreateBucket *
GetBucketLogging

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::PutBucketLoggingOutcomeCallable PutBucketLoggingCallable(const Model::PutBucketLoggingRequest& request) const; /** *

Grantee * Values

You can specify the person (grantee) to whom you're assigning * access rights (using request elements) in the following ways:

*
By the person's ID:

<Grantee * xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" * xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> * </Grantee>

DisplayName is optional and ignored in the * request.
By Email address:

<Grantee * xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" * xsi:type="AmazonCustomerByEmail"><EmailAddress><>Grantees@email.com<></EmailAddress></Grantee> *

The grantee is resolved to the CanonicalUser and, in a response to a GET * Object acl request, appears as the CanonicalUser.
By URI:
*
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" * xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee> *

To enable logging, you use LoggingEnabled and its children * request elements. To disable logging, you use an empty BucketLoggingStatus * request element:

<BucketLoggingStatus * xmlns="http://doc.s3.amazonaws.com/2006-03-01" />

For more * information about server access logging, see Server * Access Logging.

For more information about creating a bucket, see * CreateBucket. For more information about returning the logging status of * a bucket, see GetBucketLogging.

The following operations are * related to PutBucketLogging:

PutObject *
DeleteBucket
CreateBucket *
GetBucketLogging

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void PutBucketLoggingAsync(const Model::PutBucketLoggingRequest& request, const PutBucketLoggingResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

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.

For information about * CloudWatch request metrics for Amazon S3, see Monitoring * Metrics with Amazon CloudWatch.

The following operations are related * to PutBucketMetricsConfiguration:

* DeleteBucketMetricsConfiguration
* PutBucketMetricsConfiguration
* ListBucketMetricsConfigurations

* GetBucketLifecycle has the following special error:

*
Error code: TooManyConfigurations
- Description: * You are attempting to create a new configuration but have already reached the * 1,000-configuration limit.
- HTTP Status Code: HTTP 400 Bad * Request

See * Also:

AWS * API Reference

*/ virtual Model::PutBucketReplicationOutcome PutBucketReplication(const Model::PutBucketReplicationRequest& request) const; /** *

Creates a replication configuration or replaces an existing one. For more * information, see Replication * in the Amazon S3 Developer Guide.

To perform this * operation, the user or role performing the operation must have the iam:PassRole * permission.

For information about enabling versioning on a * bucket, see Using * Versioning.

Handling * Replication of Encrypted Objects

For * information on PutBucketReplication errors, see * ReplicationErrorCodeList

The following operations are related to * PutBucketReplication:

GetBucketReplication *
DeleteBucketReplication

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::PutBucketReplicationOutcomeCallable PutBucketReplicationCallable(const Model::PutBucketReplicationRequest& request) const; /** *

Creates a replication configuration or replaces an existing one. For more * information, see Replication * in the Amazon S3 Developer Guide.

To perform this * operation, the user or role performing the operation must have the iam:PassRole * permission.

For information about enabling versioning on a * bucket, see Using * Versioning.

Handling * Replication of Encrypted Objects

For * information on PutBucketReplication errors, see * ReplicationErrorCodeList

The following operations are related to * PutBucketReplication:

GetBucketReplication *
DeleteBucketReplication

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void PutBucketReplicationAsync(const Model::PutBucketReplicationRequest& request, const PutBucketReplicationResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

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:

CreateBucket
*
GetBucketRequestPayment

See * Also:

AWS * API Reference

*/ virtual Model::PutBucketRequestPaymentOutcome PutBucketRequestPayment(const Model::PutBucketRequestPaymentRequest& request) const; /** *

The following operations are related to * PutBucketRequestPayment:

CreateBucket
*
GetBucketRequestPayment

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::PutBucketRequestPaymentOutcomeCallable PutBucketRequestPaymentCallable(const Model::PutBucketRequestPaymentRequest& request) const; /** *

The following operations are related to * PutBucketRequestPayment:

CreateBucket
*
GetBucketRequestPayment

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void PutBucketRequestPaymentAsync(const Model::PutBucketRequestPaymentRequest& request, const PutBucketRequestPaymentResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

Sets the tags for a bucket.

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

Within a bucket, if you add a tag that * has the same key as an existing tag, the new value overwrites the old value. For * more information, see Using * Cost Allocation in Amazon S3 Bucket Tags.

To use this * 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:

*
Error code: InvalidTagError
- Description: The * tag provided was not a valid tag. This error can occur if the tag did not pass * input validation. For information about tag restrictions, see User-Defined * Tag Restrictions and AWS-Generated * Cost Allocation Tag Restrictions.
Error code: * MalformedXMLError
- Description: The XML provided * does not match the schema.
Error code: * OperationAbortedError
- Description: A conflicting * conditional operation is currently in progress against this resource. Please try * again.
Error code: InternalError
*
- Description: The service was unable to apply the provided tag to * the bucket.

The following operations are related * to PutBucketTagging:

GetBucketTagging
*
DeleteBucketTagging

See * Also:

AWS * API Reference

*/ virtual Model::PutBucketVersioningOutcome PutBucketVersioning(const Model::PutBucketVersioningRequest& request) const; /** *

Sets the versioning state of an existing bucket. To set the versioning state, * you must be the bucket owner.

You can set the versioning state with one * of the following values:

Enabled—Enables versioning for the * objects in the bucket. All objects added to the bucket receive a unique version * ID.

Suspended—Disables versioning for the objects in the bucket. * All objects added to the bucket receive the version ID null.

If the * versioning state has never been set on a bucket, it has no versioning state; a * GetBucketVersioning request does not return a versioning state value.

Related Resources *

CreateBucket
DeleteBucket *
GetBucketVersioning

See * Also:

AWS * API Reference

* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::PutBucketVersioningOutcomeCallable PutBucketVersioningCallable(const Model::PutBucketVersioningRequest& request) const; /** *

Sets the versioning state of an existing bucket. To set the versioning state, * you must be the bucket owner.

You can set the versioning state with one * of the following values:

Enabled—Enables versioning for the * objects in the bucket. All objects added to the bucket receive a unique version * ID.

Suspended—Disables versioning for the objects in the bucket. * All objects added to the bucket receive the version ID null.

If the * versioning state has never been set on a bucket, it has no versioning state; a * GetBucketVersioning request does not return a versioning state value.

Related Resources *

CreateBucket
DeleteBucket *
GetBucketVersioning

See * Also:

AWS * API Reference

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void PutBucketVersioningAsync(const Model::PutBucketVersioningRequest& request, const PutBucketVersioningResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

Sets the configuration of the website that is specified in the * website subresource. To configure a bucket as a website, you can * add this subresource on the bucket with website configuration information such * as the file name of the index document and any redirect rules. For more * information, see Hosting * Websites on Amazon S3.

This PUT operation requires the * S3:PutBucketWebsite permission. By default, only the bucket owner * can configure the website attached to a bucket; however, bucket owners can allow * other users to set the website configuration by writing a bucket policy that * grants them the S3:PutBucketWebsite permission.

To redirect * all website requests sent to the bucket's website endpoint, you add a website * configuration with the following elements. Because all requests are sent to * another website, you don't need to provide index document name for the * bucket.

WebsiteConfiguration
* RedirectAllRequestsTo
HostName *
Protocol

If you want * granular control over redirects, you can use the following elements to add * routing rules that describe conditions for redirecting requests and information * about the redirect destination. In this case, the website configuration must * provide an index document for the bucket, because some requests might not be * redirected.

WebsiteConfiguration
*
IndexDocument
Suffix
*
ErrorDocument
Key *
RoutingRules
* RoutingRule
Condition
HttpErrorCodeReturnedEquals
* KeyPrefixEquals
Redirect
*
Protocol
HostName *
ReplaceKeyPrefixWith
* ReplaceKeyWith
HttpRedirectCode *

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 Simple Storage Service Developer * Guide.

* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void PutObjectRetentionAsync(const Model::PutObjectRetentionRequest& request, const PutObjectRetentionResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *

Sets the supplied tag-set to an object that already exists in a bucket.

A tag is a key-value pair. 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.

For information about the Amazon S3 object tagging feature, see Object * Tagging.

Special Errors

Code: InvalidTagError

*

Cause: The tag provided was not a valid tag. This error can occur if * the tag did not pass input validation. For more information, see Object * Tagging.

*

Code: MalformedXMLError

Cause: The XML * provided does not match the schema.

*
Code: OperationAbortedError

Cause: A * conflicting conditional operation is currently in progress against this * resource. Please try again.

* Code: InternalError

Cause: The service was unable * to apply the provided tag to the object.

Related Resources

* GetObjectTagging

See Also:
AWS * API Reference
*/ virtual Model::PutObjectTaggingOutcome PutObjectTagging(const Model::PutObjectTaggingRequest& request) const; /** *
Sets the supplied tag-set to an object that already exists in a bucket.
*
A tag is a key-value pair. 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.
*
For information about the Amazon S3 object tagging feature, see Object * Tagging.

Special Errors

Code: InvalidTagError

*

Cause: The tag provided was not a valid tag. This error can occur if * the tag did not pass input validation. For more information, see Object * Tagging.

*

Code: MalformedXMLError

Cause: The XML * provided does not match the schema.

*
Code: OperationAbortedError

Cause: A * conflicting conditional operation is currently in progress against this * resource. Please try again.

* Code: InternalError

Cause: The service was unable * to apply the provided tag to the object.

Related Resources

* GetObjectTagging

See Also:
AWS * API Reference
* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::PutObjectTaggingOutcomeCallable PutObjectTaggingCallable(const Model::PutObjectTaggingRequest& request) const; /** *
Sets the supplied tag-set to an object that already exists in a bucket.
*
A tag is a key-value pair. 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.
*
For information about the Amazon S3 object tagging feature, see Object * Tagging.

Special Errors

Code: InvalidTagError

*

Cause: The tag provided was not a valid tag. This error can occur if * the tag did not pass input validation. For more information, see Object * Tagging.

*

Code: MalformedXMLError

Cause: The XML * provided does not match the schema.

*
Code: OperationAbortedError

Cause: A * conflicting conditional operation is currently in progress against this * resource. Please try again.

* Code: InternalError

Cause: The service was unable * to apply the provided tag to the object.

Related Resources

* GetObjectTagging

See Also:
AWS * API Reference
* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void PutObjectTaggingAsync(const Model::PutObjectTaggingRequest& request, const PutObjectTaggingResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *
Creates or modifies the PublicAccessBlock configuration for an * Amazon S3 bucket. To use this operation, you must have the * s3:PutBucketPublicAccessBlock permission. For more information * about Amazon S3 permissions, see Specifying * Permissions in a Policy.

When Amazon S3 evaluates the * PublicAccessBlock configuration for a bucket or an object, it * checks the PublicAccessBlock configuration for both the bucket (or * the bucket that contains the object) and the bucket owner's account. If the * PublicAccessBlock configurations are different between the bucket * and the account, Amazon S3 uses the most restrictive combination of the * bucket-level and account-level settings.

For more * information about when Amazon S3 considers a bucket or an object public, see The * Meaning of "Public".

Related Resources
*

GetPublicAccessBlock

* DeletePublicAccessBlock

GetBucketPolicyStatus *

Using * Amazon S3 Block Public Access

See Also:
AWS * API Reference
*/ virtual Model::PutPublicAccessBlockOutcome PutPublicAccessBlock(const Model::PutPublicAccessBlockRequest& request) const; /** *
Creates or modifies the PublicAccessBlock configuration for an * Amazon S3 bucket. To use this operation, you must have the * s3:PutBucketPublicAccessBlock permission. For more information * about Amazon S3 permissions, see Specifying * Permissions in a Policy.

When Amazon S3 evaluates the * PublicAccessBlock configuration for a bucket or an object, it * checks the PublicAccessBlock configuration for both the bucket (or * the bucket that contains the object) and the bucket owner's account. If the * PublicAccessBlock configurations are different between the bucket * and the account, Amazon S3 uses the most restrictive combination of the * bucket-level and account-level settings.

For more * information about when Amazon S3 considers a bucket or an object public, see The * Meaning of "Public".

Related Resources
*

GetPublicAccessBlock

* DeletePublicAccessBlock

GetBucketPolicyStatus *

Using * Amazon S3 Block Public Access

See Also:
AWS * API Reference
* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::PutPublicAccessBlockOutcomeCallable PutPublicAccessBlockCallable(const Model::PutPublicAccessBlockRequest& request) const; /** *
Creates or modifies the PublicAccessBlock configuration for an * Amazon S3 bucket. To use this operation, you must have the * s3:PutBucketPublicAccessBlock permission. For more information * about Amazon S3 permissions, see Specifying * Permissions in a Policy.

When Amazon S3 evaluates the * PublicAccessBlock configuration for a bucket or an object, it * checks the PublicAccessBlock configuration for both the bucket (or * the bucket that contains the object) and the bucket owner's account. If the * PublicAccessBlock configurations are different between the bucket * and the account, Amazon S3 uses the most restrictive combination of the * bucket-level and account-level settings.

For more * information about when Amazon S3 considers a bucket or an object public, see The * Meaning of "Public".

Related Resources
*

GetPublicAccessBlock

* DeletePublicAccessBlock

GetBucketPolicyStatus *

Using * Amazon S3 Block Public Access

See Also:
AWS * API Reference
* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void PutPublicAccessBlockAsync(const Model::PutPublicAccessBlockRequest& request, const PutPublicAccessBlockResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *
Restores an archived copy of an object back into Amazon S3

This * operation performs the following types of requests:

* select - Perform a select query on an archived object

*

restore an archive - Restore an archived object

*

To use this operation, you must have permissions to perform the * s3:RestoreObject 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 Simple * Storage Service Developer Guide.

Querying Archives with Select * Requests

You use a select type of request to perform SQL queries on * archived objects. The archived objects that are being queried by the select * request must be formatted as uncompressed comma-separated values (CSV) files. * You can run queries and custom analytics on your archived data without having to * restore your data to a hotter Amazon S3 tier. For an overview about select * requests, see Querying * Archived Objects in the Amazon Simple Storage Service Developer * Guide.

When making a select request, do the following:

*
Define an output location for the select query's output. This must be an * Amazon S3 bucket in the same AWS Region as the bucket that contains the archive * object that is being queried. The AWS account that initiates the job must have * permissions to write to the S3 bucket. You can specify the storage class and * encryption for the output objects stored in the bucket. For more information * about output, see Querying * Archived Objects in the Amazon Simple Storage Service Developer * Guide.

For more information about the S3 structure in * the request body, see the following:

PutObject
*

Managing * Access with ACLs in the Amazon Simple Storage Service Developer Guide *

Protecting * Data Using Server-Side Encryption in the Amazon Simple Storage Service * Developer Guide

Define the SQL expression for * the SELECT type of restoration for your query in the request body's * SelectParameters structure. You can use expressions like the * following examples.

The following expression returns all * records from the specified object.

SELECT * FROM Object *

Assuming that you are not using any headers for data stored * in the object, you can specify columns with positional headers.

* SELECT s._1, s._2 FROM Object s WHERE s._3 > 100

*
If you have headers and you set the fileHeaderInfo in the * CSV structure in the request body to USE, you can * specify headers in the query. (If you set the fileHeaderInfo field * to IGNORE, the first row is skipped for the query.) You cannot mix * ordinal positions with header column names.

SELECT s.Id, * s.FirstName, s.SSN FROM S3Object s

For * more information about using SQL with S3 Glacier Select restore, see SQL * Reference for Amazon S3 Select and S3 Glacier Select in the Amazon Simple * Storage Service Developer Guide.

When making a select request, you * can also do the following:

To expedite your queries, specify * the Expedited tier. For more information about tiers, see * "Restoring Archives," later in this topic.

Specify details * about the data serialization format of both the input object that is being * queried and the serialization of the CSV-encoded query results.

*
The following are additional important facts about the select feature:
*

The output results are new Amazon S3 objects. Unlike archive * retrievals, they are stored until explicitly deleted-manually or through a * lifecycle policy.

You can issue more than one select request * on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid * issuing duplicate requests.

Amazon S3 accepts a select * request even if the object has already been restored. A select request doesn’t * return error response 409.

Restoring * Archives

Objects in the GLACIER and DEEP_ARCHIVE storage classes are * archived. To access an archived object, you must first initiate a restore * request. This restores a temporary copy of the archived object. In a restore * request, you specify the number of days that you want the restored copy to * exist. After the specified period, Amazon S3 deletes the temporary copy but the * object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object * was restored from.

To restore a specific object version, you can provide * a version ID. If you don't provide a version ID, Amazon S3 restores the current * version.

The time it takes restore jobs to finish depends on which * storage class the object is being restored from and which data access tier you * specify.

When restoring an archived object (or using a select request), * you can specify one of the following data access tier options in the * Tier element of the request body:

* Expedited - Expedited retrievals allow you to quickly access * your data stored in the GLACIER storage class when occasional urgent requests * for a subset of archives are required. For all but the largest archived objects * (250 MB+), data accessed using Expedited retrievals are typically made available * within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for * Expedited retrievals is available when you need it. Expedited retrievals and * provisioned capacity are not available for the DEEP_ARCHIVE storage class.
*

Standard - S3 Standard retrievals allow you * to access any of your archived objects within several hours. This is the default * option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify * the retrieval option. S3 Standard retrievals typically complete within 3-5 hours * from the GLACIER storage class and typically complete within 12 hours from the * DEEP_ARCHIVE storage class.

Bulk - * Bulk retrievals are Amazon S3 Glacier’s lowest-cost retrieval option, enabling * you to retrieve large amounts, even petabytes, of data inexpensively in a day. * Bulk retrievals typically complete within 5-12 hours from the GLACIER storage * class and typically complete within 48 hours from the DEEP_ARCHIVE storage * class.

For more information about archive retrieval options * and provisioned capacity for Expedited data access, see Restoring * Archived Objects in the Amazon Simple Storage Service Developer * Guide.

You can use Amazon S3 restore speed upgrade to change the * restore speed to a faster speed while it is in progress. You upgrade the speed * of an in-progress restoration by issuing another restore request to the same * object, setting a new Tier request element. When issuing a request * to upgrade the restore tier, you must choose a tier that is faster than the tier * that the in-progress restore is using. You must not change any other parameters, * such as the Days request element. For more information, see * Upgrading the Speed of an In-Progress Restore in the Amazon Simple * Storage Service Developer Guide.

To get the status of object * restoration, you can send a HEAD request. Operations return the * x-amz-restore header, which provides information about the * restoration status, in the response. You can use Amazon S3 event notifications * to notify you when a restore is initiated or completed. For more information, * see Configuring * Amazon S3 Event Notifications in the Amazon Simple Storage Service * Developer Guide.

After restoring an archived object, you can update * the restoration period by reissuing the request with a new period. Amazon S3 * updates the restoration period relative to the current time and charges only for * the request-there are no data transfer charges. You cannot update the * restoration period when Amazon S3 is actively processing your current restore * request for the object.

If your bucket has a lifecycle configuration with * a rule that includes an expiration action, the object expiration overrides the * life span that you specify in a restore request. For example, if you restore an * object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon * S3 deletes the object in 3 days. For more information about lifecycle * configuration, see PutBucketLifecycleConfiguration and Object * Lifecycle Management in Amazon Simple Storage Service Developer * Guide.

Responses

A successful operation returns * either the 200 OK or 202 Accepted status code.
*

If the object copy is not previously restored, then Amazon S3 * returns 202 Accepted in the response.

If the * object copy is previously restored, Amazon S3 returns 200 OK in the * response.

Special Errors

*

Code: * RestoreAlreadyInProgress

Cause: Object restore is * already in progress. (This error does not apply to SELECT type requests.) *

HTTP Status Code: 409 Conflict

* SOAP Fault Code Prefix: Client

Code: * GlacierExpeditedRetrievalNotAvailable

Cause: S3 * Glacier expedited retrievals are currently not available. Try again later. * (Returned if there is insufficient capacity to process the Expedited request. * This error applies only to Expedited retrievals and not to S3 Standard or Bulk * retrievals.)

HTTP Status Code: 503

*

SOAP Fault Code Prefix: N/A

Related Resources

* PutBucketLifecycleConfiguration

* GetBucketNotificationConfiguration

SQL * Reference for Amazon S3 Select and S3 Glacier Select in the Amazon * Simple Storage Service Developer Guide

See Also:
* AWS * API Reference
*/ virtual Model::RestoreObjectOutcome RestoreObject(const Model::RestoreObjectRequest& request) const; /** *
Restores an archived copy of an object back into Amazon S3

This * operation performs the following types of requests:

* select - Perform a select query on an archived object

*

restore an archive - Restore an archived object

*

To use this operation, you must have permissions to perform the * s3:RestoreObject 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 Simple * Storage Service Developer Guide.

Querying Archives with Select * Requests

You use a select type of request to perform SQL queries on * archived objects. The archived objects that are being queried by the select * request must be formatted as uncompressed comma-separated values (CSV) files. * You can run queries and custom analytics on your archived data without having to * restore your data to a hotter Amazon S3 tier. For an overview about select * requests, see Querying * Archived Objects in the Amazon Simple Storage Service Developer * Guide.

When making a select request, do the following:

*
Define an output location for the select query's output. This must be an * Amazon S3 bucket in the same AWS Region as the bucket that contains the archive * object that is being queried. The AWS account that initiates the job must have * permissions to write to the S3 bucket. You can specify the storage class and * encryption for the output objects stored in the bucket. For more information * about output, see Querying * Archived Objects in the Amazon Simple Storage Service Developer * Guide.

For more information about the S3 structure in * the request body, see the following:

PutObject
*

Managing * Access with ACLs in the Amazon Simple Storage Service Developer Guide *

Protecting * Data Using Server-Side Encryption in the Amazon Simple Storage Service * Developer Guide

Define the SQL expression for * the SELECT type of restoration for your query in the request body's * SelectParameters structure. You can use expressions like the * following examples.

The following expression returns all * records from the specified object.

SELECT * FROM Object *

Assuming that you are not using any headers for data stored * in the object, you can specify columns with positional headers.

* SELECT s._1, s._2 FROM Object s WHERE s._3 > 100

*
If you have headers and you set the fileHeaderInfo in the * CSV structure in the request body to USE, you can * specify headers in the query. (If you set the fileHeaderInfo field * to IGNORE, the first row is skipped for the query.) You cannot mix * ordinal positions with header column names.

SELECT s.Id, * s.FirstName, s.SSN FROM S3Object s

For * more information about using SQL with S3 Glacier Select restore, see SQL * Reference for Amazon S3 Select and S3 Glacier Select in the Amazon Simple * Storage Service Developer Guide.

When making a select request, you * can also do the following:

To expedite your queries, specify * the Expedited tier. For more information about tiers, see * "Restoring Archives," later in this topic.

Specify details * about the data serialization format of both the input object that is being * queried and the serialization of the CSV-encoded query results.

*
The following are additional important facts about the select feature:
*

The output results are new Amazon S3 objects. Unlike archive * retrievals, they are stored until explicitly deleted-manually or through a * lifecycle policy.

You can issue more than one select request * on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid * issuing duplicate requests.

Amazon S3 accepts a select * request even if the object has already been restored. A select request doesn’t * return error response 409.

Restoring * Archives

Objects in the GLACIER and DEEP_ARCHIVE storage classes are * archived. To access an archived object, you must first initiate a restore * request. This restores a temporary copy of the archived object. In a restore * request, you specify the number of days that you want the restored copy to * exist. After the specified period, Amazon S3 deletes the temporary copy but the * object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object * was restored from.

To restore a specific object version, you can provide * a version ID. If you don't provide a version ID, Amazon S3 restores the current * version.

The time it takes restore jobs to finish depends on which * storage class the object is being restored from and which data access tier you * specify.

When restoring an archived object (or using a select request), * you can specify one of the following data access tier options in the * Tier element of the request body:

* Expedited - Expedited retrievals allow you to quickly access * your data stored in the GLACIER storage class when occasional urgent requests * for a subset of archives are required. For all but the largest archived objects * (250 MB+), data accessed using Expedited retrievals are typically made available * within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for * Expedited retrievals is available when you need it. Expedited retrievals and * provisioned capacity are not available for the DEEP_ARCHIVE storage class.
*

Standard - S3 Standard retrievals allow you * to access any of your archived objects within several hours. This is the default * option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify * the retrieval option. S3 Standard retrievals typically complete within 3-5 hours * from the GLACIER storage class and typically complete within 12 hours from the * DEEP_ARCHIVE storage class.

Bulk - * Bulk retrievals are Amazon S3 Glacier’s lowest-cost retrieval option, enabling * you to retrieve large amounts, even petabytes, of data inexpensively in a day. * Bulk retrievals typically complete within 5-12 hours from the GLACIER storage * class and typically complete within 48 hours from the DEEP_ARCHIVE storage * class.

For more information about archive retrieval options * and provisioned capacity for Expedited data access, see Restoring * Archived Objects in the Amazon Simple Storage Service Developer * Guide.

You can use Amazon S3 restore speed upgrade to change the * restore speed to a faster speed while it is in progress. You upgrade the speed * of an in-progress restoration by issuing another restore request to the same * object, setting a new Tier request element. When issuing a request * to upgrade the restore tier, you must choose a tier that is faster than the tier * that the in-progress restore is using. You must not change any other parameters, * such as the Days request element. For more information, see * Upgrading the Speed of an In-Progress Restore in the Amazon Simple * Storage Service Developer Guide.

To get the status of object * restoration, you can send a HEAD request. Operations return the * x-amz-restore header, which provides information about the * restoration status, in the response. You can use Amazon S3 event notifications * to notify you when a restore is initiated or completed. For more information, * see Configuring * Amazon S3 Event Notifications in the Amazon Simple Storage Service * Developer Guide.

After restoring an archived object, you can update * the restoration period by reissuing the request with a new period. Amazon S3 * updates the restoration period relative to the current time and charges only for * the request-there are no data transfer charges. You cannot update the * restoration period when Amazon S3 is actively processing your current restore * request for the object.

If your bucket has a lifecycle configuration with * a rule that includes an expiration action, the object expiration overrides the * life span that you specify in a restore request. For example, if you restore an * object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon * S3 deletes the object in 3 days. For more information about lifecycle * configuration, see PutBucketLifecycleConfiguration and Object * Lifecycle Management in Amazon Simple Storage Service Developer * Guide.

Responses

A successful operation returns * either the 200 OK or 202 Accepted status code.
*

If the object copy is not previously restored, then Amazon S3 * returns 202 Accepted in the response.

If the * object copy is previously restored, Amazon S3 returns 200 OK in the * response.

Special Errors

*

Code: * RestoreAlreadyInProgress

Cause: Object restore is * already in progress. (This error does not apply to SELECT type requests.) *

HTTP Status Code: 409 Conflict

* SOAP Fault Code Prefix: Client

Code: * GlacierExpeditedRetrievalNotAvailable

Cause: S3 * Glacier expedited retrievals are currently not available. Try again later. * (Returned if there is insufficient capacity to process the Expedited request. * This error applies only to Expedited retrievals and not to S3 Standard or Bulk * retrievals.)

HTTP Status Code: 503

*

SOAP Fault Code Prefix: N/A

Related Resources

* PutBucketLifecycleConfiguration

* GetBucketNotificationConfiguration

SQL * Reference for Amazon S3 Select and S3 Glacier Select in the Amazon * Simple Storage Service Developer Guide

See Also:
* AWS * API Reference
* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::RestoreObjectOutcomeCallable RestoreObjectCallable(const Model::RestoreObjectRequest& request) const; /** *
Restores an archived copy of an object back into Amazon S3

This * operation performs the following types of requests:

* select - Perform a select query on an archived object

*

restore an archive - Restore an archived object

*

To use this operation, you must have permissions to perform the * s3:RestoreObject 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 Simple * Storage Service Developer Guide.

Querying Archives with Select * Requests

You use a select type of request to perform SQL queries on * archived objects. The archived objects that are being queried by the select * request must be formatted as uncompressed comma-separated values (CSV) files. * You can run queries and custom analytics on your archived data without having to * restore your data to a hotter Amazon S3 tier. For an overview about select * requests, see Querying * Archived Objects in the Amazon Simple Storage Service Developer * Guide.

When making a select request, do the following:

*
Define an output location for the select query's output. This must be an * Amazon S3 bucket in the same AWS Region as the bucket that contains the archive * object that is being queried. The AWS account that initiates the job must have * permissions to write to the S3 bucket. You can specify the storage class and * encryption for the output objects stored in the bucket. For more information * about output, see Querying * Archived Objects in the Amazon Simple Storage Service Developer * Guide.

For more information about the S3 structure in * the request body, see the following:

PutObject
*

Managing * Access with ACLs in the Amazon Simple Storage Service Developer Guide *

Protecting * Data Using Server-Side Encryption in the Amazon Simple Storage Service * Developer Guide

Define the SQL expression for * the SELECT type of restoration for your query in the request body's * SelectParameters structure. You can use expressions like the * following examples.

The following expression returns all * records from the specified object.

SELECT * FROM Object *

Assuming that you are not using any headers for data stored * in the object, you can specify columns with positional headers.

* SELECT s._1, s._2 FROM Object s WHERE s._3 > 100

*
If you have headers and you set the fileHeaderInfo in the * CSV structure in the request body to USE, you can * specify headers in the query. (If you set the fileHeaderInfo field * to IGNORE, the first row is skipped for the query.) You cannot mix * ordinal positions with header column names.

SELECT s.Id, * s.FirstName, s.SSN FROM S3Object s

For * more information about using SQL with S3 Glacier Select restore, see SQL * Reference for Amazon S3 Select and S3 Glacier Select in the Amazon Simple * Storage Service Developer Guide.

When making a select request, you * can also do the following:

To expedite your queries, specify * the Expedited tier. For more information about tiers, see * "Restoring Archives," later in this topic.

Specify details * about the data serialization format of both the input object that is being * queried and the serialization of the CSV-encoded query results.

*
The following are additional important facts about the select feature:
*

The output results are new Amazon S3 objects. Unlike archive * retrievals, they are stored until explicitly deleted-manually or through a * lifecycle policy.

You can issue more than one select request * on the same Amazon S3 object. Amazon S3 doesn't deduplicate requests, so avoid * issuing duplicate requests.

Amazon S3 accepts a select * request even if the object has already been restored. A select request doesn’t * return error response 409.

Restoring * Archives

Objects in the GLACIER and DEEP_ARCHIVE storage classes are * archived. To access an archived object, you must first initiate a restore * request. This restores a temporary copy of the archived object. In a restore * request, you specify the number of days that you want the restored copy to * exist. After the specified period, Amazon S3 deletes the temporary copy but the * object remains archived in the GLACIER or DEEP_ARCHIVE storage class that object * was restored from.

To restore a specific object version, you can provide * a version ID. If you don't provide a version ID, Amazon S3 restores the current * version.

The time it takes restore jobs to finish depends on which * storage class the object is being restored from and which data access tier you * specify.

When restoring an archived object (or using a select request), * you can specify one of the following data access tier options in the * Tier element of the request body:

* Expedited - Expedited retrievals allow you to quickly access * your data stored in the GLACIER storage class when occasional urgent requests * for a subset of archives are required. For all but the largest archived objects * (250 MB+), data accessed using Expedited retrievals are typically made available * within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for * Expedited retrievals is available when you need it. Expedited retrievals and * provisioned capacity are not available for the DEEP_ARCHIVE storage class.
*

Standard - S3 Standard retrievals allow you * to access any of your archived objects within several hours. This is the default * option for the GLACIER and DEEP_ARCHIVE retrieval requests that do not specify * the retrieval option. S3 Standard retrievals typically complete within 3-5 hours * from the GLACIER storage class and typically complete within 12 hours from the * DEEP_ARCHIVE storage class.

Bulk - * Bulk retrievals are Amazon S3 Glacier’s lowest-cost retrieval option, enabling * you to retrieve large amounts, even petabytes, of data inexpensively in a day. * Bulk retrievals typically complete within 5-12 hours from the GLACIER storage * class and typically complete within 48 hours from the DEEP_ARCHIVE storage * class.

For more information about archive retrieval options * and provisioned capacity for Expedited data access, see Restoring * Archived Objects in the Amazon Simple Storage Service Developer * Guide.

You can use Amazon S3 restore speed upgrade to change the * restore speed to a faster speed while it is in progress. You upgrade the speed * of an in-progress restoration by issuing another restore request to the same * object, setting a new Tier request element. When issuing a request * to upgrade the restore tier, you must choose a tier that is faster than the tier * that the in-progress restore is using. You must not change any other parameters, * such as the Days request element. For more information, see * Upgrading the Speed of an In-Progress Restore in the Amazon Simple * Storage Service Developer Guide.

To get the status of object * restoration, you can send a HEAD request. Operations return the * x-amz-restore header, which provides information about the * restoration status, in the response. You can use Amazon S3 event notifications * to notify you when a restore is initiated or completed. For more information, * see Configuring * Amazon S3 Event Notifications in the Amazon Simple Storage Service * Developer Guide.

After restoring an archived object, you can update * the restoration period by reissuing the request with a new period. Amazon S3 * updates the restoration period relative to the current time and charges only for * the request-there are no data transfer charges. You cannot update the * restoration period when Amazon S3 is actively processing your current restore * request for the object.

If your bucket has a lifecycle configuration with * a rule that includes an expiration action, the object expiration overrides the * life span that you specify in a restore request. For example, if you restore an * object copy for 10 days, but the object is scheduled to expire in 3 days, Amazon * S3 deletes the object in 3 days. For more information about lifecycle * configuration, see PutBucketLifecycleConfiguration and Object * Lifecycle Management in Amazon Simple Storage Service Developer * Guide.

Responses

A successful operation returns * either the 200 OK or 202 Accepted status code.
*

If the object copy is not previously restored, then Amazon S3 * returns 202 Accepted in the response.

If the * object copy is previously restored, Amazon S3 returns 200 OK in the * response.

Special Errors

*

Code: * RestoreAlreadyInProgress

Cause: Object restore is * already in progress. (This error does not apply to SELECT type requests.) *

HTTP Status Code: 409 Conflict

* SOAP Fault Code Prefix: Client

Code: * GlacierExpeditedRetrievalNotAvailable

Cause: S3 * Glacier expedited retrievals are currently not available. Try again later. * (Returned if there is insufficient capacity to process the Expedited request. * This error applies only to Expedited retrievals and not to S3 Standard or Bulk * retrievals.)

HTTP Status Code: 503

*

SOAP Fault Code Prefix: N/A

Related Resources

* PutBucketLifecycleConfiguration

* GetBucketNotificationConfiguration

SQL * Reference for Amazon S3 Select and S3 Glacier Select in the Amazon * Simple Storage Service Developer Guide

See Also:
* AWS * API Reference
* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void RestoreObjectAsync(const Model::RestoreObjectRequest& request, const RestoreObjectResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *
This operation 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.

For * more information about Amazon S3 Select, see Selecting * Content from Objects in the Amazon Simple Storage Service Developer * Guide.

For more information about using SQL with Amazon S3 Select, * see * SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon * Simple Storage Service Developer Guide.

Permissions
*
You must have 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 Simple Storage Service Developer * 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 Simple * Storage Service Developer Guide.

For objects that are encrypted with * Amazon S3 managed encryption keys (SSE-S3) and customer master keys (CMKs) * stored in AWS Key Management Service (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 Simple Storage Service * Developer 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 RESTSelectObjectAppendix .

GetObject * Support

The SelectObjectContent operation 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.

*
GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot * specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage * classes. For more information, about storage classes see Storage * Classes in the Amazon Simple Storage Service Developer Guide.
*

Special Errors

For a list of special errors * for this operation, see SelectObjectContentErrorCodeList

Related Resources

GetObject
*

GetBucketLifecycleConfiguration

* PutBucketLifecycleConfiguration

See Also:
* AWS * API Reference
*/ virtual Model::SelectObjectContentOutcome SelectObjectContent(Model::SelectObjectContentRequest& request) const; /** *
This operation 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.

For * more information about Amazon S3 Select, see Selecting * Content from Objects in the Amazon Simple Storage Service Developer * Guide.

For more information about using SQL with Amazon S3 Select, * see * SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon * Simple Storage Service Developer Guide.

Permissions
*
You must have 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 Simple Storage Service Developer * 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 Simple * Storage Service Developer Guide.

For objects that are encrypted with * Amazon S3 managed encryption keys (SSE-S3) and customer master keys (CMKs) * stored in AWS Key Management Service (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 Simple Storage Service * Developer 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 RESTSelectObjectAppendix .

GetObject * Support

The SelectObjectContent operation 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.

*
GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot * specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage * classes. For more information, about storage classes see Storage * Classes in the Amazon Simple Storage Service Developer Guide.
*

Special Errors

For a list of special errors * for this operation, see SelectObjectContentErrorCodeList

Related Resources

GetObject
*

GetBucketLifecycleConfiguration

* PutBucketLifecycleConfiguration

See Also:
* AWS * API Reference
* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::SelectObjectContentOutcomeCallable SelectObjectContentCallable(Model::SelectObjectContentRequest& request) const; /** *
This operation 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.

For * more information about Amazon S3 Select, see Selecting * Content from Objects in the Amazon Simple Storage Service Developer * Guide.

For more information about using SQL with Amazon S3 Select, * see * SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon * Simple Storage Service Developer Guide.

Permissions
*
You must have 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 Simple Storage Service Developer * 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 Simple * Storage Service Developer Guide.

For objects that are encrypted with * Amazon S3 managed encryption keys (SSE-S3) and customer master keys (CMKs) * stored in AWS Key Management Service (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 Simple Storage Service * Developer 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 RESTSelectObjectAppendix .

GetObject * Support

The SelectObjectContent operation 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.

*
GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You cannot * specify the GLACIER, DEEP_ARCHIVE, or REDUCED_REDUNDANCY storage * classes. For more information, about storage classes see Storage * Classes in the Amazon Simple Storage Service Developer Guide.
*

Special Errors

For a list of special errors * for this operation, see SelectObjectContentErrorCodeList

Related Resources

GetObject
*

GetBucketLifecycleConfiguration

* PutBucketLifecycleConfiguration

See Also:
* AWS * API Reference
* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void SelectObjectContentAsync(Model::SelectObjectContentRequest& request, const SelectObjectContentResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *
Uploads a part in a multipart upload.

In this operation, you * provide part data in your request. However, you have an option to specify your * existing Amazon S3 object as a data source for the part you are uploading. To * upload a part from an existing object, you use the UploadPartCopy * operation.

You must initiate a multipart upload (see * CreateMultipartUpload) before you can upload any part. In response to * your initiate request, Amazon S3 returns an upload ID, a unique identifier, that * you must include in your upload part request.

Part numbers can be any * number from 1 to 10,000, inclusive. A part number uniquely identifies a part and * also defines its position within the object being created. If you upload a new * part using the same part number that was used with a previous part, the * previously uploaded part is overwritten. Each part must be at least 5 MB in * size, except the last part. There is no size limit on the last part of your * multipart upload.

To ensure that data is not corrupted when traversing * the network, specify the Content-MD5 header in the upload part * request. Amazon S3 checks the part data against the provided MD5 value. If they * do not match, Amazon S3 returns an error.

Note: After you * initiate multipart upload and upload one or more parts, you must either complete * or abort multipart upload in order to stop getting charged for storage of the * uploaded parts. Only after you either complete or abort multipart upload, Amazon * S3 frees up the parts storage and stops charging you for the parts storage.
*
For more information on multipart uploads, go to Multipart * Upload Overview in the Amazon Simple Storage Service Developer Guide * .

For information on the permissions required to use the multipart * upload API, go to Multipart * Upload API and Permissions in the Amazon Simple Storage Service Developer * Guide.

You can optionally request server-side encryption where Amazon * S3 encrypts your data as it writes it to disks in its data centers and decrypts * it for you when you access it. You have the option of providing your own * encryption key, or you can use the AWS managed encryption keys. If you choose to * provide your own encryption key, the request headers you provide in the request * must match the headers you used in the request to initiate the upload by using * CreateMultipartUpload. For more information, go to Using * Server-Side Encryption in the Amazon Simple Storage Service Developer * Guide.

Server-side encryption is supported by the S3 Multipart Upload * actions. Unless you are using a customer-provided encryption key, you don't need * to specify the encryption parameters in each UploadPart request. Instead, you * only need to specify the server-side encryption parameters in the initial * Initiate Multipart request. For more information, see * CreateMultipartUpload.

If you requested server-side encryption * using a customer-provided encryption key in your initiate multipart upload * request, you must provide identical encryption information in each part upload * using the following headers.

*
x-amz-server-side-encryption-customer-algorithm

*
x-amz-server-side-encryption-customer-key

*
x-amz-server-side-encryption-customer-key-MD5

Special Errors

*

Code: NoSuchUpload

Cause: The * specified multipart upload does not exist. The upload ID might be invalid, or * the multipart upload might have been aborted or completed.

*
HTTP Status Code: 404 Not Found

SOAP Fault * Code Prefix: Client

* Related Resources

CreateMultipartUpload
*

CompleteMultipartUpload

* AbortMultipartUpload

ListParts

*
ListMultipartUploads

See Also:
AWS API * Reference
*/ virtual Model::UploadPartOutcome UploadPart(const Model::UploadPartRequest& request) const; /** *
Uploads a part in a multipart upload.

In this operation, you * provide part data in your request. However, you have an option to specify your * existing Amazon S3 object as a data source for the part you are uploading. To * upload a part from an existing object, you use the UploadPartCopy * operation.

You must initiate a multipart upload (see * CreateMultipartUpload) before you can upload any part. In response to * your initiate request, Amazon S3 returns an upload ID, a unique identifier, that * you must include in your upload part request.

Part numbers can be any * number from 1 to 10,000, inclusive. A part number uniquely identifies a part and * also defines its position within the object being created. If you upload a new * part using the same part number that was used with a previous part, the * previously uploaded part is overwritten. Each part must be at least 5 MB in * size, except the last part. There is no size limit on the last part of your * multipart upload.

To ensure that data is not corrupted when traversing * the network, specify the Content-MD5 header in the upload part * request. Amazon S3 checks the part data against the provided MD5 value. If they * do not match, Amazon S3 returns an error.

Note: After you * initiate multipart upload and upload one or more parts, you must either complete * or abort multipart upload in order to stop getting charged for storage of the * uploaded parts. Only after you either complete or abort multipart upload, Amazon * S3 frees up the parts storage and stops charging you for the parts storage.
*
For more information on multipart uploads, go to Multipart * Upload Overview in the Amazon Simple Storage Service Developer Guide * .

For information on the permissions required to use the multipart * upload API, go to Multipart * Upload API and Permissions in the Amazon Simple Storage Service Developer * Guide.

You can optionally request server-side encryption where Amazon * S3 encrypts your data as it writes it to disks in its data centers and decrypts * it for you when you access it. You have the option of providing your own * encryption key, or you can use the AWS managed encryption keys. If you choose to * provide your own encryption key, the request headers you provide in the request * must match the headers you used in the request to initiate the upload by using * CreateMultipartUpload. For more information, go to Using * Server-Side Encryption in the Amazon Simple Storage Service Developer * Guide.

Server-side encryption is supported by the S3 Multipart Upload * actions. Unless you are using a customer-provided encryption key, you don't need * to specify the encryption parameters in each UploadPart request. Instead, you * only need to specify the server-side encryption parameters in the initial * Initiate Multipart request. For more information, see * CreateMultipartUpload.

If you requested server-side encryption * using a customer-provided encryption key in your initiate multipart upload * request, you must provide identical encryption information in each part upload * using the following headers.

*
x-amz-server-side-encryption-customer-algorithm

*
x-amz-server-side-encryption-customer-key

*
x-amz-server-side-encryption-customer-key-MD5

Special Errors

*

Code: NoSuchUpload

Cause: The * specified multipart upload does not exist. The upload ID might be invalid, or * the multipart upload might have been aborted or completed.

*
HTTP Status Code: 404 Not Found

SOAP Fault * Code Prefix: Client

* Related Resources

CreateMultipartUpload
*

CompleteMultipartUpload

* AbortMultipartUpload

ListParts

*
ListMultipartUploads

See Also:
AWS API * Reference
* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::UploadPartOutcomeCallable UploadPartCallable(const Model::UploadPartRequest& request) const; /** *
Uploads a part in a multipart upload.

In this operation, you * provide part data in your request. However, you have an option to specify your * existing Amazon S3 object as a data source for the part you are uploading. To * upload a part from an existing object, you use the UploadPartCopy * operation.

You must initiate a multipart upload (see * CreateMultipartUpload) before you can upload any part. In response to * your initiate request, Amazon S3 returns an upload ID, a unique identifier, that * you must include in your upload part request.

Part numbers can be any * number from 1 to 10,000, inclusive. A part number uniquely identifies a part and * also defines its position within the object being created. If you upload a new * part using the same part number that was used with a previous part, the * previously uploaded part is overwritten. Each part must be at least 5 MB in * size, except the last part. There is no size limit on the last part of your * multipart upload.

To ensure that data is not corrupted when traversing * the network, specify the Content-MD5 header in the upload part * request. Amazon S3 checks the part data against the provided MD5 value. If they * do not match, Amazon S3 returns an error.

Note: After you * initiate multipart upload and upload one or more parts, you must either complete * or abort multipart upload in order to stop getting charged for storage of the * uploaded parts. Only after you either complete or abort multipart upload, Amazon * S3 frees up the parts storage and stops charging you for the parts storage.
*
For more information on multipart uploads, go to Multipart * Upload Overview in the Amazon Simple Storage Service Developer Guide * .

For information on the permissions required to use the multipart * upload API, go to Multipart * Upload API and Permissions in the Amazon Simple Storage Service Developer * Guide.

You can optionally request server-side encryption where Amazon * S3 encrypts your data as it writes it to disks in its data centers and decrypts * it for you when you access it. You have the option of providing your own * encryption key, or you can use the AWS managed encryption keys. If you choose to * provide your own encryption key, the request headers you provide in the request * must match the headers you used in the request to initiate the upload by using * CreateMultipartUpload. For more information, go to Using * Server-Side Encryption in the Amazon Simple Storage Service Developer * Guide.

Server-side encryption is supported by the S3 Multipart Upload * actions. Unless you are using a customer-provided encryption key, you don't need * to specify the encryption parameters in each UploadPart request. Instead, you * only need to specify the server-side encryption parameters in the initial * Initiate Multipart request. For more information, see * CreateMultipartUpload.

If you requested server-side encryption * using a customer-provided encryption key in your initiate multipart upload * request, you must provide identical encryption information in each part upload * using the following headers.

*
x-amz-server-side-encryption-customer-algorithm

*
x-amz-server-side-encryption-customer-key

*
x-amz-server-side-encryption-customer-key-MD5

Special Errors

*

Code: NoSuchUpload

Cause: The * specified multipart upload does not exist. The upload ID might be invalid, or * the multipart upload might have been aborted or completed.

*
HTTP Status Code: 404 Not Found

SOAP Fault * Code Prefix: Client

* Related Resources

CreateMultipartUpload
*

CompleteMultipartUpload

* AbortMultipartUpload

ListParts

*
ListMultipartUploads

See Also:
AWS API * Reference
* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void UploadPartAsync(const Model::UploadPartRequest& request, const UploadPartResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; /** *
Uploads a part by copying data from an existing object as data source. You * specify the data source by adding the request header * x-amz-copy-source in your request and a byte range by adding the * request header x-amz-copy-source-range in your request.

The * minimum allowable part size for a multipart upload is 5 MB. For more information * about multipart upload limits, go to Quick * Facts in the Amazon Simple Storage Service Developer Guide.
*
Instead of using an existing object as part data, you might use the * UploadPart operation and provide data in your request.

You * must initiate a multipart upload before you can upload any part. In response to * your initiate request. Amazon S3 returns a unique identifier, the upload ID, * that you must include in your upload part request.

For more information * about using the UploadPartCopy operation, see the following:
*

For conceptual information about multipart uploads, see Uploading * Objects Using Multipart Upload in the Amazon Simple Storage Service * Developer Guide.

For information about permissions * required to use the multipart upload API, see Multipart * Upload API and Permissions in the Amazon Simple Storage Service Developer * Guide.

For information about copying objects using a * single atomic operation vs. the multipart upload, see Operations * on Objects in the Amazon Simple Storage Service Developer Guide.
*

For information about using server-side encryption with * customer-provided encryption keys with the UploadPartCopy operation, see * CopyObject and UploadPart.

Note the following * additional considerations about the request headers * x-amz-copy-source-if-match, * x-amz-copy-source-if-none-match, * x-amz-copy-source-if-unmodified-since, and * x-amz-copy-source-if-modified-since:

* Consideration 1 - If both of the x-amz-copy-source-if-match * and x-amz-copy-source-if-unmodified-since headers are present in * the request as follows:

x-amz-copy-source-if-match * condition evaluates to true, and;

* x-amz-copy-source-if-unmodified-since condition evaluates to * false;

Amazon S3 returns 200 OK and copies the * data.

Consideration 2 - If both of the * x-amz-copy-source-if-none-match and * x-amz-copy-source-if-modified-since headers are present in the * request as follows:

x-amz-copy-source-if-none-match * condition evaluates to false, and;

* x-amz-copy-source-if-modified-since condition evaluates to * true;

Amazon S3 returns 412 Precondition Failed * response code.

Versioning

If your bucket has * versioning enabled, you could have multiple versions of the same object. By * default, x-amz-copy-source identifies the current version of the * object to copy. If the current version is a delete marker and you don't specify * a versionId in the x-amz-copy-source, Amazon S3 returns a 404 * error, because the object does not exist. If you specify versionId in the * x-amz-copy-source and the versionId is a delete marker, Amazon S3 * returns an HTTP 400 error, because you are not allowed to specify a delete * marker as a version for the x-amz-copy-source.

You can * optionally specify a specific version of the source object to copy by adding the * versionId subresource as shown in the following example:

* x-amz-copy-source: /bucket/object?versionId=version id

Special Errors

*

Code: NoSuchUpload

Cause: The * specified multipart upload does not exist. The upload ID might be invalid, or * the multipart upload might have been aborted or completed.

*
HTTP Status Code: 404 Not Found

Code: InvalidRequest

*

Cause: The specified copy source is not supported as a byte-range * copy source.

HTTP Status Code: 400 Bad Request *

Related Resources
*

CreateMultipartUpload

UploadPart *

CompleteMultipartUpload

* AbortMultipartUpload

ListParts

*
ListMultipartUploads

See Also:
AWS * API Reference
*/ virtual Model::UploadPartCopyOutcome UploadPartCopy(const Model::UploadPartCopyRequest& request) const; /** *
Uploads a part by copying data from an existing object as data source. You * specify the data source by adding the request header * x-amz-copy-source in your request and a byte range by adding the * request header x-amz-copy-source-range in your request.

The * minimum allowable part size for a multipart upload is 5 MB. For more information * about multipart upload limits, go to Quick * Facts in the Amazon Simple Storage Service Developer Guide.
*
Instead of using an existing object as part data, you might use the * UploadPart operation and provide data in your request.

You * must initiate a multipart upload before you can upload any part. In response to * your initiate request. Amazon S3 returns a unique identifier, the upload ID, * that you must include in your upload part request.

For more information * about using the UploadPartCopy operation, see the following:
*

For conceptual information about multipart uploads, see Uploading * Objects Using Multipart Upload in the Amazon Simple Storage Service * Developer Guide.

For information about permissions * required to use the multipart upload API, see Multipart * Upload API and Permissions in the Amazon Simple Storage Service Developer * Guide.

For information about copying objects using a * single atomic operation vs. the multipart upload, see Operations * on Objects in the Amazon Simple Storage Service Developer Guide.
*

For information about using server-side encryption with * customer-provided encryption keys with the UploadPartCopy operation, see * CopyObject and UploadPart.

Note the following * additional considerations about the request headers * x-amz-copy-source-if-match, * x-amz-copy-source-if-none-match, * x-amz-copy-source-if-unmodified-since, and * x-amz-copy-source-if-modified-since:

* Consideration 1 - If both of the x-amz-copy-source-if-match * and x-amz-copy-source-if-unmodified-since headers are present in * the request as follows:

x-amz-copy-source-if-match * condition evaluates to true, and;

* x-amz-copy-source-if-unmodified-since condition evaluates to * false;

Amazon S3 returns 200 OK and copies the * data.

Consideration 2 - If both of the * x-amz-copy-source-if-none-match and * x-amz-copy-source-if-modified-since headers are present in the * request as follows:

x-amz-copy-source-if-none-match * condition evaluates to false, and;

* x-amz-copy-source-if-modified-since condition evaluates to * true;

Amazon S3 returns 412 Precondition Failed * response code.

Versioning

If your bucket has * versioning enabled, you could have multiple versions of the same object. By * default, x-amz-copy-source identifies the current version of the * object to copy. If the current version is a delete marker and you don't specify * a versionId in the x-amz-copy-source, Amazon S3 returns a 404 * error, because the object does not exist. If you specify versionId in the * x-amz-copy-source and the versionId is a delete marker, Amazon S3 * returns an HTTP 400 error, because you are not allowed to specify a delete * marker as a version for the x-amz-copy-source.

You can * optionally specify a specific version of the source object to copy by adding the * versionId subresource as shown in the following example:

* x-amz-copy-source: /bucket/object?versionId=version id

Special Errors

*

Code: NoSuchUpload

Cause: The * specified multipart upload does not exist. The upload ID might be invalid, or * the multipart upload might have been aborted or completed.

*
HTTP Status Code: 404 Not Found

Code: InvalidRequest

*

Cause: The specified copy source is not supported as a byte-range * copy source.

HTTP Status Code: 400 Bad Request *

Related Resources
*

CreateMultipartUpload

UploadPart *

CompleteMultipartUpload

* AbortMultipartUpload

ListParts

*
ListMultipartUploads

See Also:
AWS * API Reference
* * returns a future to the operation so that it can be executed in parallel to other requests. */ virtual Model::UploadPartCopyOutcomeCallable UploadPartCopyCallable(const Model::UploadPartCopyRequest& request) const; /** *
Uploads a part by copying data from an existing object as data source. You * specify the data source by adding the request header * x-amz-copy-source in your request and a byte range by adding the * request header x-amz-copy-source-range in your request.

The * minimum allowable part size for a multipart upload is 5 MB. For more information * about multipart upload limits, go to Quick * Facts in the Amazon Simple Storage Service Developer Guide.
*
Instead of using an existing object as part data, you might use the * UploadPart operation and provide data in your request.

You * must initiate a multipart upload before you can upload any part. In response to * your initiate request. Amazon S3 returns a unique identifier, the upload ID, * that you must include in your upload part request.

For more information * about using the UploadPartCopy operation, see the following:
*

For conceptual information about multipart uploads, see Uploading * Objects Using Multipart Upload in the Amazon Simple Storage Service * Developer Guide.

For information about permissions * required to use the multipart upload API, see Multipart * Upload API and Permissions in the Amazon Simple Storage Service Developer * Guide.

For information about copying objects using a * single atomic operation vs. the multipart upload, see Operations * on Objects in the Amazon Simple Storage Service Developer Guide.
*

For information about using server-side encryption with * customer-provided encryption keys with the UploadPartCopy operation, see * CopyObject and UploadPart.

Note the following * additional considerations about the request headers * x-amz-copy-source-if-match, * x-amz-copy-source-if-none-match, * x-amz-copy-source-if-unmodified-since, and * x-amz-copy-source-if-modified-since:

* Consideration 1 - If both of the x-amz-copy-source-if-match * and x-amz-copy-source-if-unmodified-since headers are present in * the request as follows:

x-amz-copy-source-if-match * condition evaluates to true, and;

* x-amz-copy-source-if-unmodified-since condition evaluates to * false;

Amazon S3 returns 200 OK and copies the * data.

Consideration 2 - If both of the * x-amz-copy-source-if-none-match and * x-amz-copy-source-if-modified-since headers are present in the * request as follows:

x-amz-copy-source-if-none-match * condition evaluates to false, and;

* x-amz-copy-source-if-modified-since condition evaluates to * true;

Amazon S3 returns 412 Precondition Failed * response code.

Versioning

If your bucket has * versioning enabled, you could have multiple versions of the same object. By * default, x-amz-copy-source identifies the current version of the * object to copy. If the current version is a delete marker and you don't specify * a versionId in the x-amz-copy-source, Amazon S3 returns a 404 * error, because the object does not exist. If you specify versionId in the * x-amz-copy-source and the versionId is a delete marker, Amazon S3 * returns an HTTP 400 error, because you are not allowed to specify a delete * marker as a version for the x-amz-copy-source.

You can * optionally specify a specific version of the source object to copy by adding the * versionId subresource as shown in the following example:

* x-amz-copy-source: /bucket/object?versionId=version id

Special Errors

*

Code: NoSuchUpload

Cause: The * specified multipart upload does not exist. The upload ID might be invalid, or * the multipart upload might have been aborted or completed.

*
HTTP Status Code: 404 Not Found

Code: InvalidRequest

*

Cause: The specified copy source is not supported as a byte-range * copy source.

HTTP Status Code: 400 Bad Request *

Related Resources
*

CreateMultipartUpload

UploadPart *

CompleteMultipartUpload

* AbortMultipartUpload

ListParts

*
ListMultipartUploads

See Also:
AWS * API Reference
* * Queues the request into a thread executor and triggers associated callback when operation has finished. */ virtual void UploadPartCopyAsync(const Model::UploadPartCopyRequest& request, const UploadPartCopyResponseReceivedHandler& handler, const std::shared_ptr& context = nullptr) const; Aws::String GeneratePresignedUrl(const Aws::String& bucket, const Aws::String& key, Aws::Http::HttpMethod method, long long expirationInSeconds = MAX_EXPIRATION_SECONDS); Aws::String GeneratePresignedUrl(const Aws::String& bucket, const Aws::String& key, Aws::Http::HttpMethod method, const Http::HeaderValueCollection& customizedHeaders, long long expirationInSeconds = MAX_EXPIRATION_SECONDS); /** * Server Side Encryption Headers and Algorithm * Method Algorithm Required Headers * SSE-S3 AES256 x-amz-server-side-encryption:AES256 * SSE-KMS aws:kms x-amz-server-side--encryption:aws:kms, x-amz-server-side-encryption-aws-kms-key-id: * SS3-C AES256 x-amz-server-side-encryption-customer-algorithm:AES256, x-amz-server-side-encryption-customer-key:, x-amz-server-side-encryption-customer-key-MD5: */ /** * Generate presigned URL with Sever Side Encryption(SSE) and with S3 managed keys. * https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html (algo: AES256) */ Aws::String GeneratePresignedUrlWithSSES3(const Aws::String& bucket, const Aws::String& key, Aws::Http::HttpMethod method, long long expirationInSeconds = MAX_EXPIRATION_SECONDS); /** * Generate presigned URL with Sever Side Encryption(SSE) and with S3 managed keys. * https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html (algo: AES256) * Header: "x-amz-server-side-encryption" will be added internally, don't customize it. */ Aws::String GeneratePresignedUrlWithSSES3(const Aws::String& bucket, const Aws::String& key, Aws::Http::HttpMethod method, Http::HeaderValueCollection customizedHeaders, long long expirationInSeconds = MAX_EXPIRATION_SECONDS); /** * Generate presigned URL with Server Side Encryption(SSE) and with KMS master key id. * if kmsMasterKeyId is empty, we will end up use the default one generated by KMS for you. You can find it via AWS IAM console, it's the one aliased as "aws/s3". * https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html (algo: aws:kms) */ Aws::String GeneratePresignedUrlWithSSEKMS(const Aws::String& bucket, const Aws::String& key, Aws::Http::HttpMethod method, const Aws::String& kmsMasterKeyId = "", long long expirationInSeconds = MAX_EXPIRATION_SECONDS); /** * Generate presigned URL with Server Side Encryption(SSE) and with KMS master key id. * if kmsMasterKeyId is empty, we will end up use the default one generated by KMS for you. You can find it via AWS IAM console, it's the one aliased as "aws/s3". * https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html (algo: aws:kms) * Headers: "x-amz-server-side-encryption" and "x-amz-server-side-encryption-aws-kms-key-id" will be added internally, don't customize them. */ Aws::String GeneratePresignedUrlWithSSEKMS(const Aws::String& bucket, const Aws::String& key, Aws::Http::HttpMethod method, Http::HeaderValueCollection customizedHeaders, const Aws::String& kmsMasterKeyId = "", long long expirationInSeconds = MAX_EXPIRATION_SECONDS); /** * Generate presigned URL with Sever Side Encryption(SSE) and with customer supplied Key. * https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html (algo: AES256) */ Aws::String GeneratePresignedUrlWithSSEC(const Aws::String& bucket, const Aws::String& key, Aws::Http::HttpMethod method, const Aws::String& base64EncodedAES256Key, long long expirationInSeconds = MAX_EXPIRATION_SECONDS); /** * Generate presigned URL with Sever Side Encryption(SSE) and with customer supplied Key. * https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html (algo: AES256) * Headers: "x-amz-server-side-encryption-customer-algorithm","x-amz-server-side-encryption-customer-key" and "x-amz-server-side-encryption-customer-key-MD5" will be added internally, don't customize them. */ Aws::String GeneratePresignedUrlWithSSEC(const Aws::String& bucket, const Aws::String& key, Aws::Http::HttpMethod method, Http::HeaderValueCollection customizedHeaders, const Aws::String& base64EncodedAES256Key, long long expirationInSeconds = MAX_EXPIRATION_SECONDS); virtual bool MultipartUploadSupported() const; void OverrideEndpoint(const Aws::String& endpoint); private: void init(const Client::ClientConfiguration& clientConfiguration); void LoadS3SpecificConfig(const Aws::String& profile); ComputeEndpointOutcome ComputeEndpointString(const Aws::String& bucket) const; ComputeEndpointOutcome ComputeEndpointString() const; void AbortMultipartUploadAsyncHelper(const Model::AbortMultipartUploadRequest& request, const AbortMultipartUploadResponseReceivedHandler& handler, const std::shared_ptr& context) const; void CompleteMultipartUploadAsyncHelper(const Model::CompleteMultipartUploadRequest& request, const CompleteMultipartUploadResponseReceivedHandler& handler, const std::shared_ptr& context) const; void CopyObjectAsyncHelper(const Model::CopyObjectRequest& request, const CopyObjectResponseReceivedHandler& handler, const std::shared_ptr& context) const; void CreateBucketAsyncHelper(const Model::CreateBucketRequest& request, const CreateBucketResponseReceivedHandler& handler, const std::shared_ptr& context) const; void CreateMultipartUploadAsyncHelper(const Model::CreateMultipartUploadRequest& request, const CreateMultipartUploadResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteBucketAsyncHelper(const Model::DeleteBucketRequest& request, const DeleteBucketResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteBucketAnalyticsConfigurationAsyncHelper(const Model::DeleteBucketAnalyticsConfigurationRequest& request, const DeleteBucketAnalyticsConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteBucketCorsAsyncHelper(const Model::DeleteBucketCorsRequest& request, const DeleteBucketCorsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteBucketEncryptionAsyncHelper(const Model::DeleteBucketEncryptionRequest& request, const DeleteBucketEncryptionResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteBucketInventoryConfigurationAsyncHelper(const Model::DeleteBucketInventoryConfigurationRequest& request, const DeleteBucketInventoryConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteBucketLifecycleAsyncHelper(const Model::DeleteBucketLifecycleRequest& request, const DeleteBucketLifecycleResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteBucketMetricsConfigurationAsyncHelper(const Model::DeleteBucketMetricsConfigurationRequest& request, const DeleteBucketMetricsConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteBucketPolicyAsyncHelper(const Model::DeleteBucketPolicyRequest& request, const DeleteBucketPolicyResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteBucketReplicationAsyncHelper(const Model::DeleteBucketReplicationRequest& request, const DeleteBucketReplicationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteBucketTaggingAsyncHelper(const Model::DeleteBucketTaggingRequest& request, const DeleteBucketTaggingResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteBucketWebsiteAsyncHelper(const Model::DeleteBucketWebsiteRequest& request, const DeleteBucketWebsiteResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteObjectAsyncHelper(const Model::DeleteObjectRequest& request, const DeleteObjectResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteObjectTaggingAsyncHelper(const Model::DeleteObjectTaggingRequest& request, const DeleteObjectTaggingResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeleteObjectsAsyncHelper(const Model::DeleteObjectsRequest& request, const DeleteObjectsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void DeletePublicAccessBlockAsyncHelper(const Model::DeletePublicAccessBlockRequest& request, const DeletePublicAccessBlockResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketAccelerateConfigurationAsyncHelper(const Model::GetBucketAccelerateConfigurationRequest& request, const GetBucketAccelerateConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketAclAsyncHelper(const Model::GetBucketAclRequest& request, const GetBucketAclResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketAnalyticsConfigurationAsyncHelper(const Model::GetBucketAnalyticsConfigurationRequest& request, const GetBucketAnalyticsConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketCorsAsyncHelper(const Model::GetBucketCorsRequest& request, const GetBucketCorsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketEncryptionAsyncHelper(const Model::GetBucketEncryptionRequest& request, const GetBucketEncryptionResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketInventoryConfigurationAsyncHelper(const Model::GetBucketInventoryConfigurationRequest& request, const GetBucketInventoryConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketLifecycleConfigurationAsyncHelper(const Model::GetBucketLifecycleConfigurationRequest& request, const GetBucketLifecycleConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketLocationAsyncHelper(const Model::GetBucketLocationRequest& request, const GetBucketLocationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketLoggingAsyncHelper(const Model::GetBucketLoggingRequest& request, const GetBucketLoggingResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketMetricsConfigurationAsyncHelper(const Model::GetBucketMetricsConfigurationRequest& request, const GetBucketMetricsConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketNotificationConfigurationAsyncHelper(const Model::GetBucketNotificationConfigurationRequest& request, const GetBucketNotificationConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketPolicyAsyncHelper(const Model::GetBucketPolicyRequest& request, const GetBucketPolicyResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketPolicyStatusAsyncHelper(const Model::GetBucketPolicyStatusRequest& request, const GetBucketPolicyStatusResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketReplicationAsyncHelper(const Model::GetBucketReplicationRequest& request, const GetBucketReplicationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketRequestPaymentAsyncHelper(const Model::GetBucketRequestPaymentRequest& request, const GetBucketRequestPaymentResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketTaggingAsyncHelper(const Model::GetBucketTaggingRequest& request, const GetBucketTaggingResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketVersioningAsyncHelper(const Model::GetBucketVersioningRequest& request, const GetBucketVersioningResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetBucketWebsiteAsyncHelper(const Model::GetBucketWebsiteRequest& request, const GetBucketWebsiteResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetObjectAsyncHelper(const Model::GetObjectRequest& request, const GetObjectResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetObjectAclAsyncHelper(const Model::GetObjectAclRequest& request, const GetObjectAclResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetObjectLegalHoldAsyncHelper(const Model::GetObjectLegalHoldRequest& request, const GetObjectLegalHoldResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetObjectLockConfigurationAsyncHelper(const Model::GetObjectLockConfigurationRequest& request, const GetObjectLockConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetObjectRetentionAsyncHelper(const Model::GetObjectRetentionRequest& request, const GetObjectRetentionResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetObjectTaggingAsyncHelper(const Model::GetObjectTaggingRequest& request, const GetObjectTaggingResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetObjectTorrentAsyncHelper(const Model::GetObjectTorrentRequest& request, const GetObjectTorrentResponseReceivedHandler& handler, const std::shared_ptr& context) const; void GetPublicAccessBlockAsyncHelper(const Model::GetPublicAccessBlockRequest& request, const GetPublicAccessBlockResponseReceivedHandler& handler, const std::shared_ptr& context) const; void HeadBucketAsyncHelper(const Model::HeadBucketRequest& request, const HeadBucketResponseReceivedHandler& handler, const std::shared_ptr& context) const; void HeadObjectAsyncHelper(const Model::HeadObjectRequest& request, const HeadObjectResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListBucketAnalyticsConfigurationsAsyncHelper(const Model::ListBucketAnalyticsConfigurationsRequest& request, const ListBucketAnalyticsConfigurationsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListBucketInventoryConfigurationsAsyncHelper(const Model::ListBucketInventoryConfigurationsRequest& request, const ListBucketInventoryConfigurationsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListBucketMetricsConfigurationsAsyncHelper(const Model::ListBucketMetricsConfigurationsRequest& request, const ListBucketMetricsConfigurationsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListBucketsAsyncHelper(const ListBucketsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListMultipartUploadsAsyncHelper(const Model::ListMultipartUploadsRequest& request, const ListMultipartUploadsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListObjectVersionsAsyncHelper(const Model::ListObjectVersionsRequest& request, const ListObjectVersionsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListObjectsAsyncHelper(const Model::ListObjectsRequest& request, const ListObjectsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListObjectsV2AsyncHelper(const Model::ListObjectsV2Request& request, const ListObjectsV2ResponseReceivedHandler& handler, const std::shared_ptr& context) const; void ListPartsAsyncHelper(const Model::ListPartsRequest& request, const ListPartsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketAccelerateConfigurationAsyncHelper(const Model::PutBucketAccelerateConfigurationRequest& request, const PutBucketAccelerateConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketAclAsyncHelper(const Model::PutBucketAclRequest& request, const PutBucketAclResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketAnalyticsConfigurationAsyncHelper(const Model::PutBucketAnalyticsConfigurationRequest& request, const PutBucketAnalyticsConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketCorsAsyncHelper(const Model::PutBucketCorsRequest& request, const PutBucketCorsResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketEncryptionAsyncHelper(const Model::PutBucketEncryptionRequest& request, const PutBucketEncryptionResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketInventoryConfigurationAsyncHelper(const Model::PutBucketInventoryConfigurationRequest& request, const PutBucketInventoryConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketLifecycleConfigurationAsyncHelper(const Model::PutBucketLifecycleConfigurationRequest& request, const PutBucketLifecycleConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketLoggingAsyncHelper(const Model::PutBucketLoggingRequest& request, const PutBucketLoggingResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketMetricsConfigurationAsyncHelper(const Model::PutBucketMetricsConfigurationRequest& request, const PutBucketMetricsConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketNotificationConfigurationAsyncHelper(const Model::PutBucketNotificationConfigurationRequest& request, const PutBucketNotificationConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketPolicyAsyncHelper(const Model::PutBucketPolicyRequest& request, const PutBucketPolicyResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketReplicationAsyncHelper(const Model::PutBucketReplicationRequest& request, const PutBucketReplicationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketRequestPaymentAsyncHelper(const Model::PutBucketRequestPaymentRequest& request, const PutBucketRequestPaymentResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketTaggingAsyncHelper(const Model::PutBucketTaggingRequest& request, const PutBucketTaggingResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketVersioningAsyncHelper(const Model::PutBucketVersioningRequest& request, const PutBucketVersioningResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutBucketWebsiteAsyncHelper(const Model::PutBucketWebsiteRequest& request, const PutBucketWebsiteResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutObjectAsyncHelper(const Model::PutObjectRequest& request, const PutObjectResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutObjectAclAsyncHelper(const Model::PutObjectAclRequest& request, const PutObjectAclResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutObjectLegalHoldAsyncHelper(const Model::PutObjectLegalHoldRequest& request, const PutObjectLegalHoldResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutObjectLockConfigurationAsyncHelper(const Model::PutObjectLockConfigurationRequest& request, const PutObjectLockConfigurationResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutObjectRetentionAsyncHelper(const Model::PutObjectRetentionRequest& request, const PutObjectRetentionResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutObjectTaggingAsyncHelper(const Model::PutObjectTaggingRequest& request, const PutObjectTaggingResponseReceivedHandler& handler, const std::shared_ptr& context) const; void PutPublicAccessBlockAsyncHelper(const Model::PutPublicAccessBlockRequest& request, const PutPublicAccessBlockResponseReceivedHandler& handler, const std::shared_ptr& context) const; void RestoreObjectAsyncHelper(const Model::RestoreObjectRequest& request, const RestoreObjectResponseReceivedHandler& handler, const std::shared_ptr& context) const; void SelectObjectContentAsyncHelper(Model::SelectObjectContentRequest& request, const SelectObjectContentResponseReceivedHandler& handler, const std::shared_ptr& context) const; void UploadPartAsyncHelper(const Model::UploadPartRequest& request, const UploadPartResponseReceivedHandler& handler, const std::shared_ptr& context) const; void UploadPartCopyAsyncHelper(const Model::UploadPartCopyRequest& request, const UploadPartCopyResponseReceivedHandler& handler, const std::shared_ptr& context) const; Aws::String m_baseUri; Aws::String m_scheme; Aws::String m_configScheme; std::shared_ptr m_executor; bool m_useVirtualAddressing; bool m_useDualStack; bool m_useArnRegion; bool m_useCustomEndpoint; Aws::S3::US_EAST_1_REGIONAL_ENDPOINT_OPTION m_USEast1RegionalEndpointOption; }; } // namespace S3 } // namespace Aws