@Generated(value="software.amazon.awssdk:codegen") public interface S3AsyncClient extends SdkClient
builder()
method.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<AbortMultipartUploadResponse> |
abortMultipartUpload(AbortMultipartUploadRequest abortMultipartUploadRequest)
This operation aborts a multipart upload.
|
default CompletableFuture<AbortMultipartUploadResponse> |
abortMultipartUpload(Consumer<AbortMultipartUploadRequest.Builder> abortMultipartUploadRequest)
This operation aborts a multipart upload.
|
static S3AsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
S3AsyncClient . |
default CompletableFuture<CompleteMultipartUploadResponse> |
completeMultipartUpload(CompleteMultipartUploadRequest completeMultipartUploadRequest)
Completes a multipart upload by assembling previously uploaded parts.
|
default CompletableFuture<CompleteMultipartUploadResponse> |
completeMultipartUpload(Consumer<CompleteMultipartUploadRequest.Builder> completeMultipartUploadRequest)
Completes a multipart upload by assembling previously uploaded parts.
|
default CompletableFuture<CopyObjectResponse> |
copyObject(Consumer<CopyObjectRequest.Builder> copyObjectRequest)
Creates a copy of an object that is already stored in Amazon S3.
|
default CompletableFuture<CopyObjectResponse> |
copyObject(CopyObjectRequest copyObjectRequest)
Creates a copy of an object that is already stored in Amazon S3.
|
static S3AsyncClient |
create()
Create a
S3AsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateBucketResponse> |
createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest)
Creates a new S3 bucket.
|
default CompletableFuture<CreateBucketResponse> |
createBucket(CreateBucketRequest createBucketRequest)
Creates a new S3 bucket.
|
default CompletableFuture<CreateMultipartUploadResponse> |
createMultipartUpload(Consumer<CreateMultipartUploadRequest.Builder> createMultipartUploadRequest)
This operation initiates a multipart upload and returns an upload ID.
|
default CompletableFuture<CreateMultipartUploadResponse> |
createMultipartUpload(CreateMultipartUploadRequest createMultipartUploadRequest)
This operation initiates a multipart upload and returns an upload ID.
|
default CompletableFuture<DeleteBucketResponse> |
deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest)
Deletes the S3 bucket.
|
default CompletableFuture<DeleteBucketResponse> |
deleteBucket(DeleteBucketRequest deleteBucketRequest)
Deletes the S3 bucket.
|
default CompletableFuture<DeleteBucketAnalyticsConfigurationResponse> |
deleteBucketAnalyticsConfiguration(Consumer<DeleteBucketAnalyticsConfigurationRequest.Builder> deleteBucketAnalyticsConfigurationRequest)
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
|
default CompletableFuture<DeleteBucketAnalyticsConfigurationResponse> |
deleteBucketAnalyticsConfiguration(DeleteBucketAnalyticsConfigurationRequest deleteBucketAnalyticsConfigurationRequest)
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
|
default CompletableFuture<DeleteBucketCorsResponse> |
deleteBucketCors(Consumer<DeleteBucketCorsRequest.Builder> deleteBucketCorsRequest)
Deletes the
cors configuration information set for the bucket. |
default CompletableFuture<DeleteBucketCorsResponse> |
deleteBucketCors(DeleteBucketCorsRequest deleteBucketCorsRequest)
Deletes the
cors configuration information set for the bucket. |
default CompletableFuture<DeleteBucketEncryptionResponse> |
deleteBucketEncryption(Consumer<DeleteBucketEncryptionRequest.Builder> deleteBucketEncryptionRequest)
This implementation of the DELETE operation removes default encryption from the bucket.
|
default CompletableFuture<DeleteBucketEncryptionResponse> |
deleteBucketEncryption(DeleteBucketEncryptionRequest deleteBucketEncryptionRequest)
This implementation of the DELETE operation removes default encryption from the bucket.
|
default CompletableFuture<DeleteBucketIntelligentTieringConfigurationResponse> |
deleteBucketIntelligentTieringConfiguration(Consumer<DeleteBucketIntelligentTieringConfigurationRequest.Builder> deleteBucketIntelligentTieringConfigurationRequest)
Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
|
default CompletableFuture<DeleteBucketIntelligentTieringConfigurationResponse> |
deleteBucketIntelligentTieringConfiguration(DeleteBucketIntelligentTieringConfigurationRequest deleteBucketIntelligentTieringConfigurationRequest)
Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
|
default CompletableFuture<DeleteBucketInventoryConfigurationResponse> |
deleteBucketInventoryConfiguration(Consumer<DeleteBucketInventoryConfigurationRequest.Builder> deleteBucketInventoryConfigurationRequest)
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
|
default CompletableFuture<DeleteBucketInventoryConfigurationResponse> |
deleteBucketInventoryConfiguration(DeleteBucketInventoryConfigurationRequest deleteBucketInventoryConfigurationRequest)
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
|
default CompletableFuture<DeleteBucketLifecycleResponse> |
deleteBucketLifecycle(Consumer<DeleteBucketLifecycleRequest.Builder> deleteBucketLifecycleRequest)
Deletes the lifecycle configuration from the specified bucket.
|
default CompletableFuture<DeleteBucketLifecycleResponse> |
deleteBucketLifecycle(DeleteBucketLifecycleRequest deleteBucketLifecycleRequest)
Deletes the lifecycle configuration from the specified bucket.
|
default CompletableFuture<DeleteBucketMetricsConfigurationResponse> |
deleteBucketMetricsConfiguration(Consumer<DeleteBucketMetricsConfigurationRequest.Builder> deleteBucketMetricsConfigurationRequest)
Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration
ID) from the bucket.
|
default CompletableFuture<DeleteBucketMetricsConfigurationResponse> |
deleteBucketMetricsConfiguration(DeleteBucketMetricsConfigurationRequest deleteBucketMetricsConfigurationRequest)
Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration
ID) from the bucket.
|
default CompletableFuture<DeleteBucketOwnershipControlsResponse> |
deleteBucketOwnershipControls(Consumer<DeleteBucketOwnershipControlsRequest.Builder> deleteBucketOwnershipControlsRequest)
Removes
OwnershipControls for an Amazon S3 bucket. |
default CompletableFuture<DeleteBucketOwnershipControlsResponse> |
deleteBucketOwnershipControls(DeleteBucketOwnershipControlsRequest deleteBucketOwnershipControlsRequest)
Removes
OwnershipControls for an Amazon S3 bucket. |
default CompletableFuture<DeleteBucketPolicyResponse> |
deleteBucketPolicy(Consumer<DeleteBucketPolicyRequest.Builder> deleteBucketPolicyRequest)
This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified
bucket.
|
default CompletableFuture<DeleteBucketPolicyResponse> |
deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest)
This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified
bucket.
|
default CompletableFuture<DeleteBucketReplicationResponse> |
deleteBucketReplication(Consumer<DeleteBucketReplicationRequest.Builder> deleteBucketReplicationRequest)
Deletes the replication configuration from the bucket.
|
default CompletableFuture<DeleteBucketReplicationResponse> |
deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest)
Deletes the replication configuration from the bucket.
|
default CompletableFuture<DeleteBucketTaggingResponse> |
deleteBucketTagging(Consumer<DeleteBucketTaggingRequest.Builder> deleteBucketTaggingRequest)
Deletes the tags from the bucket.
|
default CompletableFuture<DeleteBucketTaggingResponse> |
deleteBucketTagging(DeleteBucketTaggingRequest deleteBucketTaggingRequest)
Deletes the tags from the bucket.
|
default CompletableFuture<DeleteBucketWebsiteResponse> |
deleteBucketWebsite(Consumer<DeleteBucketWebsiteRequest.Builder> deleteBucketWebsiteRequest)
This operation removes the website configuration for a bucket.
|
default CompletableFuture<DeleteBucketWebsiteResponse> |
deleteBucketWebsite(DeleteBucketWebsiteRequest deleteBucketWebsiteRequest)
This operation removes the website configuration for a bucket.
|
default CompletableFuture<DeleteObjectResponse> |
deleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest)
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest
version of the object.
|
default CompletableFuture<DeleteObjectResponse> |
deleteObject(DeleteObjectRequest deleteObjectRequest)
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest
version of the object.
|
default CompletableFuture<DeleteObjectsResponse> |
deleteObjects(Consumer<DeleteObjectsRequest.Builder> deleteObjectsRequest)
This operation enables you to delete multiple objects from a bucket using a single HTTP request.
|
default CompletableFuture<DeleteObjectsResponse> |
deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
This operation enables you to delete multiple objects from a bucket using a single HTTP request.
|
default CompletableFuture<DeleteObjectTaggingResponse> |
deleteObjectTagging(Consumer<DeleteObjectTaggingRequest.Builder> deleteObjectTaggingRequest)
Removes the entire tag set from the specified object.
|
default CompletableFuture<DeleteObjectTaggingResponse> |
deleteObjectTagging(DeleteObjectTaggingRequest deleteObjectTaggingRequest)
Removes the entire tag set from the specified object.
|
default CompletableFuture<DeletePublicAccessBlockResponse> |
deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest)
Removes the
PublicAccessBlock configuration for an Amazon S3 bucket. |
default CompletableFuture<DeletePublicAccessBlockResponse> |
deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)
Removes the
PublicAccessBlock configuration for an Amazon S3 bucket. |
default CompletableFuture<GetBucketAccelerateConfigurationResponse> |
getBucketAccelerateConfiguration(Consumer<GetBucketAccelerateConfigurationRequest.Builder> getBucketAccelerateConfigurationRequest)
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 . |
default CompletableFuture<GetBucketAccelerateConfigurationResponse> |
getBucketAccelerateConfiguration(GetBucketAccelerateConfigurationRequest getBucketAccelerateConfigurationRequest)
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 . |
default CompletableFuture<GetBucketAclResponse> |
getBucketAcl(Consumer<GetBucketAclRequest.Builder> getBucketAclRequest)
This implementation of the
GET operation uses the acl subresource to return the access
control list (ACL) of a bucket. |
default CompletableFuture<GetBucketAclResponse> |
getBucketAcl(GetBucketAclRequest getBucketAclRequest)
This implementation of the
GET operation uses the acl subresource to return the access
control list (ACL) of a bucket. |
default CompletableFuture<GetBucketAnalyticsConfigurationResponse> |
getBucketAnalyticsConfiguration(Consumer<GetBucketAnalyticsConfigurationRequest.Builder> getBucketAnalyticsConfigurationRequest)
This implementation of the GET operation returns an analytics configuration (identified by the analytics
configuration ID) from the bucket.
|
default CompletableFuture<GetBucketAnalyticsConfigurationResponse> |
getBucketAnalyticsConfiguration(GetBucketAnalyticsConfigurationRequest getBucketAnalyticsConfigurationRequest)
This implementation of the GET operation returns an analytics configuration (identified by the analytics
configuration ID) from the bucket.
|
default CompletableFuture<GetBucketCorsResponse> |
getBucketCors(Consumer<GetBucketCorsRequest.Builder> getBucketCorsRequest)
Returns the cors configuration information set for the bucket.
|
default CompletableFuture<GetBucketCorsResponse> |
getBucketCors(GetBucketCorsRequest getBucketCorsRequest)
Returns the cors configuration information set for the bucket.
|
default CompletableFuture<GetBucketEncryptionResponse> |
getBucketEncryption(Consumer<GetBucketEncryptionRequest.Builder> getBucketEncryptionRequest)
Returns the default encryption configuration for an Amazon S3 bucket.
|
default CompletableFuture<GetBucketEncryptionResponse> |
getBucketEncryption(GetBucketEncryptionRequest getBucketEncryptionRequest)
Returns the default encryption configuration for an Amazon S3 bucket.
|
default CompletableFuture<GetBucketIntelligentTieringConfigurationResponse> |
getBucketIntelligentTieringConfiguration(Consumer<GetBucketIntelligentTieringConfigurationRequest.Builder> getBucketIntelligentTieringConfigurationRequest)
Gets the S3 Intelligent-Tiering configuration from the specified bucket.
|
default CompletableFuture<GetBucketIntelligentTieringConfigurationResponse> |
getBucketIntelligentTieringConfiguration(GetBucketIntelligentTieringConfigurationRequest getBucketIntelligentTieringConfigurationRequest)
Gets the S3 Intelligent-Tiering configuration from the specified bucket.
|
default CompletableFuture<GetBucketInventoryConfigurationResponse> |
getBucketInventoryConfiguration(Consumer<GetBucketInventoryConfigurationRequest.Builder> getBucketInventoryConfigurationRequest)
Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
|
default CompletableFuture<GetBucketInventoryConfigurationResponse> |
getBucketInventoryConfiguration(GetBucketInventoryConfigurationRequest getBucketInventoryConfigurationRequest)
Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
|
default CompletableFuture<GetBucketLifecycleConfigurationResponse> |
getBucketLifecycleConfiguration(Consumer<GetBucketLifecycleConfigurationRequest.Builder> getBucketLifecycleConfigurationRequest)
|
default CompletableFuture<GetBucketLifecycleConfigurationResponse> |
getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest)
|
default CompletableFuture<GetBucketLocationResponse> |
getBucketLocation(Consumer<GetBucketLocationRequest.Builder> getBucketLocationRequest)
Returns the Region the bucket resides in.
|
default CompletableFuture<GetBucketLocationResponse> |
getBucketLocation(GetBucketLocationRequest getBucketLocationRequest)
Returns the Region the bucket resides in.
|
default CompletableFuture<GetBucketLoggingResponse> |
getBucketLogging(Consumer<GetBucketLoggingRequest.Builder> getBucketLoggingRequest)
Returns the logging status of a bucket and the permissions users have to view and modify that status.
|
default CompletableFuture<GetBucketLoggingResponse> |
getBucketLogging(GetBucketLoggingRequest getBucketLoggingRequest)
Returns the logging status of a bucket and the permissions users have to view and modify that status.
|
default CompletableFuture<GetBucketMetricsConfigurationResponse> |
getBucketMetricsConfiguration(Consumer<GetBucketMetricsConfigurationRequest.Builder> getBucketMetricsConfigurationRequest)
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.
|
default CompletableFuture<GetBucketMetricsConfigurationResponse> |
getBucketMetricsConfiguration(GetBucketMetricsConfigurationRequest getBucketMetricsConfigurationRequest)
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket.
|
default CompletableFuture<GetBucketNotificationConfigurationResponse> |
getBucketNotificationConfiguration(Consumer<GetBucketNotificationConfigurationRequest.Builder> getBucketNotificationConfigurationRequest)
Returns the notification configuration of a bucket.
|
default CompletableFuture<GetBucketNotificationConfigurationResponse> |
getBucketNotificationConfiguration(GetBucketNotificationConfigurationRequest getBucketNotificationConfigurationRequest)
Returns the notification configuration of a bucket.
|
default CompletableFuture<GetBucketOwnershipControlsResponse> |
getBucketOwnershipControls(Consumer<GetBucketOwnershipControlsRequest.Builder> getBucketOwnershipControlsRequest)
Retrieves
OwnershipControls for an Amazon S3 bucket. |
default CompletableFuture<GetBucketOwnershipControlsResponse> |
getBucketOwnershipControls(GetBucketOwnershipControlsRequest getBucketOwnershipControlsRequest)
Retrieves
OwnershipControls for an Amazon S3 bucket. |
default CompletableFuture<GetBucketPolicyResponse> |
getBucketPolicy(Consumer<GetBucketPolicyRequest.Builder> getBucketPolicyRequest)
Returns the policy of a specified bucket.
|
default CompletableFuture<GetBucketPolicyResponse> |
getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)
Returns the policy of a specified bucket.
|
default CompletableFuture<GetBucketPolicyStatusResponse> |
getBucketPolicyStatus(Consumer<GetBucketPolicyStatusRequest.Builder> getBucketPolicyStatusRequest)
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
|
default CompletableFuture<GetBucketPolicyStatusResponse> |
getBucketPolicyStatus(GetBucketPolicyStatusRequest getBucketPolicyStatusRequest)
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public.
|
default CompletableFuture<GetBucketReplicationResponse> |
getBucketReplication(Consumer<GetBucketReplicationRequest.Builder> getBucketReplicationRequest)
Returns the replication configuration of a bucket.
|
default CompletableFuture<GetBucketReplicationResponse> |
getBucketReplication(GetBucketReplicationRequest getBucketReplicationRequest)
Returns the replication configuration of a bucket.
|
default CompletableFuture<GetBucketRequestPaymentResponse> |
getBucketRequestPayment(Consumer<GetBucketRequestPaymentRequest.Builder> getBucketRequestPaymentRequest)
Returns the request payment configuration of a bucket.
|
default CompletableFuture<GetBucketRequestPaymentResponse> |
getBucketRequestPayment(GetBucketRequestPaymentRequest getBucketRequestPaymentRequest)
Returns the request payment configuration of a bucket.
|
default CompletableFuture<GetBucketTaggingResponse> |
getBucketTagging(Consumer<GetBucketTaggingRequest.Builder> getBucketTaggingRequest)
Returns the tag set associated with the bucket.
|
default CompletableFuture<GetBucketTaggingResponse> |
getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest)
Returns the tag set associated with the bucket.
|
default CompletableFuture<GetBucketVersioningResponse> |
getBucketVersioning(Consumer<GetBucketVersioningRequest.Builder> getBucketVersioningRequest)
Returns the versioning state of a bucket.
|
default CompletableFuture<GetBucketVersioningResponse> |
getBucketVersioning(GetBucketVersioningRequest getBucketVersioningRequest)
Returns the versioning state of a bucket.
|
default CompletableFuture<GetBucketWebsiteResponse> |
getBucketWebsite(Consumer<GetBucketWebsiteRequest.Builder> getBucketWebsiteRequest)
Returns the website configuration for a bucket.
|
default CompletableFuture<GetBucketWebsiteResponse> |
getBucketWebsite(GetBucketWebsiteRequest getBucketWebsiteRequest)
Returns the website configuration for a bucket.
|
default <ReturnT> CompletableFuture<ReturnT> |
getObject(Consumer<GetObjectRequest.Builder> getObjectRequest,
AsyncResponseTransformer<GetObjectResponse,ReturnT> asyncResponseTransformer)
Retrieves objects from Amazon S3.
|
default CompletableFuture<GetObjectResponse> |
getObject(Consumer<GetObjectRequest.Builder> getObjectRequest,
Path destinationPath)
Retrieves objects from Amazon S3.
|
default <ReturnT> CompletableFuture<ReturnT> |
getObject(GetObjectRequest getObjectRequest,
AsyncResponseTransformer<GetObjectResponse,ReturnT> asyncResponseTransformer)
Retrieves objects from Amazon S3.
|
default CompletableFuture<GetObjectResponse> |
getObject(GetObjectRequest getObjectRequest,
Path destinationPath)
Retrieves objects from Amazon S3.
|
default CompletableFuture<GetObjectAclResponse> |
getObjectAcl(Consumer<GetObjectAclRequest.Builder> getObjectAclRequest)
Returns the access control list (ACL) of an object.
|
default CompletableFuture<GetObjectAclResponse> |
getObjectAcl(GetObjectAclRequest getObjectAclRequest)
Returns the access control list (ACL) of an object.
|
default CompletableFuture<GetObjectLegalHoldResponse> |
getObjectLegalHold(Consumer<GetObjectLegalHoldRequest.Builder> getObjectLegalHoldRequest)
Gets an object's current Legal Hold status.
|
default CompletableFuture<GetObjectLegalHoldResponse> |
getObjectLegalHold(GetObjectLegalHoldRequest getObjectLegalHoldRequest)
Gets an object's current Legal Hold status.
|
default CompletableFuture<GetObjectLockConfigurationResponse> |
getObjectLockConfiguration(Consumer<GetObjectLockConfigurationRequest.Builder> getObjectLockConfigurationRequest)
Gets the Object Lock configuration for a bucket.
|
default CompletableFuture<GetObjectLockConfigurationResponse> |
getObjectLockConfiguration(GetObjectLockConfigurationRequest getObjectLockConfigurationRequest)
Gets the Object Lock configuration for a bucket.
|
default CompletableFuture<GetObjectRetentionResponse> |
getObjectRetention(Consumer<GetObjectRetentionRequest.Builder> getObjectRetentionRequest)
Retrieves an object's retention settings.
|
default CompletableFuture<GetObjectRetentionResponse> |
getObjectRetention(GetObjectRetentionRequest getObjectRetentionRequest)
Retrieves an object's retention settings.
|
default CompletableFuture<GetObjectTaggingResponse> |
getObjectTagging(Consumer<GetObjectTaggingRequest.Builder> getObjectTaggingRequest)
Returns the tag-set of an object.
|
default CompletableFuture<GetObjectTaggingResponse> |
getObjectTagging(GetObjectTaggingRequest getObjectTaggingRequest)
Returns the tag-set of an object.
|
default <ReturnT> CompletableFuture<ReturnT> |
getObjectTorrent(Consumer<GetObjectTorrentRequest.Builder> getObjectTorrentRequest,
AsyncResponseTransformer<GetObjectTorrentResponse,ReturnT> asyncResponseTransformer)
Returns torrent files from a bucket.
|
default CompletableFuture<GetObjectTorrentResponse> |
getObjectTorrent(Consumer<GetObjectTorrentRequest.Builder> getObjectTorrentRequest,
Path destinationPath)
Returns torrent files from a bucket.
|
default <ReturnT> CompletableFuture<ReturnT> |
getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest,
AsyncResponseTransformer<GetObjectTorrentResponse,ReturnT> asyncResponseTransformer)
Returns torrent files from a bucket.
|
default CompletableFuture<GetObjectTorrentResponse> |
getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest,
Path destinationPath)
Returns torrent files from a bucket.
|
default CompletableFuture<GetPublicAccessBlockResponse> |
getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest)
Retrieves the
PublicAccessBlock configuration for an Amazon S3 bucket. |
default CompletableFuture<GetPublicAccessBlockResponse> |
getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest)
Retrieves the
PublicAccessBlock configuration for an Amazon S3 bucket. |
default CompletableFuture<HeadBucketResponse> |
headBucket(Consumer<HeadBucketRequest.Builder> headBucketRequest)
This operation is useful to determine if a bucket exists and you have permission to access it.
|
default CompletableFuture<HeadBucketResponse> |
headBucket(HeadBucketRequest headBucketRequest)
This operation is useful to determine if a bucket exists and you have permission to access it.
|
default CompletableFuture<HeadObjectResponse> |
headObject(Consumer<HeadObjectRequest.Builder> headObjectRequest)
The HEAD operation retrieves metadata from an object without returning the object itself.
|
default CompletableFuture<HeadObjectResponse> |
headObject(HeadObjectRequest headObjectRequest)
The HEAD operation retrieves metadata from an object without returning the object itself.
|
default CompletableFuture<ListBucketAnalyticsConfigurationsResponse> |
listBucketAnalyticsConfigurations(Consumer<ListBucketAnalyticsConfigurationsRequest.Builder> listBucketAnalyticsConfigurationsRequest)
Lists the analytics configurations for the bucket.
|
default CompletableFuture<ListBucketAnalyticsConfigurationsResponse> |
listBucketAnalyticsConfigurations(ListBucketAnalyticsConfigurationsRequest listBucketAnalyticsConfigurationsRequest)
Lists the analytics configurations for the bucket.
|
default CompletableFuture<ListBucketIntelligentTieringConfigurationsResponse> |
listBucketIntelligentTieringConfigurations(Consumer<ListBucketIntelligentTieringConfigurationsRequest.Builder> listBucketIntelligentTieringConfigurationsRequest)
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
|
default CompletableFuture<ListBucketIntelligentTieringConfigurationsResponse> |
listBucketIntelligentTieringConfigurations(ListBucketIntelligentTieringConfigurationsRequest listBucketIntelligentTieringConfigurationsRequest)
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
|
default CompletableFuture<ListBucketInventoryConfigurationsResponse> |
listBucketInventoryConfigurations(Consumer<ListBucketInventoryConfigurationsRequest.Builder> listBucketInventoryConfigurationsRequest)
Returns a list of inventory configurations for the bucket.
|
default CompletableFuture<ListBucketInventoryConfigurationsResponse> |
listBucketInventoryConfigurations(ListBucketInventoryConfigurationsRequest listBucketInventoryConfigurationsRequest)
Returns a list of inventory configurations for the bucket.
|
default CompletableFuture<ListBucketMetricsConfigurationsResponse> |
listBucketMetricsConfigurations(Consumer<ListBucketMetricsConfigurationsRequest.Builder> listBucketMetricsConfigurationsRequest)
Lists the metrics configurations for the bucket.
|
default CompletableFuture<ListBucketMetricsConfigurationsResponse> |
listBucketMetricsConfigurations(ListBucketMetricsConfigurationsRequest listBucketMetricsConfigurationsRequest)
Lists the metrics configurations for the bucket.
|
default CompletableFuture<ListBucketsResponse> |
listBuckets()
Returns a list of all buckets owned by the authenticated sender of the request.
|
default CompletableFuture<ListBucketsResponse> |
listBuckets(Consumer<ListBucketsRequest.Builder> listBucketsRequest)
Returns a list of all buckets owned by the authenticated sender of the request.
|
default CompletableFuture<ListBucketsResponse> |
listBuckets(ListBucketsRequest listBucketsRequest)
Returns a list of all buckets owned by the authenticated sender of the request.
|
default CompletableFuture<ListMultipartUploadsResponse> |
listMultipartUploads(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest)
This operation lists in-progress multipart uploads.
|
default CompletableFuture<ListMultipartUploadsResponse> |
listMultipartUploads(ListMultipartUploadsRequest listMultipartUploadsRequest)
This operation lists in-progress multipart uploads.
|
default ListMultipartUploadsPublisher |
listMultipartUploadsPaginator(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest)
This operation lists in-progress multipart uploads.
|
default ListMultipartUploadsPublisher |
listMultipartUploadsPaginator(ListMultipartUploadsRequest listMultipartUploadsRequest)
This operation lists in-progress multipart uploads.
|
default CompletableFuture<ListObjectsResponse> |
listObjects(Consumer<ListObjectsRequest.Builder> listObjectsRequest)
Returns some or all (up to 1,000) of the objects in a bucket.
|
default CompletableFuture<ListObjectsResponse> |
listObjects(ListObjectsRequest listObjectsRequest)
Returns some or all (up to 1,000) of the objects in a bucket.
|
default CompletableFuture<ListObjectsV2Response> |
listObjectsV2(Consumer<ListObjectsV2Request.Builder> listObjectsV2Request)
Returns some or all (up to 1,000) of the objects in a bucket.
|
default CompletableFuture<ListObjectsV2Response> |
listObjectsV2(ListObjectsV2Request listObjectsV2Request)
Returns some or all (up to 1,000) of the objects in a bucket.
|
default ListObjectsV2Publisher |
listObjectsV2Paginator(Consumer<ListObjectsV2Request.Builder> listObjectsV2Request)
Returns some or all (up to 1,000) of the objects in a bucket.
|
default ListObjectsV2Publisher |
listObjectsV2Paginator(ListObjectsV2Request listObjectsV2Request)
Returns some or all (up to 1,000) of the objects in a bucket.
|
default CompletableFuture<ListObjectVersionsResponse> |
listObjectVersions(Consumer<ListObjectVersionsRequest.Builder> listObjectVersionsRequest)
Returns metadata about all versions of the objects in a bucket.
|
default CompletableFuture<ListObjectVersionsResponse> |
listObjectVersions(ListObjectVersionsRequest listObjectVersionsRequest)
Returns metadata about all versions of the objects in a bucket.
|
default ListObjectVersionsPublisher |
listObjectVersionsPaginator(Consumer<ListObjectVersionsRequest.Builder> listObjectVersionsRequest)
Returns metadata about all versions of the objects in a bucket.
|
default ListObjectVersionsPublisher |
listObjectVersionsPaginator(ListObjectVersionsRequest listObjectVersionsRequest)
Returns metadata about all versions of the objects in a bucket.
|
default CompletableFuture<ListPartsResponse> |
listParts(Consumer<ListPartsRequest.Builder> listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload.
|
default CompletableFuture<ListPartsResponse> |
listParts(ListPartsRequest listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload.
|
default ListPartsPublisher |
listPartsPaginator(Consumer<ListPartsRequest.Builder> listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload.
|
default ListPartsPublisher |
listPartsPaginator(ListPartsRequest listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload.
|
default CompletableFuture<PutBucketAccelerateConfigurationResponse> |
putBucketAccelerateConfiguration(Consumer<PutBucketAccelerateConfigurationRequest.Builder> putBucketAccelerateConfigurationRequest)
Sets the accelerate configuration of an existing bucket.
|
default CompletableFuture<PutBucketAccelerateConfigurationResponse> |
putBucketAccelerateConfiguration(PutBucketAccelerateConfigurationRequest putBucketAccelerateConfigurationRequest)
Sets the accelerate configuration of an existing bucket.
|
default CompletableFuture<PutBucketAclResponse> |
putBucketAcl(Consumer<PutBucketAclRequest.Builder> putBucketAclRequest)
Sets the permissions on an existing bucket using access control lists (ACL).
|
default CompletableFuture<PutBucketAclResponse> |
putBucketAcl(PutBucketAclRequest putBucketAclRequest)
Sets the permissions on an existing bucket using access control lists (ACL).
|
default CompletableFuture<PutBucketAnalyticsConfigurationResponse> |
putBucketAnalyticsConfiguration(Consumer<PutBucketAnalyticsConfigurationRequest.Builder> putBucketAnalyticsConfigurationRequest)
Sets an analytics configuration for the bucket (specified by the analytics configuration ID).
|
default CompletableFuture<PutBucketAnalyticsConfigurationResponse> |
putBucketAnalyticsConfiguration(PutBucketAnalyticsConfigurationRequest putBucketAnalyticsConfigurationRequest)
Sets an analytics configuration for the bucket (specified by the analytics configuration ID).
|
default CompletableFuture<PutBucketCorsResponse> |
putBucketCors(Consumer<PutBucketCorsRequest.Builder> putBucketCorsRequest)
Sets the
cors configuration for your bucket. |
default CompletableFuture<PutBucketCorsResponse> |
putBucketCors(PutBucketCorsRequest putBucketCorsRequest)
Sets the
cors configuration for your bucket. |
default CompletableFuture<PutBucketEncryptionResponse> |
putBucketEncryption(Consumer<PutBucketEncryptionRequest.Builder> putBucketEncryptionRequest)
This implementation of the
PUT operation uses the encryption subresource to set the
default encryption state of an existing bucket. |
default CompletableFuture<PutBucketEncryptionResponse> |
putBucketEncryption(PutBucketEncryptionRequest putBucketEncryptionRequest)
This implementation of the
PUT operation uses the encryption subresource to set the
default encryption state of an existing bucket. |
default CompletableFuture<PutBucketIntelligentTieringConfigurationResponse> |
putBucketIntelligentTieringConfiguration(Consumer<PutBucketIntelligentTieringConfigurationRequest.Builder> putBucketIntelligentTieringConfigurationRequest)
Puts a S3 Intelligent-Tiering configuration to the specified bucket.
|
default CompletableFuture<PutBucketIntelligentTieringConfigurationResponse> |
putBucketIntelligentTieringConfiguration(PutBucketIntelligentTieringConfigurationRequest putBucketIntelligentTieringConfigurationRequest)
Puts a S3 Intelligent-Tiering configuration to the specified bucket.
|
default CompletableFuture<PutBucketInventoryConfigurationResponse> |
putBucketInventoryConfiguration(Consumer<PutBucketInventoryConfigurationRequest.Builder> putBucketInventoryConfigurationRequest)
This implementation of the
PUT operation adds an inventory configuration (identified by the
inventory ID) to the bucket. |
default CompletableFuture<PutBucketInventoryConfigurationResponse> |
putBucketInventoryConfiguration(PutBucketInventoryConfigurationRequest putBucketInventoryConfigurationRequest)
This implementation of the
PUT operation adds an inventory configuration (identified by the
inventory ID) to the bucket. |
default CompletableFuture<PutBucketLifecycleConfigurationResponse> |
putBucketLifecycleConfiguration(Consumer<PutBucketLifecycleConfigurationRequest.Builder> putBucketLifecycleConfigurationRequest)
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration.
|
default CompletableFuture<PutBucketLifecycleConfigurationResponse> |
putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest)
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration.
|
default CompletableFuture<PutBucketLoggingResponse> |
putBucketLogging(Consumer<PutBucketLoggingRequest.Builder> putBucketLoggingRequest)
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging
parameters.
|
default CompletableFuture<PutBucketLoggingResponse> |
putBucketLogging(PutBucketLoggingRequest putBucketLoggingRequest)
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging
parameters.
|
default CompletableFuture<PutBucketMetricsConfigurationResponse> |
putBucketMetricsConfiguration(Consumer<PutBucketMetricsConfigurationRequest.Builder> putBucketMetricsConfigurationRequest)
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
|
default CompletableFuture<PutBucketMetricsConfigurationResponse> |
putBucketMetricsConfiguration(PutBucketMetricsConfigurationRequest putBucketMetricsConfigurationRequest)
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket.
|
default CompletableFuture<PutBucketNotificationConfigurationResponse> |
putBucketNotificationConfiguration(Consumer<PutBucketNotificationConfigurationRequest.Builder> putBucketNotificationConfigurationRequest)
Enables notifications of specified events for a bucket.
|
default CompletableFuture<PutBucketNotificationConfigurationResponse> |
putBucketNotificationConfiguration(PutBucketNotificationConfigurationRequest putBucketNotificationConfigurationRequest)
Enables notifications of specified events for a bucket.
|
default CompletableFuture<PutBucketOwnershipControlsResponse> |
putBucketOwnershipControls(Consumer<PutBucketOwnershipControlsRequest.Builder> putBucketOwnershipControlsRequest)
Creates or modifies
OwnershipControls for an Amazon S3 bucket. |
default CompletableFuture<PutBucketOwnershipControlsResponse> |
putBucketOwnershipControls(PutBucketOwnershipControlsRequest putBucketOwnershipControlsRequest)
Creates or modifies
OwnershipControls for an Amazon S3 bucket. |
default CompletableFuture<PutBucketPolicyResponse> |
putBucketPolicy(Consumer<PutBucketPolicyRequest.Builder> putBucketPolicyRequest)
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
|
default CompletableFuture<PutBucketPolicyResponse> |
putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest)
Applies an Amazon S3 bucket policy to an Amazon S3 bucket.
|
default CompletableFuture<PutBucketReplicationResponse> |
putBucketReplication(Consumer<PutBucketReplicationRequest.Builder> putBucketReplicationRequest)
Creates a replication configuration or replaces an existing one.
|
default CompletableFuture<PutBucketReplicationResponse> |
putBucketReplication(PutBucketReplicationRequest putBucketReplicationRequest)
Creates a replication configuration or replaces an existing one.
|
default CompletableFuture<PutBucketRequestPaymentResponse> |
putBucketRequestPayment(Consumer<PutBucketRequestPaymentRequest.Builder> putBucketRequestPaymentRequest)
Sets the request payment configuration for a bucket.
|
default CompletableFuture<PutBucketRequestPaymentResponse> |
putBucketRequestPayment(PutBucketRequestPaymentRequest putBucketRequestPaymentRequest)
Sets the request payment configuration for a bucket.
|
default CompletableFuture<PutBucketTaggingResponse> |
putBucketTagging(Consumer<PutBucketTaggingRequest.Builder> putBucketTaggingRequest)
Sets the tags for a bucket.
|
default CompletableFuture<PutBucketTaggingResponse> |
putBucketTagging(PutBucketTaggingRequest putBucketTaggingRequest)
Sets the tags for a bucket.
|
default CompletableFuture<PutBucketVersioningResponse> |
putBucketVersioning(Consumer<PutBucketVersioningRequest.Builder> putBucketVersioningRequest)
Sets the versioning state of an existing bucket.
|
default CompletableFuture<PutBucketVersioningResponse> |
putBucketVersioning(PutBucketVersioningRequest putBucketVersioningRequest)
Sets the versioning state of an existing bucket.
|
default CompletableFuture<PutBucketWebsiteResponse> |
putBucketWebsite(Consumer<PutBucketWebsiteRequest.Builder> putBucketWebsiteRequest)
Sets the configuration of the website that is specified in the
website subresource. |
default CompletableFuture<PutBucketWebsiteResponse> |
putBucketWebsite(PutBucketWebsiteRequest putBucketWebsiteRequest)
Sets the configuration of the website that is specified in the
website subresource. |
default CompletableFuture<PutObjectResponse> |
putObject(Consumer<PutObjectRequest.Builder> putObjectRequest,
AsyncRequestBody requestBody)
Adds an object to a bucket.
|
default CompletableFuture<PutObjectResponse> |
putObject(Consumer<PutObjectRequest.Builder> putObjectRequest,
Path sourcePath)
Adds an object to a bucket.
|
default CompletableFuture<PutObjectResponse> |
putObject(PutObjectRequest putObjectRequest,
AsyncRequestBody requestBody)
Adds an object to a bucket.
|
default CompletableFuture<PutObjectResponse> |
putObject(PutObjectRequest putObjectRequest,
Path sourcePath)
Adds an object to a bucket.
|
default CompletableFuture<PutObjectAclResponse> |
putObjectAcl(Consumer<PutObjectAclRequest.Builder> putObjectAclRequest)
Uses the
acl subresource to set the access control list (ACL) permissions for a new or existing
object in an S3 bucket. |
default CompletableFuture<PutObjectAclResponse> |
putObjectAcl(PutObjectAclRequest putObjectAclRequest)
Uses the
acl subresource to set the access control list (ACL) permissions for a new or existing
object in an S3 bucket. |
default CompletableFuture<PutObjectLegalHoldResponse> |
putObjectLegalHold(Consumer<PutObjectLegalHoldRequest.Builder> putObjectLegalHoldRequest)
Applies a Legal Hold configuration to the specified object.
|
default CompletableFuture<PutObjectLegalHoldResponse> |
putObjectLegalHold(PutObjectLegalHoldRequest putObjectLegalHoldRequest)
Applies a Legal Hold configuration to the specified object.
|
default CompletableFuture<PutObjectLockConfigurationResponse> |
putObjectLockConfiguration(Consumer<PutObjectLockConfigurationRequest.Builder> putObjectLockConfigurationRequest)
Places an Object Lock configuration on the specified bucket.
|
default CompletableFuture<PutObjectLockConfigurationResponse> |
putObjectLockConfiguration(PutObjectLockConfigurationRequest putObjectLockConfigurationRequest)
Places an Object Lock configuration on the specified bucket.
|
default CompletableFuture<PutObjectRetentionResponse> |
putObjectRetention(Consumer<PutObjectRetentionRequest.Builder> putObjectRetentionRequest)
Places an Object Retention configuration on an object.
|
default CompletableFuture<PutObjectRetentionResponse> |
putObjectRetention(PutObjectRetentionRequest putObjectRetentionRequest)
Places an Object Retention configuration on an object.
|
default CompletableFuture<PutObjectTaggingResponse> |
putObjectTagging(Consumer<PutObjectTaggingRequest.Builder> putObjectTaggingRequest)
Sets the supplied tag-set to an object that already exists in a bucket.
|
default CompletableFuture<PutObjectTaggingResponse> |
putObjectTagging(PutObjectTaggingRequest putObjectTaggingRequest)
Sets the supplied tag-set to an object that already exists in a bucket.
|
default CompletableFuture<PutPublicAccessBlockResponse> |
putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest)
Creates or modifies the
PublicAccessBlock configuration for an Amazon S3 bucket. |
default CompletableFuture<PutPublicAccessBlockResponse> |
putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)
Creates or modifies the
PublicAccessBlock configuration for an Amazon S3 bucket. |
default CompletableFuture<RestoreObjectResponse> |
restoreObject(Consumer<RestoreObjectRequest.Builder> restoreObjectRequest)
Restores an archived copy of an object back into Amazon S3
|
default CompletableFuture<RestoreObjectResponse> |
restoreObject(RestoreObjectRequest restoreObjectRequest)
Restores an archived copy of an object back into Amazon S3
|
default CompletableFuture<UploadPartResponse> |
uploadPart(Consumer<UploadPartRequest.Builder> uploadPartRequest,
AsyncRequestBody requestBody)
Uploads a part in a multipart upload.
|
default CompletableFuture<UploadPartResponse> |
uploadPart(Consumer<UploadPartRequest.Builder> uploadPartRequest,
Path sourcePath)
Uploads a part in a multipart upload.
|
default CompletableFuture<UploadPartResponse> |
uploadPart(UploadPartRequest uploadPartRequest,
AsyncRequestBody requestBody)
Uploads a part in a multipart upload.
|
default CompletableFuture<UploadPartResponse> |
uploadPart(UploadPartRequest uploadPartRequest,
Path sourcePath)
Uploads a part in a multipart upload.
|
default CompletableFuture<UploadPartCopyResponse> |
uploadPartCopy(Consumer<UploadPartCopyRequest.Builder> uploadPartCopyRequest)
Uploads a part by copying data from an existing object as data source.
|
default CompletableFuture<UploadPartCopyResponse> |
uploadPartCopy(UploadPartCopyRequest uploadPartCopyRequest)
Uploads a part by copying data from an existing object as data source.
|
default S3Utilities |
utilities()
Creates an instance of
S3Utilities object with the configuration set on this client. |
default S3AsyncWaiter |
waiter()
Create an instance of
S3AsyncWaiter using this client. |
serviceName
close
static final String SERVICE_NAME
static S3AsyncClient create()
S3AsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static S3AsyncClientBuilder builder()
S3AsyncClient
.default CompletableFuture<AbortMultipartUploadResponse> abortMultipartUpload(AbortMultipartUploadRequest abortMultipartUploadRequest)
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
:
abortMultipartUploadRequest
- default CompletableFuture<AbortMultipartUploadResponse> abortMultipartUpload(Consumer<AbortMultipartUploadRequest.Builder> abortMultipartUploadRequest)
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
:
This is a convenience which creates an instance of the AbortMultipartUploadRequest.Builder
avoiding the
need to create one manually via AbortMultipartUploadRequest.builder()
abortMultipartUploadRequest
- A Consumer
that will call methods on AbortMultipartUploadRequest.Builder
to create a
request.default CompletableFuture<CompleteMultipartUploadResponse> completeMultipartUpload(CompleteMultipartUploadRequest completeMultipartUploadRequest)
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
:
completeMultipartUploadRequest
- default CompletableFuture<CompleteMultipartUploadResponse> completeMultipartUpload(Consumer<CompleteMultipartUploadRequest.Builder> completeMultipartUploadRequest)
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
:
This is a convenience which creates an instance of the CompleteMultipartUploadRequest.Builder
avoiding
the need to create one manually via CompleteMultipartUploadRequest.builder()
completeMultipartUploadRequest
- A Consumer
that will call methods on CompleteMultipartUploadRequest.Builder
to create a
request.default CompletableFuture<CopyObjectResponse> copyObject(CopyObjectRequest copyObjectRequest)
Creates a copy of an object that is already stored in Amazon S3.
You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic operation using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API.
All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.
A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the
files. If the error occurs before the copy operation starts, you receive a standard Amazon S3 error. If the error
occurs during the copy operation, the error response is embedded in the 200 OK
response. This means
that a 200 OK
response can contain either a success or an error. Design your application to parse
the contents of the response and handle it appropriately.
If the copy is successful, you receive a response with information about the copied object.
If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.
The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing.
Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a
transfer acceleration endpoint, you get a 400 Bad Request
error. For more information, see Transfer Acceleration.
Metadata
When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.
To specify whether you want the object metadata copied from the source object or replaced with metadata provided
in the request, you can optionally add the x-amz-metadata-directive
header. When you grant
permissions, you can use the s3:x-amz-metadata-directive
condition key to enforce certain metadata
behavior when objects are uploaded. For more information, see Specifying Conditions in a
Policy in the Amazon S3 Developer Guide. For a complete list of Amazon S3-specific condition keys, see
Actions, Resources, and Condition
Keys for Amazon S3.
x-amz-copy-source-if
Headers
To only copy an object under certain conditions, such as whether the Etag
matches or whether the
object was modified before or after a specified date, use the following request parameters:
x-amz-copy-source-if-match
x-amz-copy-source-if-none-match
x-amz-copy-source-if-unmodified-since
x-amz-copy-source-if-modified-since
If both the x-amz-copy-source-if-match
and x-amz-copy-source-if-unmodified-since
headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK
and copies the
data:
x-amz-copy-source-if-match
condition evaluates to true
x-amz-copy-source-if-unmodified-since
condition evaluates to false
If both the x-amz-copy-source-if-none-match
and x-amz-copy-source-if-modified-since
headers are present in the request and evaluate as follows, Amazon S3 returns the
412 Precondition Failed
response code:
x-amz-copy-source-if-none-match
condition evaluates to false
x-amz-copy-source-if-modified-since
condition evaluates to true
All headers with the x-amz-
prefix, including x-amz-copy-source
, must be signed.
Encryption
The source object that you are copying can be encrypted or unencrypted. The source object can be encrypted with server-side encryption using AWS managed encryption keys (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it.
You can optionally use the appropriate encryption-related headers to request server-side encryption for the target object. You have the option to provide your own encryption key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to encrypt the source object. You can even request encryption if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption.
Access Control List (ACL)-Specific Request Headers
When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.
Storage Class Options
You can use the CopyObject
operation to change the storage class of an object that is already stored
in Amazon S3 using the StorageClass
parameter. For more information, see Storage Classes in the
Amazon S3 Service Developer Guide.
Versioning
By default, x-amz-copy-source
identifies the current version of an object to copy. If the current
version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the
versionId
subresource.
If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being
copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID
of the copied object in the x-amz-version-id
response header in the response.
If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.
If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject.
The following operations are related to CopyObject
:
For more information, see Copying Objects.
copyObjectRequest
- default CompletableFuture<CopyObjectResponse> copyObject(Consumer<CopyObjectRequest.Builder> copyObjectRequest)
Creates a copy of an object that is already stored in Amazon S3.
You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic operation using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API.
All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.
A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the
files. If the error occurs before the copy operation starts, you receive a standard Amazon S3 error. If the error
occurs during the copy operation, the error response is embedded in the 200 OK
response. This means
that a 200 OK
response can contain either a success or an error. Design your application to parse
the contents of the response and handle it appropriately.
If the copy is successful, you receive a response with information about the copied object.
If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.
The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing.
Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a
transfer acceleration endpoint, you get a 400 Bad Request
error. For more information, see Transfer Acceleration.
Metadata
When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.
To specify whether you want the object metadata copied from the source object or replaced with metadata provided
in the request, you can optionally add the x-amz-metadata-directive
header. When you grant
permissions, you can use the s3:x-amz-metadata-directive
condition key to enforce certain metadata
behavior when objects are uploaded. For more information, see Specifying Conditions in a
Policy in the Amazon S3 Developer Guide. For a complete list of Amazon S3-specific condition keys, see
Actions, Resources, and Condition
Keys for Amazon S3.
x-amz-copy-source-if
Headers
To only copy an object under certain conditions, such as whether the Etag
matches or whether the
object was modified before or after a specified date, use the following request parameters:
x-amz-copy-source-if-match
x-amz-copy-source-if-none-match
x-amz-copy-source-if-unmodified-since
x-amz-copy-source-if-modified-since
If both the x-amz-copy-source-if-match
and x-amz-copy-source-if-unmodified-since
headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK
and copies the
data:
x-amz-copy-source-if-match
condition evaluates to true
x-amz-copy-source-if-unmodified-since
condition evaluates to false
If both the x-amz-copy-source-if-none-match
and x-amz-copy-source-if-modified-since
headers are present in the request and evaluate as follows, Amazon S3 returns the
412 Precondition Failed
response code:
x-amz-copy-source-if-none-match
condition evaluates to false
x-amz-copy-source-if-modified-since
condition evaluates to true
All headers with the x-amz-
prefix, including x-amz-copy-source
, must be signed.
Encryption
The source object that you are copying can be encrypted or unencrypted. The source object can be encrypted with server-side encryption using AWS managed encryption keys (SSE-S3 or SSE-KMS) or by using a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it.
You can optionally use the appropriate encryption-related headers to request server-side encryption for the target object. You have the option to provide your own encryption key or use SSE-S3 or SSE-KMS, regardless of the form of server-side encryption that was used to encrypt the source object. You can even request encryption if the source object was not encrypted. For more information about server-side encryption, see Using Server-Side Encryption.
Access Control List (ACL)-Specific Request Headers
When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.
Storage Class Options
You can use the CopyObject
operation to change the storage class of an object that is already stored
in Amazon S3 using the StorageClass
parameter. For more information, see Storage Classes in the
Amazon S3 Service Developer Guide.
Versioning
By default, x-amz-copy-source
identifies the current version of an object to copy. If the current
version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the
versionId
subresource.
If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being
copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID
of the copied object in the x-amz-version-id
response header in the response.
If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.
If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject.
The following operations are related to CopyObject
:
For more information, see Copying Objects.
This is a convenience which creates an instance of the CopyObjectRequest.Builder
avoiding the need to
create one manually via CopyObjectRequest.builder()
copyObjectRequest
- A Consumer
that will call methods on CopyObjectRequest.Builder
to create a request.default CompletableFuture<CreateBucketResponse> createBucket(CreateBucketRequest createBucketRequest)
Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.
Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Working with Amazon S3 buckets.
If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see Accessing a bucket.
If you send your create bucket request to the s3.amazonaws.com
endpoint, the request goes to the
us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the
Region, even if the location constraint in the request specifies another Region where the bucket is to be
created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to
handle 307 redirect. For more information, see Virtual hosting of buckets.
When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.
Specify a canned ACL using the x-amz-acl
request header. Amazon S3 supports a set of predefined
ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more
information, see Canned
ACL.
Specify access permissions explicitly using the x-amz-grant-read
, x-amz-grant-write
,
x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access control list (ACL) overview.
You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
emailAddress
– if the value specified is the email address of an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following x-amz-grant-read
header grants the AWS accounts identified by account IDs
permissions to read object data and its metadata:
x-amz-grant-read: id="11112222333", id="444455556666"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
The following operations are related to CreateBucket
:
createBucketRequest
- default CompletableFuture<CreateBucketResponse> createBucket(Consumer<CreateBucketRequest.Builder> createBucketRequest)
Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner.
Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Working with Amazon S3 buckets.
If you want to create an Amazon S3 on Outposts bucket, see Create Bucket.
By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see Accessing a bucket.
If you send your create bucket request to the s3.amazonaws.com
endpoint, the request goes to the
us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the
Region, even if the location constraint in the request specifies another Region where the bucket is to be
created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to
handle 307 redirect. For more information, see Virtual hosting of buckets.
When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers.
Specify a canned ACL using the x-amz-acl
request header. Amazon S3 supports a set of predefined
ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. For more
information, see Canned
ACL.
Specify access permissions explicitly using the x-amz-grant-read
, x-amz-grant-write
,
x-amz-grant-read-acp
, x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access control list (ACL) overview.
You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
emailAddress
– if the value specified is the email address of an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following x-amz-grant-read
header grants the AWS accounts identified by account IDs
permissions to read object data and its metadata:
x-amz-grant-read: id="11112222333", id="444455556666"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
The following operations are related to CreateBucket
:
This is a convenience which creates an instance of the CreateBucketRequest.Builder
avoiding the need to
create one manually via CreateBucketRequest.builder()
createBucketRequest
- A Consumer
that will call methods on CreateBucketRequest.Builder
to create a request.default CompletableFuture<CreateMultipartUploadResponse> createMultipartUpload(CreateMultipartUploadRequest createMultipartUploadRequest)
This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.
For more information about multipart uploads, see Multipart Upload Overview.
If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4).
After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.
You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it
writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption
key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption
keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must
match the headers you used in the request to initiate the upload by using CreateMultipartUpload
.
To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the
kms:Encrypt
, kms:Decrypt
, kms:ReEncrypt*
,
kms:GenerateDataKey*
, and kms:DescribeKey
actions on the key. These permissions are
required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the
multipart upload.
If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.
For more information, see Protecting Data Using Server-Side Encryption.
When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
Specify a canned ACL with the x-amz-acl
request header. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
,
x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. These parameters map to
the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key.
Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.
x-amz-server-side-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify x-amz-server-side-encryption:aws:kms
, but don't provide
x-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the AWS managed CMK in AWS KMS to
protect the data.
All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:
Specify a canned ACL (x-amz-acl
) — Amazon S3 supports a set of predefined ACLs, known as canned
ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:
x-amz-grant-read
x-amz-grant-write
x-amz-grant-read-acp
x-amz-grant-write-acp
x-amz-grant-full-control
You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
emailAddress
– if the value specified is the email address of an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following x-amz-grant-read
header grants the AWS accounts identified by account IDs
permissions to read object data and its metadata:
x-amz-grant-read: id="11112222333", id="444455556666"
The following operations are related to CreateMultipartUpload
:
createMultipartUploadRequest
- default CompletableFuture<CreateMultipartUploadResponse> createMultipartUpload(Consumer<CreateMultipartUploadRequest.Builder> createMultipartUploadRequest)
This operation initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart). You also include this upload ID in the final request to either complete or abort the multipart upload request.
For more information about multipart uploads, see Multipart Upload Overview.
If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort operation and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy.
For information about the permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4).
After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload.
You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it
writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption
key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption
keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart and UploadPartCopy requests must
match the headers you used in the request to initiate the upload by using CreateMultipartUpload
.
To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the
kms:Encrypt
, kms:Decrypt
, kms:ReEncrypt*
,
kms:GenerateDataKey*
, and kms:DescribeKey
actions on the key. These permissions are
required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the
multipart upload.
If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role.
For more information, see Protecting Data Using Server-Side Encryption.
When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers:
Specify a canned ACL with the x-amz-acl
request header. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
,
x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. These parameters map to
the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview.
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key.
Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) – If you want AWS to manage the keys used to encrypt data, specify the following headers in the request.
x-amz-server-side-encryption
x-amz-server-side-encryption-aws-kms-key-id
x-amz-server-side-encryption-context
If you specify x-amz-server-side-encryption:aws:kms
, but don't provide
x-amz-server-side-encryption-aws-kms-key-id
, Amazon S3 uses the AWS managed CMK in AWS KMS to
protect the data.
All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4.
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
Use customer-provided encryption keys – If you want to manage your own encryption keys, provide all the following headers in the request.
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS.
You also can use the following access control–related headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs. With this operation, you can grant access permissions using one of the following two methods:
Specify a canned ACL (x-amz-acl
) — Amazon S3 supports a set of predefined ACLs, known as canned
ACLs. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL.
Specify access permissions explicitly — To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview. In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use:
x-amz-grant-read
x-amz-grant-write
x-amz-grant-read-acp
x-amz-grant-write-acp
x-amz-grant-full-control
You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
emailAddress
– if the value specified is the email address of an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following x-amz-grant-read
header grants the AWS accounts identified by account IDs
permissions to read object data and its metadata:
x-amz-grant-read: id="11112222333", id="444455556666"
The following operations are related to CreateMultipartUpload
:
This is a convenience which creates an instance of the CreateMultipartUploadRequest.Builder
avoiding the
need to create one manually via CreateMultipartUploadRequest.builder()
createMultipartUploadRequest
- A Consumer
that will call methods on CreateMultipartUploadRequest.Builder
to create a
request.default CompletableFuture<DeleteBucketResponse> deleteBucket(DeleteBucketRequest deleteBucketRequest)
Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.
Related Resources
deleteBucketRequest
- default CompletableFuture<DeleteBucketResponse> deleteBucket(Consumer<DeleteBucketRequest.Builder> deleteBucketRequest)
Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted.
Related Resources
This is a convenience which creates an instance of the DeleteBucketRequest.Builder
avoiding the need to
create one manually via DeleteBucketRequest.builder()
deleteBucketRequest
- A Consumer
that will call methods on DeleteBucketRequest.Builder
to create a request.default CompletableFuture<DeleteBucketAnalyticsConfigurationResponse> deleteBucketAnalyticsConfiguration(DeleteBucketAnalyticsConfigurationRequest deleteBucketAnalyticsConfigurationRequest)
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to DeleteBucketAnalyticsConfiguration
:
deleteBucketAnalyticsConfigurationRequest
- default CompletableFuture<DeleteBucketAnalyticsConfigurationResponse> deleteBucketAnalyticsConfiguration(Consumer<DeleteBucketAnalyticsConfigurationRequest.Builder> deleteBucketAnalyticsConfigurationRequest)
Deletes an analytics configuration for the bucket (specified by the analytics configuration ID).
To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about the Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to DeleteBucketAnalyticsConfiguration
:
This is a convenience which creates an instance of the DeleteBucketAnalyticsConfigurationRequest.Builder
avoiding the need to create one manually via DeleteBucketAnalyticsConfigurationRequest.builder()
deleteBucketAnalyticsConfigurationRequest
- A Consumer
that will call methods on DeleteBucketAnalyticsConfigurationRequest.Builder
to
create a request.default CompletableFuture<DeleteBucketCorsResponse> deleteBucketCors(DeleteBucketCorsRequest deleteBucketCorsRequest)
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:
deleteBucketCorsRequest
- default CompletableFuture<DeleteBucketCorsResponse> deleteBucketCors(Consumer<DeleteBucketCorsRequest.Builder> deleteBucketCorsRequest)
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:
This is a convenience which creates an instance of the DeleteBucketCorsRequest.Builder
avoiding the need
to create one manually via DeleteBucketCorsRequest.builder()
deleteBucketCorsRequest
- A Consumer
that will call methods on DeleteBucketCorsRequest.Builder
to create a request.default CompletableFuture<DeleteBucketEncryptionResponse> deleteBucketEncryption(DeleteBucketEncryptionRequest deleteBucketEncryptionRequest)
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
deleteBucketEncryptionRequest
- default CompletableFuture<DeleteBucketEncryptionResponse> deleteBucketEncryption(Consumer<DeleteBucketEncryptionRequest.Builder> deleteBucketEncryptionRequest)
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
This is a convenience which creates an instance of the DeleteBucketEncryptionRequest.Builder
avoiding the
need to create one manually via DeleteBucketEncryptionRequest.builder()
deleteBucketEncryptionRequest
- A Consumer
that will call methods on DeleteBucketEncryptionRequest.Builder
to create a
request.default CompletableFuture<DeleteBucketIntelligentTieringConfigurationResponse> deleteBucketIntelligentTieringConfiguration(DeleteBucketIntelligentTieringConfigurationRequest deleteBucketIntelligentTieringConfigurationRequest)
Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to DeleteBucketIntelligentTieringConfiguration
include:
deleteBucketIntelligentTieringConfigurationRequest
- default CompletableFuture<DeleteBucketIntelligentTieringConfigurationResponse> deleteBucketIntelligentTieringConfiguration(Consumer<DeleteBucketIntelligentTieringConfigurationRequest.Builder> deleteBucketIntelligentTieringConfigurationRequest)
Deletes the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to DeleteBucketIntelligentTieringConfiguration
include:
This is a convenience which creates an instance of the
DeleteBucketIntelligentTieringConfigurationRequest.Builder
avoiding the need to create one manually via
DeleteBucketIntelligentTieringConfigurationRequest.builder()
deleteBucketIntelligentTieringConfigurationRequest
- A Consumer
that will call methods on
DeleteBucketIntelligentTieringConfigurationRequest.Builder
to create a request.default CompletableFuture<DeleteBucketInventoryConfigurationResponse> deleteBucketInventoryConfiguration(DeleteBucketInventoryConfigurationRequest deleteBucketInventoryConfigurationRequest)
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
Operations related to DeleteBucketInventoryConfiguration
include:
deleteBucketInventoryConfigurationRequest
- default CompletableFuture<DeleteBucketInventoryConfigurationResponse> deleteBucketInventoryConfiguration(Consumer<DeleteBucketInventoryConfigurationRequest.Builder> deleteBucketInventoryConfigurationRequest)
Deletes an inventory configuration (identified by the inventory ID) from the bucket.
To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
Operations related to DeleteBucketInventoryConfiguration
include:
This is a convenience which creates an instance of the DeleteBucketInventoryConfigurationRequest.Builder
avoiding the need to create one manually via DeleteBucketInventoryConfigurationRequest.builder()
deleteBucketInventoryConfigurationRequest
- A Consumer
that will call methods on DeleteBucketInventoryConfigurationRequest.Builder
to
create a request.default CompletableFuture<DeleteBucketLifecycleResponse> deleteBucketLifecycle(DeleteBucketLifecycleRequest deleteBucketLifecycleRequest)
Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.
To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration
action.
By default, the bucket owner has this permission and the bucket owner can grant this permission to others.
There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.
For more information about the object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
deleteBucketLifecycleRequest
- default CompletableFuture<DeleteBucketLifecycleResponse> deleteBucketLifecycle(Consumer<DeleteBucketLifecycleRequest.Builder> deleteBucketLifecycleRequest)
Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration.
To use this operation, you must have permission to perform the s3:PutLifecycleConfiguration
action.
By default, the bucket owner has this permission and the bucket owner can grant this permission to others.
There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems.
For more information about the object expiration, see Elements to Describe Lifecycle Actions.
Related actions include:
This is a convenience which creates an instance of the DeleteBucketLifecycleRequest.Builder
avoiding the
need to create one manually via DeleteBucketLifecycleRequest.builder()
deleteBucketLifecycleRequest
- A Consumer
that will call methods on DeleteBucketLifecycleRequest.Builder
to create a
request.default CompletableFuture<DeleteBucketMetricsConfigurationResponse> deleteBucketMetricsConfiguration(DeleteBucketMetricsConfigurationRequest deleteBucketMetricsConfigurationRequest)
Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.
To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to DeleteBucketMetricsConfiguration
:
deleteBucketMetricsConfigurationRequest
- default CompletableFuture<DeleteBucketMetricsConfigurationResponse> deleteBucketMetricsConfiguration(Consumer<DeleteBucketMetricsConfigurationRequest.Builder> deleteBucketMetricsConfigurationRequest)
Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.
To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to DeleteBucketMetricsConfiguration
:
This is a convenience which creates an instance of the DeleteBucketMetricsConfigurationRequest.Builder
avoiding the need to create one manually via DeleteBucketMetricsConfigurationRequest.builder()
deleteBucketMetricsConfigurationRequest
- A Consumer
that will call methods on DeleteBucketMetricsConfigurationRequest.Builder
to
create a request.default CompletableFuture<DeleteBucketOwnershipControlsResponse> deleteBucketOwnershipControls(DeleteBucketOwnershipControlsRequest deleteBucketOwnershipControlsRequest)
Removes OwnershipControls
for an Amazon S3 bucket. To use this operation, you must have the
s3:PutBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a
Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to DeleteBucketOwnershipControls
:
deleteBucketOwnershipControlsRequest
- default CompletableFuture<DeleteBucketOwnershipControlsResponse> deleteBucketOwnershipControls(Consumer<DeleteBucketOwnershipControlsRequest.Builder> deleteBucketOwnershipControlsRequest)
Removes OwnershipControls
for an Amazon S3 bucket. To use this operation, you must have the
s3:PutBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a
Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to DeleteBucketOwnershipControls
:
This is a convenience which creates an instance of the DeleteBucketOwnershipControlsRequest.Builder
avoiding the need to create one manually via DeleteBucketOwnershipControlsRequest.builder()
deleteBucketOwnershipControlsRequest
- A Consumer
that will call methods on DeleteBucketOwnershipControlsRequest.Builder
to
create a request.default CompletableFuture<DeleteBucketPolicyResponse> deleteBucketPolicy(DeleteBucketPolicyRequest deleteBucketPolicyRequest)
This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified
bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the
calling identity must have the DeleteBucketPolicy
permissions on the specified bucket and belong to
the bucket owner's account to use this operation.
If you don't have DeleteBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed
error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and UserPolicies.
The following operations are related to DeleteBucketPolicy
deleteBucketPolicyRequest
- default CompletableFuture<DeleteBucketPolicyResponse> deleteBucketPolicy(Consumer<DeleteBucketPolicyRequest.Builder> deleteBucketPolicyRequest)
This implementation of the DELETE operation uses the policy subresource to delete the policy of a specified
bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the
calling identity must have the DeleteBucketPolicy
permissions on the specified bucket and belong to
the bucket owner's account to use this operation.
If you don't have DeleteBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed
error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and UserPolicies.
The following operations are related to DeleteBucketPolicy
This is a convenience which creates an instance of the DeleteBucketPolicyRequest.Builder
avoiding the
need to create one manually via DeleteBucketPolicyRequest.builder()
deleteBucketPolicyRequest
- A Consumer
that will call methods on DeleteBucketPolicyRequest.Builder
to create a
request.default CompletableFuture<DeleteBucketReplicationResponse> deleteBucketReplication(DeleteBucketReplicationRequest deleteBucketReplicationRequest)
Deletes the replication configuration from the bucket.
To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration
action. The bucket owner has these permissions by default and can grant it to others. For more information about
permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
It can take a while for the deletion of a replication configuration to fully propagate.
For information about replication configuration, see Replication in the Amazon S3 Developer Guide.
The following operations are related to DeleteBucketReplication
:
deleteBucketReplicationRequest
- default CompletableFuture<DeleteBucketReplicationResponse> deleteBucketReplication(Consumer<DeleteBucketReplicationRequest.Builder> deleteBucketReplicationRequest)
Deletes the replication configuration from the bucket.
To use this operation, you must have permissions to perform the s3:PutReplicationConfiguration
action. The bucket owner has these permissions by default and can grant it to others. For more information about
permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
It can take a while for the deletion of a replication configuration to fully propagate.
For information about replication configuration, see Replication in the Amazon S3 Developer Guide.
The following operations are related to DeleteBucketReplication
:
This is a convenience which creates an instance of the DeleteBucketReplicationRequest.Builder
avoiding
the need to create one manually via DeleteBucketReplicationRequest.builder()
deleteBucketReplicationRequest
- A Consumer
that will call methods on DeleteBucketReplicationRequest.Builder
to create a
request.default CompletableFuture<DeleteBucketTaggingResponse> deleteBucketTagging(DeleteBucketTaggingRequest deleteBucketTaggingRequest)
Deletes the tags from the bucket.
To use this operation, you must have permission to perform the s3:PutBucketTagging
action. By
default, the bucket owner has this permission and can grant this permission to others.
The following operations are related to DeleteBucketTagging
:
deleteBucketTaggingRequest
- default CompletableFuture<DeleteBucketTaggingResponse> deleteBucketTagging(Consumer<DeleteBucketTaggingRequest.Builder> deleteBucketTaggingRequest)
Deletes the tags from the bucket.
To use this operation, you must have permission to perform the s3:PutBucketTagging
action. By
default, the bucket owner has this permission and can grant this permission to others.
The following operations are related to DeleteBucketTagging
:
This is a convenience which creates an instance of the DeleteBucketTaggingRequest.Builder
avoiding the
need to create one manually via DeleteBucketTaggingRequest.builder()
deleteBucketTaggingRequest
- A Consumer
that will call methods on DeleteBucketTaggingRequest.Builder
to create a
request.default CompletableFuture<DeleteBucketWebsiteResponse> deleteBucketWebsite(DeleteBucketWebsiteRequest deleteBucketWebsiteRequest)
This operation removes the website configuration for a bucket. Amazon S3 returns a 200 OK
response
upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK
response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a
404
response if the bucket specified in the request does not exist.
This DELETE operation requires the S3:DeleteBucketWebsite
permission. By default, only the bucket
owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users
permission to delete the website configuration by writing a bucket policy granting them the
S3:DeleteBucketWebsite
permission.
For more information about hosting websites, see Hosting Websites on Amazon S3.
The following operations are related to DeleteBucketWebsite
:
deleteBucketWebsiteRequest
- default CompletableFuture<DeleteBucketWebsiteResponse> deleteBucketWebsite(Consumer<DeleteBucketWebsiteRequest.Builder> deleteBucketWebsiteRequest)
This operation removes the website configuration for a bucket. Amazon S3 returns a 200 OK
response
upon successfully deleting a website configuration on the specified bucket. You will get a 200 OK
response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a
404
response if the bucket specified in the request does not exist.
This DELETE operation requires the S3:DeleteBucketWebsite
permission. By default, only the bucket
owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users
permission to delete the website configuration by writing a bucket policy granting them the
S3:DeleteBucketWebsite
permission.
For more information about hosting websites, see Hosting Websites on Amazon S3.
The following operations are related to DeleteBucketWebsite
:
This is a convenience which creates an instance of the DeleteBucketWebsiteRequest.Builder
avoiding the
need to create one manually via DeleteBucketWebsiteRequest.builder()
deleteBucketWebsiteRequest
- A Consumer
that will call methods on DeleteBucketWebsiteRequest.Builder
to create a
request.default CompletableFuture<DeleteObjectResponse> deleteObject(DeleteObjectRequest deleteObjectRequest)
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.
To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using
this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the
response header, x-amz-delete-marker
, to true.
If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled,
you must include the x-amz-mfa
request header in the DELETE versionId
request. Requests
that include x-amz-mfa
must use HTTPS.
For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.
You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) to
enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects
from your bucket, you must deny them the s3:DeleteObject
, s3:DeleteObjectVersion
, and
s3:PutLifeCycleConfiguration
actions.
The following operation is related to DeleteObject
:
deleteObjectRequest
- default CompletableFuture<DeleteObjectResponse> deleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest)
Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects.
To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using
this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the
response header, x-amz-delete-marker
, to true.
If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled,
you must include the x-amz-mfa
request header in the DELETE versionId
request. Requests
that include x-amz-mfa
must use HTTPS.
For more information about MFA Delete, see Using MFA Delete. To see sample requests that use versioning, see Sample Request.
You can delete objects by explicitly calling the DELETE Object API or configure its lifecycle (PutBucketLifecycle) to
enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects
from your bucket, you must deny them the s3:DeleteObject
, s3:DeleteObjectVersion
, and
s3:PutLifeCycleConfiguration
actions.
The following operation is related to DeleteObject
:
This is a convenience which creates an instance of the DeleteObjectRequest.Builder
avoiding the need to
create one manually via DeleteObjectRequest.builder()
deleteObjectRequest
- A Consumer
that will call methods on DeleteObjectRequest.Builder
to create a request.default CompletableFuture<DeleteObjectTaggingResponse> deleteObjectTagging(DeleteObjectTaggingRequest deleteObjectTaggingRequest)
Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.
To use this operation, you must have permission to perform the s3:DeleteObjectTagging
action.
To delete tags of a specific object version, add the versionId
query parameter in the request. You
will need permission for the s3:DeleteObjectVersionTagging
action.
The following operations are related to DeleteBucketMetricsConfiguration
:
deleteObjectTaggingRequest
- default CompletableFuture<DeleteObjectTaggingResponse> deleteObjectTagging(Consumer<DeleteObjectTaggingRequest.Builder> deleteObjectTaggingRequest)
Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging.
To use this operation, you must have permission to perform the s3:DeleteObjectTagging
action.
To delete tags of a specific object version, add the versionId
query parameter in the request. You
will need permission for the s3:DeleteObjectVersionTagging
action.
The following operations are related to DeleteBucketMetricsConfiguration
:
This is a convenience which creates an instance of the DeleteObjectTaggingRequest.Builder
avoiding the
need to create one manually via DeleteObjectTaggingRequest.builder()
deleteObjectTaggingRequest
- A Consumer
that will call methods on DeleteObjectTaggingRequest.Builder
to create a
request.default CompletableFuture<DeleteObjectsResponse> deleteObjects(DeleteObjectsRequest deleteObjectsRequest)
This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.
The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.
The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body.
When performing this operation on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete.
Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.
The following operations are related to DeleteObjects
:
deleteObjectsRequest
- default CompletableFuture<DeleteObjectsResponse> deleteObjects(Consumer<DeleteObjectsRequest.Builder> deleteObjectsRequest)
This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.
The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete operation and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted.
The operation supports two modes for the response: verbose and quiet. By default, the operation uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete operation encountered an error. For a successful deletion, the operation does not return any information about the delete in the response body.
When performing this operation on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete.
Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit.
The following operations are related to DeleteObjects
:
This is a convenience which creates an instance of the DeleteObjectsRequest.Builder
avoiding the need to
create one manually via DeleteObjectsRequest.builder()
deleteObjectsRequest
- A Consumer
that will call methods on DeleteObjectsRequest.Builder
to create a request.default CompletableFuture<DeletePublicAccessBlockResponse> deletePublicAccessBlock(DeletePublicAccessBlockRequest deletePublicAccessBlockRequest)
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
:
deletePublicAccessBlockRequest
- default CompletableFuture<DeletePublicAccessBlockResponse> deletePublicAccessBlock(Consumer<DeletePublicAccessBlockRequest.Builder> deletePublicAccessBlockRequest)
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
:
This is a convenience which creates an instance of the DeletePublicAccessBlockRequest.Builder
avoiding
the need to create one manually via DeletePublicAccessBlockRequest.builder()
deletePublicAccessBlockRequest
- A Consumer
that will call methods on DeletePublicAccessBlockRequest.Builder
to create a
request.default CompletableFuture<GetBucketAccelerateConfigurationResponse> getBucketAccelerateConfiguration(GetBucketAccelerateConfigurationRequest getBucketAccelerateConfigurationRequest)
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
getBucketAccelerateConfigurationRequest
- default CompletableFuture<GetBucketAccelerateConfigurationResponse> getBucketAccelerateConfiguration(Consumer<GetBucketAccelerateConfigurationRequest.Builder> getBucketAccelerateConfigurationRequest)
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
This is a convenience which creates an instance of the GetBucketAccelerateConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketAccelerateConfigurationRequest.builder()
getBucketAccelerateConfigurationRequest
- A Consumer
that will call methods on GetBucketAccelerateConfigurationRequest.Builder
to
create a request.default CompletableFuture<GetBucketAclResponse> getBucketAcl(GetBucketAclRequest getBucketAclRequest)
This implementation of the GET
operation uses the acl
subresource to return the access
control list (ACL) of a bucket. To use GET
to return the ACL of the bucket, you must have
READ_ACP
access to the bucket. If READ_ACP
permission is granted to the anonymous user,
you can return the ACL of the bucket without using an authorization header.
Related Resources
getBucketAclRequest
- default CompletableFuture<GetBucketAclResponse> getBucketAcl(Consumer<GetBucketAclRequest.Builder> getBucketAclRequest)
This implementation of the GET
operation uses the acl
subresource to return the access
control list (ACL) of a bucket. To use GET
to return the ACL of the bucket, you must have
READ_ACP
access to the bucket. If READ_ACP
permission is granted to the anonymous user,
you can return the ACL of the bucket without using an authorization header.
Related Resources
This is a convenience which creates an instance of the GetBucketAclRequest.Builder
avoiding the need to
create one manually via GetBucketAclRequest.builder()
getBucketAclRequest
- A Consumer
that will call methods on GetBucketAclRequest.Builder
to create a request.default CompletableFuture<GetBucketAnalyticsConfigurationResponse> getBucketAnalyticsConfiguration(GetBucketAnalyticsConfigurationRequest getBucketAnalyticsConfigurationRequest)
This implementation of the GET operation returns an analytics configuration (identified by the analytics configuration ID) from the bucket.
To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon Simple Storage Service Developer Guide.
Related Resources
getBucketAnalyticsConfigurationRequest
- default CompletableFuture<GetBucketAnalyticsConfigurationResponse> getBucketAnalyticsConfiguration(Consumer<GetBucketAnalyticsConfigurationRequest.Builder> getBucketAnalyticsConfigurationRequest)
This implementation of the GET operation returns an analytics configuration (identified by the analytics configuration ID) from the bucket.
To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis in the Amazon Simple Storage Service Developer Guide.
Related Resources
This is a convenience which creates an instance of the GetBucketAnalyticsConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketAnalyticsConfigurationRequest.builder()
getBucketAnalyticsConfigurationRequest
- A Consumer
that will call methods on GetBucketAnalyticsConfigurationRequest.Builder
to
create a request.default CompletableFuture<GetBucketCorsResponse> getBucketCors(GetBucketCorsRequest getBucketCorsRequest)
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
:
getBucketCorsRequest
- default CompletableFuture<GetBucketCorsResponse> getBucketCors(Consumer<GetBucketCorsRequest.Builder> getBucketCorsRequest)
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
:
This is a convenience which creates an instance of the GetBucketCorsRequest.Builder
avoiding the need to
create one manually via GetBucketCorsRequest.builder()
getBucketCorsRequest
- A Consumer
that will call methods on GetBucketCorsRequest.Builder
to create a request.default CompletableFuture<GetBucketEncryptionResponse> getBucketEncryption(GetBucketEncryptionRequest getBucketEncryptionRequest)
Returns the default encryption configuration for an Amazon S3 bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.
To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration
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 following operations are related to GetBucketEncryption
:
getBucketEncryptionRequest
- default CompletableFuture<GetBucketEncryptionResponse> getBucketEncryption(Consumer<GetBucketEncryptionRequest.Builder> getBucketEncryptionRequest)
Returns the default encryption configuration for an Amazon S3 bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption.
To use this operation, you must have permission to perform the s3:GetEncryptionConfiguration
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 following operations are related to GetBucketEncryption
:
This is a convenience which creates an instance of the GetBucketEncryptionRequest.Builder
avoiding the
need to create one manually via GetBucketEncryptionRequest.builder()
getBucketEncryptionRequest
- A Consumer
that will call methods on GetBucketEncryptionRequest.Builder
to create a
request.default CompletableFuture<GetBucketIntelligentTieringConfigurationResponse> getBucketIntelligentTieringConfiguration(GetBucketIntelligentTieringConfigurationRequest getBucketIntelligentTieringConfigurationRequest)
Gets the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to GetBucketIntelligentTieringConfiguration
include:
getBucketIntelligentTieringConfigurationRequest
- default CompletableFuture<GetBucketIntelligentTieringConfigurationResponse> getBucketIntelligentTieringConfiguration(Consumer<GetBucketIntelligentTieringConfigurationRequest.Builder> getBucketIntelligentTieringConfigurationRequest)
Gets the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to GetBucketIntelligentTieringConfiguration
include:
This is a convenience which creates an instance of the
GetBucketIntelligentTieringConfigurationRequest.Builder
avoiding the need to create one manually via
GetBucketIntelligentTieringConfigurationRequest.builder()
getBucketIntelligentTieringConfigurationRequest
- A Consumer
that will call methods on
GetBucketIntelligentTieringConfigurationRequest.Builder
to create a request.default CompletableFuture<GetBucketInventoryConfigurationResponse> getBucketInventoryConfiguration(GetBucketInventoryConfigurationRequest getBucketInventoryConfigurationRequest)
Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration
action.
The bucket owner has this permission by default and can grant this permission to others. For more information
about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
The following operations are related to GetBucketInventoryConfiguration
:
getBucketInventoryConfigurationRequest
- default CompletableFuture<GetBucketInventoryConfigurationResponse> getBucketInventoryConfiguration(Consumer<GetBucketInventoryConfigurationRequest.Builder> getBucketInventoryConfigurationRequest)
Returns an inventory configuration (identified by the inventory configuration ID) from the bucket.
To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration
action.
The bucket owner has this permission by default and can grant this permission to others. For more information
about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory.
The following operations are related to GetBucketInventoryConfiguration
:
This is a convenience which creates an instance of the GetBucketInventoryConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketInventoryConfigurationRequest.builder()
getBucketInventoryConfigurationRequest
- A Consumer
that will call methods on GetBucketInventoryConfigurationRequest.Builder
to
create a request.default CompletableFuture<GetBucketLifecycleConfigurationResponse> getBucketLifecycleConfiguration(GetBucketLifecycleConfigurationRequest getBucketLifecycleConfigurationRequest)
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier API description, see GetBucketLifecycle.
Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration
action.
The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
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
:
getBucketLifecycleConfigurationRequest
- default CompletableFuture<GetBucketLifecycleConfigurationResponse> getBucketLifecycleConfiguration(Consumer<GetBucketLifecycleConfigurationRequest.Builder> getBucketLifecycleConfigurationRequest)
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier API description, see GetBucketLifecycle.
Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management.
To use this operation, you must have permission to perform the s3:GetLifecycleConfiguration
action.
The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
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
:
This is a convenience which creates an instance of the GetBucketLifecycleConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketLifecycleConfigurationRequest.builder()
getBucketLifecycleConfigurationRequest
- A Consumer
that will call methods on GetBucketLifecycleConfigurationRequest.Builder
to
create a request.default CompletableFuture<GetBucketLocationResponse> getBucketLocation(GetBucketLocationRequest getBucketLocationRequest)
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
:
getBucketLocationRequest
- default CompletableFuture<GetBucketLocationResponse> getBucketLocation(Consumer<GetBucketLocationRequest.Builder> getBucketLocationRequest)
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
:
This is a convenience which creates an instance of the GetBucketLocationRequest.Builder
avoiding the need
to create one manually via GetBucketLocationRequest.builder()
getBucketLocationRequest
- A Consumer
that will call methods on GetBucketLocationRequest.Builder
to create a request.default CompletableFuture<GetBucketLoggingResponse> getBucketLogging(GetBucketLoggingRequest getBucketLoggingRequest)
Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.
The following operations are related to GetBucketLogging
:
getBucketLoggingRequest
- default CompletableFuture<GetBucketLoggingResponse> getBucketLogging(Consumer<GetBucketLoggingRequest.Builder> getBucketLoggingRequest)
Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner.
The following operations are related to GetBucketLogging
:
This is a convenience which creates an instance of the GetBucketLoggingRequest.Builder
avoiding the need
to create one manually via GetBucketLoggingRequest.builder()
getBucketLoggingRequest
- A Consumer
that will call methods on GetBucketLoggingRequest.Builder
to create a request.default CompletableFuture<GetBucketMetricsConfigurationResponse> getBucketMetricsConfiguration(GetBucketMetricsConfigurationRequest getBucketMetricsConfigurationRequest)
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.
To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to GetBucketMetricsConfiguration
:
getBucketMetricsConfigurationRequest
- default CompletableFuture<GetBucketMetricsConfigurationResponse> getBucketMetricsConfiguration(Consumer<GetBucketMetricsConfigurationRequest.Builder> getBucketMetricsConfigurationRequest)
Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics.
To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to GetBucketMetricsConfiguration
:
This is a convenience which creates an instance of the GetBucketMetricsConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketMetricsConfigurationRequest.builder()
getBucketMetricsConfigurationRequest
- A Consumer
that will call methods on GetBucketMetricsConfigurationRequest.Builder
to
create a request.default CompletableFuture<GetBucketNotificationConfigurationResponse> getBucketNotificationConfiguration(GetBucketNotificationConfigurationRequest getBucketNotificationConfigurationRequest)
Returns the notification configuration of a bucket.
If notifications are not enabled on the bucket, the operation returns an empty
NotificationConfiguration
element.
By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket
owner can use a bucket policy to grant permission to other users to read this configuration with the
s3:GetBucketNotification
permission.
For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.
The following operation is related to GetBucketNotification
:
getBucketNotificationConfigurationRequest
- default CompletableFuture<GetBucketNotificationConfigurationResponse> getBucketNotificationConfiguration(Consumer<GetBucketNotificationConfigurationRequest.Builder> getBucketNotificationConfigurationRequest)
Returns the notification configuration of a bucket.
If notifications are not enabled on the bucket, the operation returns an empty
NotificationConfiguration
element.
By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket
owner can use a bucket policy to grant permission to other users to read this configuration with the
s3:GetBucketNotification
permission.
For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events. For more information about bucket policies, see Using Bucket Policies.
The following operation is related to GetBucketNotification
:
This is a convenience which creates an instance of the GetBucketNotificationConfigurationRequest.Builder
avoiding the need to create one manually via GetBucketNotificationConfigurationRequest.builder()
getBucketNotificationConfigurationRequest
- A Consumer
that will call methods on GetBucketNotificationConfigurationRequest.Builder
to
create a request.default CompletableFuture<GetBucketOwnershipControlsResponse> getBucketOwnershipControls(GetBucketOwnershipControlsRequest getBucketOwnershipControlsRequest)
Retrieves OwnershipControls
for an Amazon S3 bucket. To use this operation, you must have the
s3:GetBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a
Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to GetBucketOwnershipControls
:
getBucketOwnershipControlsRequest
- default CompletableFuture<GetBucketOwnershipControlsResponse> getBucketOwnershipControls(Consumer<GetBucketOwnershipControlsRequest.Builder> getBucketOwnershipControlsRequest)
Retrieves OwnershipControls
for an Amazon S3 bucket. To use this operation, you must have the
s3:GetBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see Specifying Permissions in a
Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to GetBucketOwnershipControls
:
This is a convenience which creates an instance of the GetBucketOwnershipControlsRequest.Builder
avoiding
the need to create one manually via GetBucketOwnershipControlsRequest.builder()
getBucketOwnershipControlsRequest
- A Consumer
that will call methods on GetBucketOwnershipControlsRequest.Builder
to create a
request.default CompletableFuture<GetBucketPolicyResponse> getBucketPolicy(GetBucketPolicyRequest getBucketPolicyRequest)
Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS
account that owns the bucket, the calling identity must have the GetBucketPolicy
permissions on the
specified bucket and belong to the bucket owner's account in order to use this operation.
If you don't have GetBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed
error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
The following operation is related to GetBucketPolicy
:
getBucketPolicyRequest
- default CompletableFuture<GetBucketPolicyResponse> getBucketPolicy(Consumer<GetBucketPolicyRequest.Builder> getBucketPolicyRequest)
Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS
account that owns the bucket, the calling identity must have the GetBucketPolicy
permissions on the
specified bucket and belong to the bucket owner's account in order to use this operation.
If you don't have GetBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed
error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
The following operation is related to GetBucketPolicy
:
This is a convenience which creates an instance of the GetBucketPolicyRequest.Builder
avoiding the need
to create one manually via GetBucketPolicyRequest.builder()
getBucketPolicyRequest
- A Consumer
that will call methods on GetBucketPolicyRequest.Builder
to create a request.default CompletableFuture<GetBucketPolicyStatusResponse> getBucketPolicyStatus(GetBucketPolicyStatusRequest getBucketPolicyStatusRequest)
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use
this operation, you must have the s3:GetBucketPolicyStatus
permission. For more information about
Amazon S3 permissions, see Specifying Permissions in a
Policy.
For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".
The following operations are related to GetBucketPolicyStatus
:
getBucketPolicyStatusRequest
- default CompletableFuture<GetBucketPolicyStatusResponse> getBucketPolicyStatus(Consumer<GetBucketPolicyStatusRequest.Builder> getBucketPolicyStatusRequest)
Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use
this operation, you must have the s3:GetBucketPolicyStatus
permission. For more information about
Amazon S3 permissions, see Specifying Permissions in a
Policy.
For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public".
The following operations are related to GetBucketPolicyStatus
:
This is a convenience which creates an instance of the GetBucketPolicyStatusRequest.Builder
avoiding the
need to create one manually via GetBucketPolicyStatusRequest.builder()
getBucketPolicyStatusRequest
- A Consumer
that will call methods on GetBucketPolicyStatusRequest.Builder
to create a
request.default CompletableFuture<GetBucketReplicationResponse> getBucketReplication(GetBucketReplicationRequest getBucketReplicationRequest)
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 List of
replication-related error codes
The following operations are related to GetBucketReplication
:
getBucketReplicationRequest
- default CompletableFuture<GetBucketReplicationResponse> getBucketReplication(Consumer<GetBucketReplicationRequest.Builder> getBucketReplicationRequest)
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 List of
replication-related error codes
The following operations are related to GetBucketReplication
:
This is a convenience which creates an instance of the GetBucketReplicationRequest.Builder
avoiding the
need to create one manually via GetBucketReplicationRequest.builder()
getBucketReplicationRequest
- A Consumer
that will call methods on GetBucketReplicationRequest.Builder
to create a
request.default CompletableFuture<GetBucketRequestPaymentResponse> getBucketRequestPayment(GetBucketRequestPaymentRequest getBucketRequestPaymentRequest)
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
:
getBucketRequestPaymentRequest
- default CompletableFuture<GetBucketRequestPaymentResponse> getBucketRequestPayment(Consumer<GetBucketRequestPaymentRequest.Builder> getBucketRequestPaymentRequest)
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
:
This is a convenience which creates an instance of the GetBucketRequestPaymentRequest.Builder
avoiding
the need to create one manually via GetBucketRequestPaymentRequest.builder()
getBucketRequestPaymentRequest
- A Consumer
that will call methods on GetBucketRequestPaymentRequest.Builder
to create a
request.default CompletableFuture<GetBucketTaggingResponse> getBucketTagging(GetBucketTaggingRequest getBucketTaggingRequest)
Returns the tag set associated with the bucket.
To use this operation, you must have permission to perform the s3:GetBucketTagging
action. By
default, the bucket owner has this permission and can grant this permission to others.
GetBucketTagging
has the following special error:
Error code: NoSuchTagSetError
Description: There is no tag set associated with the bucket.
The following operations are related to GetBucketTagging
:
getBucketTaggingRequest
- default CompletableFuture<GetBucketTaggingResponse> getBucketTagging(Consumer<GetBucketTaggingRequest.Builder> getBucketTaggingRequest)
Returns the tag set associated with the bucket.
To use this operation, you must have permission to perform the s3:GetBucketTagging
action. By
default, the bucket owner has this permission and can grant this permission to others.
GetBucketTagging
has the following special error:
Error code: NoSuchTagSetError
Description: There is no tag set associated with the bucket.
The following operations are related to GetBucketTagging
:
This is a convenience which creates an instance of the GetBucketTaggingRequest.Builder
avoiding the need
to create one manually via GetBucketTaggingRequest.builder()
getBucketTaggingRequest
- A Consumer
that will call methods on GetBucketTaggingRequest.Builder
to create a request.default CompletableFuture<GetBucketVersioningResponse> getBucketVersioning(GetBucketVersioningRequest getBucketVersioningRequest)
Returns the versioning state of a bucket.
To retrieve the versioning state of a bucket, you must be the bucket owner.
This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is
enabled
, the bucket owner must use an authentication device to change the versioning state of the
bucket.
The following operations are related to GetBucketVersioning
:
getBucketVersioningRequest
- default CompletableFuture<GetBucketVersioningResponse> getBucketVersioning(Consumer<GetBucketVersioningRequest.Builder> getBucketVersioningRequest)
Returns the versioning state of a bucket.
To retrieve the versioning state of a bucket, you must be the bucket owner.
This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is
enabled
, the bucket owner must use an authentication device to change the versioning state of the
bucket.
The following operations are related to GetBucketVersioning
:
This is a convenience which creates an instance of the GetBucketVersioningRequest.Builder
avoiding the
need to create one manually via GetBucketVersioningRequest.builder()
getBucketVersioningRequest
- A Consumer
that will call methods on GetBucketVersioningRequest.Builder
to create a
request.default CompletableFuture<GetBucketWebsiteResponse> getBucketWebsite(GetBucketWebsiteRequest getBucketWebsiteRequest)
Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.
This GET operation requires the S3:GetBucketWebsite
permission. By default, only the bucket owner
can read the bucket website configuration. However, bucket owners can allow other users to read the website
configuration by writing a bucket policy granting them the S3:GetBucketWebsite
permission.
The following operations are related to DeleteBucketWebsite
:
getBucketWebsiteRequest
- default CompletableFuture<GetBucketWebsiteResponse> getBucketWebsite(Consumer<GetBucketWebsiteRequest.Builder> getBucketWebsiteRequest)
Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3.
This GET operation requires the S3:GetBucketWebsite
permission. By default, only the bucket owner
can read the bucket website configuration. However, bucket owners can allow other users to read the website
configuration by writing a bucket policy granting them the S3:GetBucketWebsite
permission.
The following operations are related to DeleteBucketWebsite
:
This is a convenience which creates an instance of the GetBucketWebsiteRequest.Builder
avoiding the need
to create one manually via GetBucketWebsiteRequest.builder()
getBucketWebsiteRequest
- A Consumer
that will call methods on GetBucketWebsiteRequest.Builder
to create a request.default <ReturnT> CompletableFuture<ReturnT> getObject(GetObjectRequest getObjectRequest, AsyncResponseTransformer<GetObjectResponse,ReturnT> asyncResponseTransformer)
Retrieves objects from Amazon S3. To use GET
, you must have READ
access to the object.
If you grant READ
access to the anonymous user, you can return the object without using an
authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can,
however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead
of naming an object sample.jpg
, you can name it photos/2006/February/sample.jpg
.
To get an object from such a logical hierarchy, specify the full key name for the object in the GET
operation. For a virtual hosted-style request example, if you have the object
photos/2006/February/sample.jpg
, specify the resource as
/photos/2006/February/sample.jpg
. For a path-style request example, if you have the object
photos/2006/February/sample.jpg
in the bucket named examplebucket
, specify the resource
as /examplebucket/photos/2006/February/sample.jpg
. For more information about request types, see HTTP Host
Header Bucket Specification.
To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
If the object you are retrieving is stored in the S3 Glacier, S3 Glacier Deep Archive, S3 Intelligent-Tiering
Archive, or S3 Intelligent-Tiering Deep Archive storage classes, before you can retrieve the object you must
first restore a copy using RestoreObject. Otherwise, this
operation returns an InvalidObjectStateError
error. For information about restoring archived
objects, see Restoring Archived
Objects.
Encryption request headers, like x-amz-server-side-encryption
, should not be sent for GET requests
if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with
Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging
action), the response also returns the x-amz-tagging-count
header that provides the count of number
of tags associated with the object. You can use GetObjectTagging to retrieve
the tag set associated with an object.
Permissions
You need the s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a
Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also
have the s3:ListBucket
permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 will return an HTTP status code
404 ("no such key") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 will return an HTTP status code 403
("access denied") error.
Versioning
By default, the GET operation returns the current version of an object. To return a different version, use the
versionId
subresource.
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and
includes x-amz-delete-marker: true
in the response.
For more information about versioning, see PutBucketVersioning.
Overriding Response Header Values
There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.
You can override values for a set of response headers using the following query parameters. These response header
values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers
you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an
object. The response headers that you can override for the GET response are Content-Type
,
Content-Language
, Expires
, Cache-Control
, Content-Disposition
, and Content-Encoding
. To override these header values in the GET response, you use the following
request parameters.
You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
response-content-type
response-content-language
response-expires
response-cache-control
response-content-disposition
response-content-encoding
Additional Considerations about Request Headers
If both of the If-Match
and If-Unmodified-Since
headers are present in the request as
follows: If-Match
condition evaluates to true
, and; If-Unmodified-Since
condition evaluates to false
; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match
and If-Modified-Since
headers are present in the request
as follows: If-None-Match
condition evaluates to false
, and;
If-Modified-Since
condition evaluates to true
; then, S3 returns 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
The following operations are related to GetObject
:
getObjectRequest
- asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer
for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
Object data.
'.default <ReturnT> CompletableFuture<ReturnT> getObject(Consumer<GetObjectRequest.Builder> getObjectRequest, AsyncResponseTransformer<GetObjectResponse,ReturnT> asyncResponseTransformer)
Retrieves objects from Amazon S3. To use GET
, you must have READ
access to the object.
If you grant READ
access to the anonymous user, you can return the object without using an
authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can,
however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead
of naming an object sample.jpg
, you can name it photos/2006/February/sample.jpg
.
To get an object from such a logical hierarchy, specify the full key name for the object in the GET
operation. For a virtual hosted-style request example, if you have the object
photos/2006/February/sample.jpg
, specify the resource as
/photos/2006/February/sample.jpg
. For a path-style request example, if you have the object
photos/2006/February/sample.jpg
in the bucket named examplebucket
, specify the resource
as /examplebucket/photos/2006/February/sample.jpg
. For more information about request types, see HTTP Host
Header Bucket Specification.
To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
If the object you are retrieving is stored in the S3 Glacier, S3 Glacier Deep Archive, S3 Intelligent-Tiering
Archive, or S3 Intelligent-Tiering Deep Archive storage classes, before you can retrieve the object you must
first restore a copy using RestoreObject. Otherwise, this
operation returns an InvalidObjectStateError
error. For information about restoring archived
objects, see Restoring Archived
Objects.
Encryption request headers, like x-amz-server-side-encryption
, should not be sent for GET requests
if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with
Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging
action), the response also returns the x-amz-tagging-count
header that provides the count of number
of tags associated with the object. You can use GetObjectTagging to retrieve
the tag set associated with an object.
Permissions
You need the s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a
Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also
have the s3:ListBucket
permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 will return an HTTP status code
404 ("no such key") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 will return an HTTP status code 403
("access denied") error.
Versioning
By default, the GET operation returns the current version of an object. To return a different version, use the
versionId
subresource.
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and
includes x-amz-delete-marker: true
in the response.
For more information about versioning, see PutBucketVersioning.
Overriding Response Header Values
There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.
You can override values for a set of response headers using the following query parameters. These response header
values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers
you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an
object. The response headers that you can override for the GET response are Content-Type
,
Content-Language
, Expires
, Cache-Control
, Content-Disposition
, and Content-Encoding
. To override these header values in the GET response, you use the following
request parameters.
You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
response-content-type
response-content-language
response-expires
response-cache-control
response-content-disposition
response-content-encoding
Additional Considerations about Request Headers
If both of the If-Match
and If-Unmodified-Since
headers are present in the request as
follows: If-Match
condition evaluates to true
, and; If-Unmodified-Since
condition evaluates to false
; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match
and If-Modified-Since
headers are present in the request
as follows: If-None-Match
condition evaluates to false
, and;
If-Modified-Since
condition evaluates to true
; then, S3 returns 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
The following operations are related to GetObject
:
This is a convenience which creates an instance of the GetObjectRequest.Builder
avoiding the need to
create one manually via GetObjectRequest.builder()
getObjectRequest
- A Consumer
that will call methods on GetObjectRequest.Builder
to create a request.asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer
for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
Object data.
'.default CompletableFuture<GetObjectResponse> getObject(GetObjectRequest getObjectRequest, Path destinationPath)
Retrieves objects from Amazon S3. To use GET
, you must have READ
access to the object.
If you grant READ
access to the anonymous user, you can return the object without using an
authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can,
however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead
of naming an object sample.jpg
, you can name it photos/2006/February/sample.jpg
.
To get an object from such a logical hierarchy, specify the full key name for the object in the GET
operation. For a virtual hosted-style request example, if you have the object
photos/2006/February/sample.jpg
, specify the resource as
/photos/2006/February/sample.jpg
. For a path-style request example, if you have the object
photos/2006/February/sample.jpg
in the bucket named examplebucket
, specify the resource
as /examplebucket/photos/2006/February/sample.jpg
. For more information about request types, see HTTP Host
Header Bucket Specification.
To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
If the object you are retrieving is stored in the S3 Glacier, S3 Glacier Deep Archive, S3 Intelligent-Tiering
Archive, or S3 Intelligent-Tiering Deep Archive storage classes, before you can retrieve the object you must
first restore a copy using RestoreObject. Otherwise, this
operation returns an InvalidObjectStateError
error. For information about restoring archived
objects, see Restoring Archived
Objects.
Encryption request headers, like x-amz-server-side-encryption
, should not be sent for GET requests
if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with
Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging
action), the response also returns the x-amz-tagging-count
header that provides the count of number
of tags associated with the object. You can use GetObjectTagging to retrieve
the tag set associated with an object.
Permissions
You need the s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a
Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also
have the s3:ListBucket
permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 will return an HTTP status code
404 ("no such key") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 will return an HTTP status code 403
("access denied") error.
Versioning
By default, the GET operation returns the current version of an object. To return a different version, use the
versionId
subresource.
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and
includes x-amz-delete-marker: true
in the response.
For more information about versioning, see PutBucketVersioning.
Overriding Response Header Values
There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.
You can override values for a set of response headers using the following query parameters. These response header
values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers
you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an
object. The response headers that you can override for the GET response are Content-Type
,
Content-Language
, Expires
, Cache-Control
, Content-Disposition
, and Content-Encoding
. To override these header values in the GET response, you use the following
request parameters.
You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
response-content-type
response-content-language
response-expires
response-cache-control
response-content-disposition
response-content-encoding
Additional Considerations about Request Headers
If both of the If-Match
and If-Unmodified-Since
headers are present in the request as
follows: If-Match
condition evaluates to true
, and; If-Unmodified-Since
condition evaluates to false
; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match
and If-Modified-Since
headers are present in the request
as follows: If-None-Match
condition evaluates to false
, and;
If-Modified-Since
condition evaluates to true
; then, S3 returns 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
The following operations are related to GetObject
:
getObjectRequest
- destinationPath
- Path
to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
Object data.
'.default CompletableFuture<GetObjectResponse> getObject(Consumer<GetObjectRequest.Builder> getObjectRequest, Path destinationPath)
Retrieves objects from Amazon S3. To use GET
, you must have READ
access to the object.
If you grant READ
access to the anonymous user, you can return the object without using an
authorization header.
An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can,
however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead
of naming an object sample.jpg
, you can name it photos/2006/February/sample.jpg
.
To get an object from such a logical hierarchy, specify the full key name for the object in the GET
operation. For a virtual hosted-style request example, if you have the object
photos/2006/February/sample.jpg
, specify the resource as
/photos/2006/February/sample.jpg
. For a path-style request example, if you have the object
photos/2006/February/sample.jpg
in the bucket named examplebucket
, specify the resource
as /examplebucket/photos/2006/February/sample.jpg
. For more information about request types, see HTTP Host
Header Bucket Specification.
To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent. For more information about returning the ACL of an object, see GetObjectAcl.
If the object you are retrieving is stored in the S3 Glacier, S3 Glacier Deep Archive, S3 Intelligent-Tiering
Archive, or S3 Intelligent-Tiering Deep Archive storage classes, before you can retrieve the object you must
first restore a copy using RestoreObject. Otherwise, this
operation returns an InvalidObjectStateError
error. For information about restoring archived
objects, see Restoring Archived
Objects.
Encryption request headers, like x-amz-server-side-encryption
, should not be sent for GET requests
if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with
Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
BadRequest error.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Assuming you have permission to read object tags (permission for the s3:GetObjectVersionTagging
action), the response also returns the x-amz-tagging-count
header that provides the count of number
of tags associated with the object. You can use GetObjectTagging to retrieve
the tag set associated with an object.
Permissions
You need the s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a
Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also
have the s3:ListBucket
permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 will return an HTTP status code
404 ("no such key") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 will return an HTTP status code 403
("access denied") error.
Versioning
By default, the GET operation returns the current version of an object. To return a different version, use the
versionId
subresource.
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and
includes x-amz-delete-marker: true
in the response.
For more information about versioning, see PutBucketVersioning.
Overriding Response Header Values
There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request.
You can override values for a set of response headers using the following query parameters. These response header
values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers
you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an
object. The response headers that you can override for the GET response are Content-Type
,
Content-Language
, Expires
, Cache-Control
, Content-Disposition
, and Content-Encoding
. To override these header values in the GET response, you use the following
request parameters.
You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request.
response-content-type
response-content-language
response-expires
response-cache-control
response-content-disposition
response-content-encoding
Additional Considerations about Request Headers
If both of the If-Match
and If-Unmodified-Since
headers are present in the request as
follows: If-Match
condition evaluates to true
, and; If-Unmodified-Since
condition evaluates to false
; then, S3 returns 200 OK and the data requested.
If both of the If-None-Match
and If-Modified-Since
headers are present in the request
as follows: If-None-Match
condition evaluates to false
, and;
If-Modified-Since
condition evaluates to true
; then, S3 returns 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
The following operations are related to GetObject
:
This is a convenience which creates an instance of the GetObjectRequest.Builder
avoiding the need to
create one manually via GetObjectRequest.builder()
getObjectRequest
- A Consumer
that will call methods on GetObjectRequest.Builder
to create a request.destinationPath
- Path
to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
Object data.
'.default CompletableFuture<GetObjectAclResponse> getObjectAcl(GetObjectAclRequest getObjectAclRequest)
Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP
access to the object.
This action is not supported by Amazon S3 on Outposts.
Versioning
By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.
The following operations are related to GetObjectAcl
:
getObjectAclRequest
- default CompletableFuture<GetObjectAclResponse> getObjectAcl(Consumer<GetObjectAclRequest.Builder> getObjectAclRequest)
Returns the access control list (ACL) of an object. To use this operation, you must have READ_ACP
access to the object.
This action is not supported by Amazon S3 on Outposts.
Versioning
By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource.
The following operations are related to GetObjectAcl
:
This is a convenience which creates an instance of the GetObjectAclRequest.Builder
avoiding the need to
create one manually via GetObjectAclRequest.builder()
getObjectAclRequest
- A Consumer
that will call methods on GetObjectAclRequest.Builder
to create a request.default CompletableFuture<GetObjectLegalHoldResponse> getObjectLegalHold(GetObjectLegalHoldRequest getObjectLegalHoldRequest)
Gets an object's current Legal Hold status. For more information, see Locking Objects.
This action is not supported by Amazon S3 on Outposts.
getObjectLegalHoldRequest
- default CompletableFuture<GetObjectLegalHoldResponse> getObjectLegalHold(Consumer<GetObjectLegalHoldRequest.Builder> getObjectLegalHoldRequest)
Gets an object's current Legal Hold status. For more information, see Locking Objects.
This action is not supported by Amazon S3 on Outposts.
This is a convenience which creates an instance of the GetObjectLegalHoldRequest.Builder
avoiding the
need to create one manually via GetObjectLegalHoldRequest.builder()
getObjectLegalHoldRequest
- A Consumer
that will call methods on GetObjectLegalHoldRequest.Builder
to create a
request.default CompletableFuture<GetObjectLockConfigurationResponse> getObjectLockConfiguration(GetObjectLockConfigurationRequest getObjectLockConfigurationRequest)
Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
getObjectLockConfigurationRequest
- default CompletableFuture<GetObjectLockConfigurationResponse> getObjectLockConfiguration(Consumer<GetObjectLockConfigurationRequest.Builder> getObjectLockConfigurationRequest)
Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects.
This is a convenience which creates an instance of the GetObjectLockConfigurationRequest.Builder
avoiding
the need to create one manually via GetObjectLockConfigurationRequest.builder()
getObjectLockConfigurationRequest
- A Consumer
that will call methods on GetObjectLockConfigurationRequest.Builder
to create a
request.default CompletableFuture<GetObjectRetentionResponse> getObjectRetention(GetObjectRetentionRequest getObjectRetentionRequest)
Retrieves an object's retention settings. For more information, see Locking Objects.
This action is not supported by Amazon S3 on Outposts.
getObjectRetentionRequest
- default CompletableFuture<GetObjectRetentionResponse> getObjectRetention(Consumer<GetObjectRetentionRequest.Builder> getObjectRetentionRequest)
Retrieves an object's retention settings. For more information, see Locking Objects.
This action is not supported by Amazon S3 on Outposts.
This is a convenience which creates an instance of the GetObjectRetentionRequest.Builder
avoiding the
need to create one manually via GetObjectRetentionRequest.builder()
getObjectRetentionRequest
- A Consumer
that will call methods on GetObjectRetentionRequest.Builder
to create a
request.default CompletableFuture<GetObjectTaggingResponse> getObjectTagging(GetObjectTaggingRequest getObjectTaggingRequest)
Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.
To use this operation, you must have permission to perform the s3:GetObjectTagging
action. By
default, the GET operation returns information about current version of an object. For a versioned bucket, you
can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId
query parameter. You also need permission for the s3:GetObjectVersionTagging
action.
By default, the bucket owner has this permission and can grant this permission to others.
For information about the Amazon S3 object tagging feature, see Object Tagging.
The following operation is related to GetObjectTagging
:
getObjectTaggingRequest
- default CompletableFuture<GetObjectTaggingResponse> getObjectTagging(Consumer<GetObjectTaggingRequest.Builder> getObjectTaggingRequest)
Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object.
To use this operation, you must have permission to perform the s3:GetObjectTagging
action. By
default, the GET operation returns information about current version of an object. For a versioned bucket, you
can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId
query parameter. You also need permission for the s3:GetObjectVersionTagging
action.
By default, the bucket owner has this permission and can grant this permission to others.
For information about the Amazon S3 object tagging feature, see Object Tagging.
The following operation is related to GetObjectTagging
:
This is a convenience which creates an instance of the GetObjectTaggingRequest.Builder
avoiding the need
to create one manually via GetObjectTaggingRequest.builder()
getObjectTaggingRequest
- A Consumer
that will call methods on GetObjectTaggingRequest.Builder
to create a request.default <ReturnT> CompletableFuture<ReturnT> getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest, AsyncResponseTransformer<GetObjectTorrentResponse,ReturnT> asyncResponseTransformer)
Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.
You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.
To use GET, you must have READ access to the object.
This action is not supported by Amazon S3 on Outposts.
The following operation is related to GetObjectTorrent
:
getObjectTorrentRequest
- asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer
for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
A Bencoded dictionary as defined by the BitTorrent specification
'.default <ReturnT> CompletableFuture<ReturnT> getObjectTorrent(Consumer<GetObjectTorrentRequest.Builder> getObjectTorrentRequest, AsyncResponseTransformer<GetObjectTorrentResponse,ReturnT> asyncResponseTransformer)
Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.
You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.
To use GET, you must have READ access to the object.
This action is not supported by Amazon S3 on Outposts.
The following operation is related to GetObjectTorrent
:
This is a convenience which creates an instance of the GetObjectTorrentRequest.Builder
avoiding the need
to create one manually via GetObjectTorrentRequest.builder()
getObjectTorrentRequest
- A Consumer
that will call methods on GetObjectTorrentRequest.Builder
to create a request.asyncResponseTransformer
- The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer
for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
A Bencoded dictionary as defined by the BitTorrent specification
'.default CompletableFuture<GetObjectTorrentResponse> getObjectTorrent(GetObjectTorrentRequest getObjectTorrentRequest, Path destinationPath)
Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.
You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.
To use GET, you must have READ access to the object.
This action is not supported by Amazon S3 on Outposts.
The following operation is related to GetObjectTorrent
:
getObjectTorrentRequest
- destinationPath
- Path
to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
A Bencoded dictionary as defined by the BitTorrent specification
'.default CompletableFuture<GetObjectTorrentResponse> getObjectTorrent(Consumer<GetObjectTorrentRequest.Builder> getObjectTorrentRequest, Path destinationPath)
Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3.
You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key.
To use GET, you must have READ access to the object.
This action is not supported by Amazon S3 on Outposts.
The following operation is related to GetObjectTorrent
:
This is a convenience which creates an instance of the GetObjectTorrentRequest.Builder
avoiding the need
to create one manually via GetObjectTorrentRequest.builder()
getObjectTorrentRequest
- A Consumer
that will call methods on GetObjectTorrentRequest.Builder
to create a request.destinationPath
- Path
to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
A Bencoded dictionary as defined by the BitTorrent specification
'.default CompletableFuture<GetPublicAccessBlockResponse> getPublicAccessBlock(GetPublicAccessBlockRequest getPublicAccessBlockRequest)
Retrieves the PublicAccessBlock
configuration for an Amazon S3 bucket. To use this operation, you
must have the s3:GetBucketPublicAccessBlock
permission. For more information about Amazon S3
permissions, see Specifying
Permissions in a Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or an object, it checks
the PublicAccessBlock
configuration for both the bucket (or the bucket that contains the object) and
the bucket owner's account. If the PublicAccessBlock
settings are different between the bucket and
the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".
The following operations are related to GetPublicAccessBlock
:
getPublicAccessBlockRequest
- default CompletableFuture<GetPublicAccessBlockResponse> getPublicAccessBlock(Consumer<GetPublicAccessBlockRequest.Builder> getPublicAccessBlockRequest)
Retrieves the PublicAccessBlock
configuration for an Amazon S3 bucket. To use this operation, you
must have the s3:GetBucketPublicAccessBlock
permission. For more information about Amazon S3
permissions, see Specifying
Permissions in a Policy.
When Amazon S3 evaluates the PublicAccessBlock
configuration for a bucket or an object, it checks
the PublicAccessBlock
configuration for both the bucket (or the bucket that contains the object) and
the bucket owner's account. If the PublicAccessBlock
settings are different between the bucket and
the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings.
For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public".
The following operations are related to GetPublicAccessBlock
:
This is a convenience which creates an instance of the GetPublicAccessBlockRequest.Builder
avoiding the
need to create one manually via GetPublicAccessBlockRequest.builder()
getPublicAccessBlockRequest
- A Consumer
that will call methods on GetPublicAccessBlockRequest.Builder
to create a
request.default CompletableFuture<HeadBucketResponse> headBucket(HeadBucketRequest headBucketRequest)
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.
headBucketRequest
- default CompletableFuture<HeadBucketResponse> headBucket(Consumer<HeadBucketRequest.Builder> headBucketRequest)
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.
This is a convenience which creates an instance of the HeadBucketRequest.Builder
avoiding the need to
create one manually via HeadBucketRequest.builder()
headBucketRequest
- A Consumer
that will call methods on HeadBucketRequest.Builder
to create a request.default CompletableFuture<HeadObjectResponse> headObject(HeadObjectRequest headObjectRequest)
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.
A HEAD
request has the same options as a GET
operation on an object. The response is
identical to the GET
response except that there is no response body.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Encryption request headers, like x-amz-server-side-encryption
, should not be sent for GET requests
if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with
Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
BadRequest error.
Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
Consider the following when using request headers:
Consideration 1 – If both of the If-Match
and If-Unmodified-Since
headers are present
in the request as follows:
If-Match
condition evaluates to true
, and;
If-Unmodified-Since
condition evaluates to false
;
Then Amazon S3 returns 200 OK
and the data requested.
Consideration 2 – If both of the If-None-Match
and If-Modified-Since
headers are
present in the request as follows:
If-None-Match
condition evaluates to false
, and;
If-Modified-Since
condition evaluates to true
;
Then Amazon S3 returns the 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
Permissions
You need the s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a
Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also
have the s3:ListBucket permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 returns an HTTP status code 404
("no such key") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 returns an HTTP status code 403
("access denied") error.
The following operation is related to HeadObject
:
headObjectRequest
- default CompletableFuture<HeadObjectResponse> headObject(Consumer<HeadObjectRequest.Builder> headObjectRequest)
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object.
A HEAD
request has the same options as a GET
operation on an object. The response is
identical to the GET
response except that there is no response body.
If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers:
x-amz-server-side-encryption-customer-algorithm
x-amz-server-side-encryption-customer-key
x-amz-server-side-encryption-customer-key-MD5
For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys).
Encryption request headers, like x-amz-server-side-encryption
, should not be sent for GET requests
if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with
Amazon S3–managed encryption keys (SSE-S3). If your object does use these types of keys, you’ll get an HTTP 400
BadRequest error.
Request headers are limited to 8 KB in size. For more information, see Common Request Headers.
Consider the following when using request headers:
Consideration 1 – If both of the If-Match
and If-Unmodified-Since
headers are present
in the request as follows:
If-Match
condition evaluates to true
, and;
If-Unmodified-Since
condition evaluates to false
;
Then Amazon S3 returns 200 OK
and the data requested.
Consideration 2 – If both of the If-None-Match
and If-Modified-Since
headers are
present in the request as follows:
If-None-Match
condition evaluates to false
, and;
If-Modified-Since
condition evaluates to true
;
Then Amazon S3 returns the 304 Not Modified
response code.
For more information about conditional requests, see RFC 7232.
Permissions
You need the s3:GetObject
permission for this operation. For more information, see Specifying Permissions in a
Policy. If the object you request does not exist, the error Amazon S3 returns depends on whether you also
have the s3:ListBucket permission.
If you have the s3:ListBucket
permission on the bucket, Amazon S3 returns an HTTP status code 404
("no such key") error.
If you don’t have the s3:ListBucket
permission, Amazon S3 returns an HTTP status code 403
("access denied") error.
The following operation is related to HeadObject
:
This is a convenience which creates an instance of the HeadObjectRequest.Builder
avoiding the need to
create one manually via HeadObjectRequest.builder()
headObjectRequest
- A Consumer
that will call methods on HeadObjectRequest.Builder
to create a request.default CompletableFuture<ListBucketAnalyticsConfigurationsResponse> listBucketAnalyticsConfigurations(ListBucketAnalyticsConfigurationsRequest listBucketAnalyticsConfigurationsRequest)
Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This operation supports list pagination and does not return more than 100 configurations at a time. You should
always check the IsTruncated
element in the response. If there are no more configurations to list,
IsTruncated
is set to false. If there are more configurations to list, IsTruncated
is
set to true, and there will be a value in NextContinuationToken
. You use the
NextContinuationToken
value to continue the pagination of the list by passing the value in
continuation-token in the request to GET
the next page.
To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to ListBucketAnalyticsConfigurations
:
listBucketAnalyticsConfigurationsRequest
- default CompletableFuture<ListBucketAnalyticsConfigurationsResponse> listBucketAnalyticsConfigurations(Consumer<ListBucketAnalyticsConfigurationsRequest.Builder> listBucketAnalyticsConfigurationsRequest)
Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This operation supports list pagination and does not return more than 100 configurations at a time. You should
always check the IsTruncated
element in the response. If there are no more configurations to list,
IsTruncated
is set to false. If there are more configurations to list, IsTruncated
is
set to true, and there will be a value in NextContinuationToken
. You use the
NextContinuationToken
value to continue the pagination of the list by passing the value in
continuation-token in the request to GET
the next page.
To use this operation, you must have permissions to perform the s3:GetAnalyticsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about Amazon S3 analytics feature, see Amazon S3 Analytics – Storage Class Analysis.
The following operations are related to ListBucketAnalyticsConfigurations
:
This is a convenience which creates an instance of the ListBucketAnalyticsConfigurationsRequest.Builder
avoiding the need to create one manually via ListBucketAnalyticsConfigurationsRequest.builder()
listBucketAnalyticsConfigurationsRequest
- A Consumer
that will call methods on ListBucketAnalyticsConfigurationsRequest.Builder
to
create a request.default CompletableFuture<ListBucketIntelligentTieringConfigurationsResponse> listBucketIntelligentTieringConfigurations(ListBucketIntelligentTieringConfigurationsRequest listBucketIntelligentTieringConfigurationsRequest)
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to ListBucketIntelligentTieringConfigurations
include:
listBucketIntelligentTieringConfigurationsRequest
- default CompletableFuture<ListBucketIntelligentTieringConfigurationsResponse> listBucketIntelligentTieringConfigurations(Consumer<ListBucketIntelligentTieringConfigurationsRequest.Builder> listBucketIntelligentTieringConfigurationsRequest)
Lists the S3 Intelligent-Tiering configuration from the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to ListBucketIntelligentTieringConfigurations
include:
This is a convenience which creates an instance of the
ListBucketIntelligentTieringConfigurationsRequest.Builder
avoiding the need to create one manually via
ListBucketIntelligentTieringConfigurationsRequest.builder()
listBucketIntelligentTieringConfigurationsRequest
- A Consumer
that will call methods on
ListBucketIntelligentTieringConfigurationsRequest.Builder
to create a request.default CompletableFuture<ListBucketInventoryConfigurationsResponse> listBucketInventoryConfigurations(ListBucketInventoryConfigurationsRequest listBucketInventoryConfigurationsRequest)
Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This operation supports list pagination and does not return more than 100 configurations at a time. Always check
the IsTruncated
element in the response. If there are no more configurations to list,
IsTruncated
is set to false. If there are more configurations to list, IsTruncated
is
set to true, and there is a value in NextContinuationToken
. You use the
NextContinuationToken
value to continue the pagination of the list by passing the value in
continuation-token in the request to GET
the next page.
To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory
The following operations are related to ListBucketInventoryConfigurations
:
listBucketInventoryConfigurationsRequest
- default CompletableFuture<ListBucketInventoryConfigurationsResponse> listBucketInventoryConfigurations(Consumer<ListBucketInventoryConfigurationsRequest.Builder> listBucketInventoryConfigurationsRequest)
Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket.
This operation supports list pagination and does not return more than 100 configurations at a time. Always check
the IsTruncated
element in the response. If there are no more configurations to list,
IsTruncated
is set to false. If there are more configurations to list, IsTruncated
is
set to true, and there is a value in NextContinuationToken
. You use the
NextContinuationToken
value to continue the pagination of the list by passing the value in
continuation-token in the request to GET
the next page.
To use this operation, you must have permissions to perform the s3:GetInventoryConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about the Amazon S3 inventory feature, see Amazon S3 Inventory
The following operations are related to ListBucketInventoryConfigurations
:
This is a convenience which creates an instance of the ListBucketInventoryConfigurationsRequest.Builder
avoiding the need to create one manually via ListBucketInventoryConfigurationsRequest.builder()
listBucketInventoryConfigurationsRequest
- A Consumer
that will call methods on ListBucketInventoryConfigurationsRequest.Builder
to
create a request.default CompletableFuture<ListBucketMetricsConfigurationsResponse> listBucketMetricsConfigurations(ListBucketMetricsConfigurationsRequest listBucketMetricsConfigurationsRequest)
Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.
This operation supports list pagination and does not return more than 100 configurations at a time. Always check
the IsTruncated
element in the response. If there are no more configurations to list,
IsTruncated
is set to false. If there are more configurations to list, IsTruncated
is
set to true, and there is a value in NextContinuationToken
. You use the
NextContinuationToken
value to continue the pagination of the list by passing the value in
continuation-token
in the request to GET
the next page.
To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to ListBucketMetricsConfigurations
:
listBucketMetricsConfigurationsRequest
- default CompletableFuture<ListBucketMetricsConfigurationsResponse> listBucketMetricsConfigurations(Consumer<ListBucketMetricsConfigurationsRequest.Builder> listBucketMetricsConfigurationsRequest)
Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket.
This operation supports list pagination and does not return more than 100 configurations at a time. Always check
the IsTruncated
element in the response. If there are no more configurations to list,
IsTruncated
is set to false. If there are more configurations to list, IsTruncated
is
set to true, and there is a value in NextContinuationToken
. You use the
NextContinuationToken
value to continue the pagination of the list by passing the value in
continuation-token
in the request to GET
the next page.
To use this operation, you must have permissions to perform the s3:GetMetricsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to ListBucketMetricsConfigurations
:
This is a convenience which creates an instance of the ListBucketMetricsConfigurationsRequest.Builder
avoiding the need to create one manually via ListBucketMetricsConfigurationsRequest.builder()
listBucketMetricsConfigurationsRequest
- A Consumer
that will call methods on ListBucketMetricsConfigurationsRequest.Builder
to
create a request.default CompletableFuture<ListBucketsResponse> listBuckets(ListBucketsRequest listBucketsRequest)
Returns a list of all buckets owned by the authenticated sender of the request.
listBucketsRequest
- default CompletableFuture<ListBucketsResponse> listBuckets(Consumer<ListBucketsRequest.Builder> listBucketsRequest)
Returns a list of all buckets owned by the authenticated sender of the request.
This is a convenience which creates an instance of the ListBucketsRequest.Builder
avoiding the need to
create one manually via ListBucketsRequest.builder()
listBucketsRequest
- A Consumer
that will call methods on ListBucketsRequest.Builder
to create a request.default CompletableFuture<ListBucketsResponse> listBuckets()
Returns a list of all buckets owned by the authenticated sender of the request.
default CompletableFuture<ListMultipartUploadsResponse> listMultipartUploads(ListMultipartUploadsRequest listMultipartUploadsRequest)
This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum
number of uploads a response can include, which is also the default value. You can further limit the number of
uploads in a response by specifying the max-uploads
parameter in the response. If additional
multipart uploads satisfy the list criteria, the response will contain an IsTruncated
element with
the value true. To list the additional multipart uploads, use the key-marker
and
upload-id-marker
request parameters.
In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.
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
:
listMultipartUploadsRequest
- default CompletableFuture<ListMultipartUploadsResponse> listMultipartUploads(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest)
This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum
number of uploads a response can include, which is also the default value. You can further limit the number of
uploads in a response by specifying the max-uploads
parameter in the response. If additional
multipart uploads satisfy the list criteria, the response will contain an IsTruncated
element with
the value true. To list the additional multipart uploads, use the key-marker
and
upload-id-marker
request parameters.
In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.
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
:
This is a convenience which creates an instance of the ListMultipartUploadsRequest.Builder
avoiding the
need to create one manually via ListMultipartUploadsRequest.builder()
listMultipartUploadsRequest
- A Consumer
that will call methods on ListMultipartUploadsRequest.Builder
to create a
request.default ListMultipartUploadsPublisher listMultipartUploadsPaginator(ListMultipartUploadsRequest listMultipartUploadsRequest)
This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum
number of uploads a response can include, which is also the default value. You can further limit the number of
uploads in a response by specifying the max-uploads
parameter in the response. If additional
multipart uploads satisfy the list criteria, the response will contain an IsTruncated
element with
the value true. To list the additional multipart uploads, use the key-marker
and
upload-id-marker
request parameters.
In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.
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
:
This is a variant of
listMultipartUploads(software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxUploads won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMultipartUploads(software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest)
operation.
listMultipartUploadsRequest
- default ListMultipartUploadsPublisher listMultipartUploadsPaginator(Consumer<ListMultipartUploadsRequest.Builder> listMultipartUploadsRequest)
This operation lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted.
This operation returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum
number of uploads a response can include, which is also the default value. You can further limit the number of
uploads in a response by specifying the max-uploads
parameter in the response. If additional
multipart uploads satisfy the list criteria, the response will contain an IsTruncated
element with
the value true. To list the additional multipart uploads, use the key-marker
and
upload-id-marker
request parameters.
In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time.
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
:
This is a variant of
listMultipartUploads(software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListMultipartUploadsPublisher publisher = client.listMultipartUploadsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListMultipartUploadsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxUploads won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listMultipartUploads(software.amazon.awssdk.services.s3.model.ListMultipartUploadsRequest)
operation.
This is a convenience which creates an instance of the ListMultipartUploadsRequest.Builder
avoiding the
need to create one manually via ListMultipartUploadsRequest.builder()
listMultipartUploadsRequest
- A Consumer
that will call methods on ListMultipartUploadsRequest.Builder
to create a
request.default CompletableFuture<ListObjectVersionsResponse> listObjectVersions(ListObjectVersionsRequest listObjectVersionsRequest)
Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.
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.
This action is not supported by Amazon S3 on Outposts.
The following operations are related to ListObjectVersions
:
listObjectVersionsRequest
- default CompletableFuture<ListObjectVersionsResponse> listObjectVersions(Consumer<ListObjectVersionsRequest.Builder> listObjectVersionsRequest)
Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.
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.
This action is not supported by Amazon S3 on Outposts.
The following operations are related to ListObjectVersions
:
This is a convenience which creates an instance of the ListObjectVersionsRequest.Builder
avoiding the
need to create one manually via ListObjectVersionsRequest.builder()
listObjectVersionsRequest
- A Consumer
that will call methods on ListObjectVersionsRequest.Builder
to create a
request.default ListObjectVersionsPublisher listObjectVersionsPaginator(ListObjectVersionsRequest listObjectVersionsRequest)
Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.
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.
This action is not supported by Amazon S3 on Outposts.
The following operations are related to ListObjectVersions
:
This is a variant of
listObjectVersions(software.amazon.awssdk.services.s3.model.ListObjectVersionsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher publisher = client.listObjectVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher publisher = client.listObjectVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListObjectVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListObjectVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxKeys won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectVersions(software.amazon.awssdk.services.s3.model.ListObjectVersionsRequest)
operation.
listObjectVersionsRequest
- default ListObjectVersionsPublisher listObjectVersionsPaginator(Consumer<ListObjectVersionsRequest.Builder> listObjectVersionsRequest)
Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions.
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.
This action is not supported by Amazon S3 on Outposts.
The following operations are related to ListObjectVersions
:
This is a variant of
listObjectVersions(software.amazon.awssdk.services.s3.model.ListObjectVersionsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher publisher = client.listObjectVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListObjectVersionsPublisher publisher = client.listObjectVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListObjectVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListObjectVersionsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxKeys won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectVersions(software.amazon.awssdk.services.s3.model.ListObjectVersionsRequest)
operation.
This is a convenience which creates an instance of the ListObjectVersionsRequest.Builder
avoiding the
need to create one manually via ListObjectVersionsRequest.builder()
listObjectVersionsRequest
- A Consumer
that will call methods on ListObjectVersionsRequest.Builder
to create a
request.default CompletableFuture<ListObjectsResponse> listObjects(ListObjectsRequest listObjectsRequest)
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.
This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing
applications. For backward compatibility, Amazon S3 continues to support ListObjects
.
The following operations are related to ListObjects
:
listObjectsRequest
- default CompletableFuture<ListObjectsResponse> listObjects(Consumer<ListObjectsRequest.Builder> listObjectsRequest)
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately.
This API has been revised. We recommend that you use the newer version, ListObjectsV2, when developing
applications. For backward compatibility, Amazon S3 continues to support ListObjects
.
The following operations are related to ListObjects
:
This is a convenience which creates an instance of the ListObjectsRequest.Builder
avoiding the need to
create one manually via ListObjectsRequest.builder()
listObjectsRequest
- A Consumer
that will call methods on ListObjectsRequest.Builder
to create a request.default CompletableFuture<ListObjectsV2Response> listObjectsV2(ListObjectsV2Request listObjectsV2Request)
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection
criteria to return a subset of the objects in a bucket. A 200 OK
response can contain valid or
invalid XML. Make sure to design your application to parse the contents of the response and handle it
appropriately.
To use this operation, you must have READ access to the bucket.
To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform
the s3:ListBucket
action. The bucket owner has this permission by default and can grant this
permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.
To get a list of your buckets, see ListBuckets.
The following operations are related to ListObjectsV2
:
listObjectsV2Request
- default CompletableFuture<ListObjectsV2Response> listObjectsV2(Consumer<ListObjectsV2Request.Builder> listObjectsV2Request)
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection
criteria to return a subset of the objects in a bucket. A 200 OK
response can contain valid or
invalid XML. Make sure to design your application to parse the contents of the response and handle it
appropriately.
To use this operation, you must have READ access to the bucket.
To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform
the s3:ListBucket
action. The bucket owner has this permission by default and can grant this
permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.
To get a list of your buckets, see ListBuckets.
The following operations are related to ListObjectsV2
:
This is a convenience which creates an instance of the ListObjectsV2Request.Builder
avoiding the need to
create one manually via ListObjectsV2Request.builder()
listObjectsV2Request
- A Consumer
that will call methods on ListObjectsV2Request.Builder
to create a request.default ListObjectsV2Publisher listObjectsV2Paginator(ListObjectsV2Request listObjectsV2Request)
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection
criteria to return a subset of the objects in a bucket. A 200 OK
response can contain valid or
invalid XML. Make sure to design your application to parse the contents of the response and handle it
appropriately.
To use this operation, you must have READ access to the bucket.
To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform
the s3:ListBucket
action. The bucket owner has this permission by default and can grant this
permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.
To get a list of your buckets, see ListBuckets.
The following operations are related to ListObjectsV2
:
This is a variant of listObjectsV2(software.amazon.awssdk.services.s3.model.ListObjectsV2Request)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher publisher = client.listObjectsV2Paginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher publisher = client.listObjectsV2Paginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListObjectsV2Response>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListObjectsV2Response response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxKeys won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectsV2(software.amazon.awssdk.services.s3.model.ListObjectsV2Request)
operation.
listObjectsV2Request
- default ListObjectsV2Publisher listObjectsV2Paginator(Consumer<ListObjectsV2Request.Builder> listObjectsV2Request)
Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection
criteria to return a subset of the objects in a bucket. A 200 OK
response can contain valid or
invalid XML. Make sure to design your application to parse the contents of the response and handle it
appropriately.
To use this operation, you must have READ access to the bucket.
To use this operation in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform
the s3:ListBucket
action. The bucket owner has this permission by default and can grant this
permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
This section describes the latest revision of the API. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects.
To get a list of your buckets, see ListBuckets.
The following operations are related to ListObjectsV2
:
This is a variant of listObjectsV2(software.amazon.awssdk.services.s3.model.ListObjectsV2Request)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher publisher = client.listObjectsV2Paginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListObjectsV2Publisher publisher = client.listObjectsV2Paginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListObjectsV2Response>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListObjectsV2Response response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxKeys won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectsV2(software.amazon.awssdk.services.s3.model.ListObjectsV2Request)
operation.
This is a convenience which creates an instance of the ListObjectsV2Request.Builder
avoiding the need to
create one manually via ListObjectsV2Request.builder()
listObjectsV2Request
- A Consumer
that will call methods on ListObjectsV2Request.Builder
to create a request.default CompletableFuture<ListPartsResponse> listParts(ListPartsRequest listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload
ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload).
This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You
can restrict the number of parts returned by specifying the max-parts
request parameter. If your
multipart upload consists of more than 1,000 parts, the response returns an IsTruncated
field with
the value of true, and a NextPartNumberMarker
element. In subsequent ListParts
requests
you can include the part-number-marker query string parameter and set its value to the
NextPartNumberMarker
field value from the previous response.
For more information on multipart uploads, see Uploading Objects Using Multipart Upload.
For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
The following operations are related to ListParts
:
listPartsRequest
- default CompletableFuture<ListPartsResponse> listParts(Consumer<ListPartsRequest.Builder> listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload
ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload).
This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You
can restrict the number of parts returned by specifying the max-parts
request parameter. If your
multipart upload consists of more than 1,000 parts, the response returns an IsTruncated
field with
the value of true, and a NextPartNumberMarker
element. In subsequent ListParts
requests
you can include the part-number-marker query string parameter and set its value to the
NextPartNumberMarker
field value from the previous response.
For more information on multipart uploads, see Uploading Objects Using Multipart Upload.
For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
The following operations are related to ListParts
:
This is a convenience which creates an instance of the ListPartsRequest.Builder
avoiding the need to
create one manually via ListPartsRequest.builder()
listPartsRequest
- A Consumer
that will call methods on ListPartsRequest.Builder
to create a request.default ListPartsPublisher listPartsPaginator(ListPartsRequest listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload
ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload).
This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You
can restrict the number of parts returned by specifying the max-parts
request parameter. If your
multipart upload consists of more than 1,000 parts, the response returns an IsTruncated
field with
the value of true, and a NextPartNumberMarker
element. In subsequent ListParts
requests
you can include the part-number-marker query string parameter and set its value to the
NextPartNumberMarker
field value from the previous response.
For more information on multipart uploads, see Uploading Objects Using Multipart Upload.
For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
The following operations are related to ListParts
:
This is a variant of listParts(software.amazon.awssdk.services.s3.model.ListPartsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListPartsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListPartsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxParts won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listParts(software.amazon.awssdk.services.s3.model.ListPartsRequest)
operation.
listPartsRequest
- default ListPartsPublisher listPartsPaginator(Consumer<ListPartsRequest.Builder> listPartsRequest)
Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload
ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload).
This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You
can restrict the number of parts returned by specifying the max-parts
request parameter. If your
multipart upload consists of more than 1,000 parts, the response returns an IsTruncated
field with
the value of true, and a NextPartNumberMarker
element. In subsequent ListParts
requests
you can include the part-number-marker query string parameter and set its value to the
NextPartNumberMarker
field value from the previous response.
For more information on multipart uploads, see Uploading Objects Using Multipart Upload.
For information on permissions required to use the multipart upload API, see Multipart Upload API and Permissions.
The following operations are related to ListParts
:
This is a variant of listParts(software.amazon.awssdk.services.s3.model.ListPartsRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.s3.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.s3.paginators.ListPartsPublisher publisher = client.listPartsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.s3.model.ListPartsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.s3.model.ListPartsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of MaxParts won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listParts(software.amazon.awssdk.services.s3.model.ListPartsRequest)
operation.
This is a convenience which creates an instance of the ListPartsRequest.Builder
avoiding the need to
create one manually via ListPartsRequest.builder()
listPartsRequest
- A Consumer
that will call methods on ListPartsRequest.Builder
to create a request.default CompletableFuture<PutBucketAccelerateConfigurationResponse> putBucketAccelerateConfiguration(PutBucketAccelerateConfigurationRequest putBucketAccelerateConfigurationRequest)
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
:
putBucketAccelerateConfigurationRequest
- default CompletableFuture<PutBucketAccelerateConfigurationResponse> putBucketAccelerateConfiguration(Consumer<PutBucketAccelerateConfigurationRequest.Builder> putBucketAccelerateConfigurationRequest)
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
:
This is a convenience which creates an instance of the PutBucketAccelerateConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketAccelerateConfigurationRequest.builder()
putBucketAccelerateConfigurationRequest
- A Consumer
that will call methods on PutBucketAccelerateConfigurationRequest.Builder
to
create a request.default CompletableFuture<PutBucketAclResponse> putBucketAcl(PutBucketAclRequest putBucketAclRequest)
Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a
bucket, you must have WRITE_ACP
permission.
You can use one of the following two ways to set a bucket's permissions:
Specify the ACL in the request body
Specify permissions using request headers
You cannot specify access permission using both the body and the request headers.
Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.
Access Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with the x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs,
known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned
ACL name as the value of x-amz-acl
. If you use this header, you cannot use other access
control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
,
x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. When using these headers,
you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the
permission. If you use these ACL-specific headers, you cannot use the x-amz-acl
header to set a
canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more
information, see Access Control List
(ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
emailAddress
– if the value specified is the email address of an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following x-amz-grant-write
header grants create, overwrite, and delete objects
permission to LogDelivery group predefined by Amazon S3 and two AWS accounts identified by their email addresses.
x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By the person's ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request
By URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>[email protected]<></EmailAddress>lt;/Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
Related Resources
putBucketAclRequest
- default CompletableFuture<PutBucketAclResponse> putBucketAcl(Consumer<PutBucketAclRequest.Builder> putBucketAclRequest)
Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs. To set the ACL of a
bucket, you must have WRITE_ACP
permission.
You can use one of the following two ways to set a bucket's permissions:
Specify the ACL in the request body
Specify permissions using request headers
You cannot specify access permission using both the body and the request headers.
Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach.
Access Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with the x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs,
known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned
ACL name as the value of x-amz-acl
. If you use this header, you cannot use other access
control-specific headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
,
x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. When using these headers,
you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the
permission. If you use these ACL-specific headers, you cannot use the x-amz-acl
header to set a
canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more
information, see Access Control List
(ACL) Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
emailAddress
– if the value specified is the email address of an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following x-amz-grant-write
header grants create, overwrite, and delete objects
permission to LogDelivery group predefined by Amazon S3 and two AWS accounts identified by their email addresses.
x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", id="111122223333", id="555566667777"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By the person's ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request
By URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>[email protected]<></EmailAddress>lt;/Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
Related Resources
This is a convenience which creates an instance of the PutBucketAclRequest.Builder
avoiding the need to
create one manually via PutBucketAclRequest.builder()
putBucketAclRequest
- A Consumer
that will call methods on PutBucketAclRequest.Builder
to create a request.default CompletableFuture<PutBucketAnalyticsConfigurationResponse> putBucketAnalyticsConfiguration(PutBucketAnalyticsConfigurationRequest putBucketAnalyticsConfigurationRequest)
Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.
You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat
file. See the DataExport
request element. Reports are updated daily and are based on the object
filters that you configure. When selecting data export, you specify a destination bucket and an optional
destination prefix where the file is written. You can export the data to a destination bucket in a different
account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT
analytics configuration to. For more information, see Amazon S3 Analytics – Storage
Class Analysis.
You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
Special Errors
HTTP Error: HTTP 400 Bad Request
Code: InvalidArgument
Cause: Invalid argument.
HTTP Error: HTTP 400 Bad Request
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Error: HTTP 403 Forbidden
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.
Related Resources
putBucketAnalyticsConfigurationRequest
- default CompletableFuture<PutBucketAnalyticsConfigurationResponse> putBucketAnalyticsConfiguration(Consumer<PutBucketAnalyticsConfigurationRequest.Builder> putBucketAnalyticsConfigurationRequest)
Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket.
You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat
file. See the DataExport
request element. Reports are updated daily and are based on the object
filters that you configure. When selecting data export, you specify a destination bucket and an optional
destination prefix where the file is written. You can export the data to a destination bucket in a different
account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT
analytics configuration to. For more information, see Amazon S3 Analytics – Storage
Class Analysis.
You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the s3:PutAnalyticsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
Special Errors
HTTP Error: HTTP 400 Bad Request
Code: InvalidArgument
Cause: Invalid argument.
HTTP Error: HTTP 400 Bad Request
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Error: HTTP 403 Forbidden
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the s3:PutAnalyticsConfiguration bucket permission to set the configuration on the bucket.
Related Resources
This is a convenience which creates an instance of the PutBucketAnalyticsConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketAnalyticsConfigurationRequest.builder()
putBucketAnalyticsConfigurationRequest
- A Consumer
that will call methods on PutBucketAnalyticsConfigurationRequest.Builder
to
create a request.default CompletableFuture<PutBucketCorsResponse> putBucketCors(PutBucketCorsRequest putBucketCorsRequest)
Sets the cors
configuration for your bucket. If the configuration exists, Amazon S3 replaces it.
To use this operation, you must be allowed to perform the s3:PutBucketCORS
action. By default, the
bucket owner has this permission and can grant it to others.
You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you
might want to enable a request whose origin is http://www.example.com
to access your Amazon S3
bucket at my.example.bucket.com
by using the browser's XMLHttpRequest
capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the cors
subresource to the
bucket. The cors
subresource is an XML document in which you configure rules that identify origins
and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.
When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates
the cors
configuration on the bucket and uses the first CORSRule
rule that matches the
incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be
met:
The request's Origin
header must match AllowedOrigin
elements.
The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method
header in case of a pre-flight OPTIONS
request must be one of the AllowedMethod
elements.
Every header specified in the Access-Control-Request-Headers
request header of a pre-flight request
must match an AllowedHeader
element.
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
Related Resources
putBucketCorsRequest
- default CompletableFuture<PutBucketCorsResponse> putBucketCors(Consumer<PutBucketCorsRequest.Builder> putBucketCorsRequest)
Sets the cors
configuration for your bucket. If the configuration exists, Amazon S3 replaces it.
To use this operation, you must be allowed to perform the s3:PutBucketCORS
action. By default, the
bucket owner has this permission and can grant it to others.
You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you
might want to enable a request whose origin is http://www.example.com
to access your Amazon S3
bucket at my.example.bucket.com
by using the browser's XMLHttpRequest
capability.
To enable cross-origin resource sharing (CORS) on a bucket, you add the cors
subresource to the
bucket. The cors
subresource is an XML document in which you configure rules that identify origins
and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size.
When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates
the cors
configuration on the bucket and uses the first CORSRule
rule that matches the
incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be
met:
The request's Origin
header must match AllowedOrigin
elements.
The request method (for example, GET, PUT, HEAD, and so on) or the Access-Control-Request-Method
header in case of a pre-flight OPTIONS
request must be one of the AllowedMethod
elements.
Every header specified in the Access-Control-Request-Headers
request header of a pre-flight request
must match an AllowedHeader
element.
For more information about CORS, go to Enabling Cross-Origin Resource Sharing in the Amazon Simple Storage Service Developer Guide.
Related Resources
This is a convenience which creates an instance of the PutBucketCorsRequest.Builder
avoiding the need to
create one manually via PutBucketCorsRequest.builder()
putBucketCorsRequest
- A Consumer
that will call methods on PutBucketCorsRequest.Builder
to create a request.default CompletableFuture<PutBucketEncryptionResponse> putBucketEncryption(PutBucketEncryptionRequest putBucketEncryptionRequest)
This implementation of the PUT
operation uses the encryption
subresource to set the
default encryption state of an existing bucket.
This implementation of the PUT
operation sets default encryption for a bucket using server-side
encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS). For information
about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket
Encryption.
This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature Version 4).
To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others.
For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.
Related Resources
putBucketEncryptionRequest
- default CompletableFuture<PutBucketEncryptionResponse> putBucketEncryption(Consumer<PutBucketEncryptionRequest.Builder> putBucketEncryptionRequest)
This implementation of the PUT
operation uses the encryption
subresource to set the
default encryption state of an existing bucket.
This implementation of the PUT
operation sets default encryption for a bucket using server-side
encryption with Amazon S3-managed keys SSE-S3 or AWS KMS customer master keys (CMKs) (SSE-KMS). For information
about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket
Encryption.
This operation requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature Version 4).
To use this operation, you must have permissions to perform the s3:PutEncryptionConfiguration
action. The bucket owner has this permission by default. The bucket owner can grant this permission to others.
For more information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources in the Amazon Simple Storage Service Developer Guide.
Related Resources
This is a convenience which creates an instance of the PutBucketEncryptionRequest.Builder
avoiding the
need to create one manually via PutBucketEncryptionRequest.builder()
putBucketEncryptionRequest
- A Consumer
that will call methods on PutBucketEncryptionRequest.Builder
to create a
request.default CompletableFuture<PutBucketIntelligentTieringConfigurationResponse> putBucketIntelligentTieringConfiguration(PutBucketIntelligentTieringConfigurationRequest putBucketIntelligentTieringConfigurationRequest)
Puts a S3 Intelligent-Tiering configuration to the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to PutBucketIntelligentTieringConfiguration
include:
putBucketIntelligentTieringConfigurationRequest
- default CompletableFuture<PutBucketIntelligentTieringConfigurationResponse> putBucketIntelligentTieringConfiguration(Consumer<PutBucketIntelligentTieringConfigurationRequest.Builder> putBucketIntelligentTieringConfigurationRequest)
Puts a S3 Intelligent-Tiering configuration to the specified bucket.
The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change.
The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class.
If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects.
Operations related to PutBucketIntelligentTieringConfiguration
include:
This is a convenience which creates an instance of the
PutBucketIntelligentTieringConfigurationRequest.Builder
avoiding the need to create one manually via
PutBucketIntelligentTieringConfigurationRequest.builder()
putBucketIntelligentTieringConfigurationRequest
- A Consumer
that will call methods on
PutBucketIntelligentTieringConfigurationRequest.Builder
to create a request.default CompletableFuture<PutBucketInventoryConfigurationResponse> putBucketInventoryConfiguration(PutBucketInventoryConfigurationRequest putBucketInventoryConfigurationRequest)
This implementation of the PUT
operation adds an inventory configuration (identified by the
inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.
Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same AWS Region as the source bucket.
When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon Simple Storage Service Developer Guide.
You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration
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.
Special Errors
HTTP 400 Bad Request Error
Code: InvalidArgument
Cause: Invalid Argument
HTTP 400 Bad Request Error
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP 403 Forbidden Error
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the
s3:PutInventoryConfiguration
bucket permission to set the configuration on the bucket.
Related Resources
putBucketInventoryConfigurationRequest
- default CompletableFuture<PutBucketInventoryConfigurationResponse> putBucketInventoryConfiguration(Consumer<PutBucketInventoryConfigurationRequest.Builder> putBucketInventoryConfigurationRequest)
This implementation of the PUT
operation adds an inventory configuration (identified by the
inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket.
Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the source bucket, and the bucket where the inventory flat file is stored is called the destination bucket. The destination bucket must be in the same AWS Region as the source bucket.
When you configure an inventory for a source bucket, you specify the destination bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory in the Amazon Simple Storage Service Developer Guide.
You must create a bucket policy on the destination bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis.
To use this operation, you must have permissions to perform the s3:PutInventoryConfiguration
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.
Special Errors
HTTP 400 Bad Request Error
Code: InvalidArgument
Cause: Invalid Argument
HTTP 400 Bad Request Error
Code: TooManyConfigurations
Cause: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP 403 Forbidden Error
Code: AccessDenied
Cause: You are not the owner of the specified bucket, or you do not have the
s3:PutInventoryConfiguration
bucket permission to set the configuration on the bucket.
Related Resources
This is a convenience which creates an instance of the PutBucketInventoryConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketInventoryConfigurationRequest.builder()
putBucketInventoryConfigurationRequest
- A Consumer
that will call methods on PutBucketInventoryConfigurationRequest.Builder
to
create a request.default CompletableFuture<PutBucketLifecycleConfigurationResponse> putBucketLifecycleConfiguration(PutBucketLifecycleConfigurationRequest putBucketLifecycleConfigurationRequest)
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources.
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.
Rules
You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:
Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.
Status whether the rule is in effect.
One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.
For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.
Permissions
By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.
You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration
For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.
The following are related to PutBucketLifecycleConfiguration
:
putBucketLifecycleConfigurationRequest
- default CompletableFuture<PutBucketLifecycleConfigurationResponse> putBucketLifecycleConfiguration(Consumer<PutBucketLifecycleConfigurationRequest.Builder> putBucketLifecycleConfigurationRequest)
Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing Access Permissions to Your Amazon S3 Resources.
Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle.
Rules
You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following:
Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both.
Status whether the rule is in effect.
One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions.
For more information, see Object Lifecycle Management and Lifecycle Configuration Elements.
Permissions
By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission.
You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions:
s3:DeleteObject
s3:DeleteObjectVersion
s3:PutLifecycleConfiguration
For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources.
The following are related to PutBucketLifecycleConfiguration
:
This is a convenience which creates an instance of the PutBucketLifecycleConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketLifecycleConfigurationRequest.builder()
putBucketLifecycleConfigurationRequest
- A Consumer
that will call methods on PutBucketLifecycleConfigurationRequest.Builder
to
create a request.default CompletableFuture<PutBucketLoggingResponse> putBucketLogging(PutBucketLoggingRequest putBucketLoggingRequest)
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.
The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee
request
element to grant access to other people. The Permissions
request element specifies the kind of
access the grantee has to the logs.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By the person's ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request.
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>[email protected]<></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
:
putBucketLoggingRequest
- default CompletableFuture<PutBucketLoggingResponse> putBucketLogging(Consumer<PutBucketLoggingRequest.Builder> putBucketLoggingRequest)
Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner.
The bucket owner is automatically granted FULL_CONTROL to all logs. You use the Grantee
request
element to grant access to other people. The Permissions
request element specifies the kind of
access the grantee has to the logs.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By the person's ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request.
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>[email protected]<></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
:
This is a convenience which creates an instance of the PutBucketLoggingRequest.Builder
avoiding the need
to create one manually via PutBucketLoggingRequest.builder()
putBucketLoggingRequest
- A Consumer
that will call methods on PutBucketLoggingRequest.Builder
to create a request.default CompletableFuture<PutBucketMetricsConfigurationResponse> putBucketMetricsConfiguration(PutBucketMetricsConfigurationRequest putBucketMetricsConfigurationRequest)
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.
To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to PutBucketMetricsConfiguration
:
GetBucketLifecycle
has the following special error:
Error code: TooManyConfigurations
Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Status Code: HTTP 400 Bad Request
putBucketMetricsConfigurationRequest
- default CompletableFuture<PutBucketMetricsConfigurationResponse> putBucketMetricsConfiguration(Consumer<PutBucketMetricsConfigurationRequest.Builder> putBucketMetricsConfigurationRequest)
Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased.
To use this operation, you must have permissions to perform the s3:PutMetricsConfiguration
action.
The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more
information about permissions, see Permissions Related to Bucket Subresource Operations and Managing Access Permissions to Your
Amazon S3 Resources.
For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch.
The following operations are related to PutBucketMetricsConfiguration
:
GetBucketLifecycle
has the following special error:
Error code: TooManyConfigurations
Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit.
HTTP Status Code: HTTP 400 Bad Request
This is a convenience which creates an instance of the PutBucketMetricsConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketMetricsConfigurationRequest.builder()
putBucketMetricsConfigurationRequest
- A Consumer
that will call methods on PutBucketMetricsConfigurationRequest.Builder
to
create a request.default CompletableFuture<PutBucketNotificationConfigurationResponse> putBucketNotificationConfiguration(PutBucketNotificationConfigurationRequest putBucketNotificationConfigurationRequest)
Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.
Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.
By default, your bucket has no event notifications configured. That is, the notification configuration will be an
empty NotificationConfiguration
.
<NotificationConfiguration>
</NotificationConfiguration>
This operation replaces the existing notification configuration with the configuration you include in the request body.
After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.
You can disable notifications by adding the empty NotificationConfiguration element.
By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a
bucket policy to grant permission to other users to set this configuration with
s3:PutBucketNotification
permission.
The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add the configuration to your bucket.
Responses
If the configuration in the request body includes only one TopicConfiguration
specifying only the
s3:ReducedRedundancyLostObject
event type, the response will also include the
x-amz-sns-test-message-id
header containing the message ID of the test notification sent to the
topic.
The following operation is related to PutBucketNotificationConfiguration
:
putBucketNotificationConfigurationRequest
- default CompletableFuture<PutBucketNotificationConfigurationResponse> putBucketNotificationConfiguration(Consumer<PutBucketNotificationConfigurationRequest.Builder> putBucketNotificationConfigurationRequest)
Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications.
Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type.
By default, your bucket has no event notifications configured. That is, the notification configuration will be an
empty NotificationConfiguration
.
<NotificationConfiguration>
</NotificationConfiguration>
This operation replaces the existing notification configuration with the configuration you include in the request body.
After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events.
You can disable notifications by adding the empty NotificationConfiguration element.
By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a
bucket policy to grant permission to other users to set this configuration with
s3:PutBucketNotification
permission.
The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT operation will fail, and Amazon S3 will not add the configuration to your bucket.
Responses
If the configuration in the request body includes only one TopicConfiguration
specifying only the
s3:ReducedRedundancyLostObject
event type, the response will also include the
x-amz-sns-test-message-id
header containing the message ID of the test notification sent to the
topic.
The following operation is related to PutBucketNotificationConfiguration
:
This is a convenience which creates an instance of the PutBucketNotificationConfigurationRequest.Builder
avoiding the need to create one manually via PutBucketNotificationConfigurationRequest.builder()
putBucketNotificationConfigurationRequest
- A Consumer
that will call methods on PutBucketNotificationConfigurationRequest.Builder
to
create a request.default CompletableFuture<PutBucketOwnershipControlsResponse> putBucketOwnershipControls(PutBucketOwnershipControlsRequest putBucketOwnershipControlsRequest)
Creates or modifies OwnershipControls
for an Amazon S3 bucket. To use this operation, you must have
the s3:PutBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see
Specifying Permissions in a
Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to PutBucketOwnershipControls
:
putBucketOwnershipControlsRequest
- default CompletableFuture<PutBucketOwnershipControlsResponse> putBucketOwnershipControls(Consumer<PutBucketOwnershipControlsRequest.Builder> putBucketOwnershipControlsRequest)
Creates or modifies OwnershipControls
for an Amazon S3 bucket. To use this operation, you must have
the s3:PutBucketOwnershipControls
permission. For more information about Amazon S3 permissions, see
Specifying Permissions in a
Policy.
For information about Amazon S3 Object Ownership, see Using Object Ownership.
The following operations are related to PutBucketOwnershipControls
:
This is a convenience which creates an instance of the PutBucketOwnershipControlsRequest.Builder
avoiding
the need to create one manually via PutBucketOwnershipControlsRequest.builder()
putBucketOwnershipControlsRequest
- A Consumer
that will call methods on PutBucketOwnershipControlsRequest.Builder
to create a
request.default CompletableFuture<PutBucketPolicyResponse> putBucketPolicy(PutBucketPolicyRequest putBucketPolicyRequest)
Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user
of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy
permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
If you don't have PutBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed
error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
The following operations are related to PutBucketPolicy
:
putBucketPolicyRequest
- default CompletableFuture<PutBucketPolicyResponse> putBucketPolicy(Consumer<PutBucketPolicyRequest.Builder> putBucketPolicyRequest)
Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user
of the AWS account that owns the bucket, the calling identity must have the PutBucketPolicy
permissions on the specified bucket and belong to the bucket owner's account in order to use this operation.
If you don't have PutBucketPolicy
permissions, Amazon S3 returns a 403 Access Denied
error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's
account, Amazon S3 returns a 405 Method Not Allowed
error.
As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action.
For more information about bucket policies, see Using Bucket Policies and User Policies.
The following operations are related to PutBucketPolicy
:
This is a convenience which creates an instance of the PutBucketPolicyRequest.Builder
avoiding the need
to create one manually via PutBucketPolicyRequest.builder()
putBucketPolicyRequest
- A Consumer
that will call methods on PutBucketPolicyRequest.Builder
to create a request.default CompletableFuture<PutBucketReplicationResponse> putBucketReplication(PutBucketReplicationRequest putBucketReplicationRequest)
Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 Developer Guide.
To perform this operation, the user or role performing the operation must have the iam:PassRole permission.
Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.
A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket.
To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as
a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or
both. When you add the Filter element in the configuration, you must also add the following elements:
DeleteMarkerReplication
, Status
, and Priority
.
The latest version of the replication configuration XML is V2. XML V2 replication configurations are those that
contain the Filter
element for rules, and rules that specify S3 Replication Time Control (S3 RTC).
In XML V2 replication configurations, Amazon S3 doesn't replicate delete markers. Therefore, you must set the
DeleteMarkerReplication
element to Disabled
. For backward compatibility, Amazon S3
continues to support the XML V1 replication configuration.
For information about enabling versioning on a bucket, see Using Versioning.
By default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.
Handling Replication of Encrypted Objects
By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs
stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following:
SourceSelectionCriteria
, SseKmsEncryptedObjects
, Status
,
EncryptionConfiguration
, and ReplicaKmsKeyID
. For information about replication
configuration, see Replicating
Objects Created with SSE Using CMKs stored in AWS KMS.
For information on PutBucketReplication
errors, see List of
replication-related error codes
The following operations are related to PutBucketReplication
:
putBucketReplicationRequest
- default CompletableFuture<PutBucketReplicationResponse> putBucketReplication(Consumer<PutBucketReplicationRequest.Builder> putBucketReplicationRequest)
Creates a replication configuration or replaces an existing one. For more information, see Replication in the Amazon S3 Developer Guide.
To perform this operation, the user or role performing the operation must have the iam:PassRole permission.
Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information.
A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. All rules must specify the same destination bucket.
To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as
a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or
both. When you add the Filter element in the configuration, you must also add the following elements:
DeleteMarkerReplication
, Status
, and Priority
.
The latest version of the replication configuration XML is V2. XML V2 replication configurations are those that
contain the Filter
element for rules, and rules that specify S3 Replication Time Control (S3 RTC).
In XML V2 replication configurations, Amazon S3 doesn't replicate delete markers. Therefore, you must set the
DeleteMarkerReplication
element to Disabled
. For backward compatibility, Amazon S3
continues to support the XML V1 replication configuration.
For information about enabling versioning on a bucket, see Using Versioning.
By default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy and Managing Access Permissions to Your Amazon S3 Resources.
Handling Replication of Encrypted Objects
By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs
stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following:
SourceSelectionCriteria
, SseKmsEncryptedObjects
, Status
,
EncryptionConfiguration
, and ReplicaKmsKeyID
. For information about replication
configuration, see Replicating
Objects Created with SSE Using CMKs stored in AWS KMS.
For information on PutBucketReplication
errors, see List of
replication-related error codes
The following operations are related to PutBucketReplication
:
This is a convenience which creates an instance of the PutBucketReplicationRequest.Builder
avoiding the
need to create one manually via PutBucketReplicationRequest.builder()
putBucketReplicationRequest
- A Consumer
that will call methods on PutBucketReplicationRequest.Builder
to create a
request.default CompletableFuture<PutBucketRequestPaymentResponse> putBucketRequestPayment(PutBucketRequestPaymentRequest putBucketRequestPaymentRequest)
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
:
putBucketRequestPaymentRequest
- default CompletableFuture<PutBucketRequestPaymentResponse> putBucketRequestPayment(Consumer<PutBucketRequestPaymentRequest.Builder> putBucketRequestPaymentRequest)
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
:
This is a convenience which creates an instance of the PutBucketRequestPaymentRequest.Builder
avoiding
the need to create one manually via PutBucketRequestPaymentRequest.builder()
putBucketRequestPaymentRequest
- A Consumer
that will call methods on PutBucketRequestPaymentRequest.Builder
to create a
request.default CompletableFuture<PutBucketTaggingResponse> putBucketTagging(PutBucketTaggingRequest putBucketTaggingRequest)
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
:
putBucketTaggingRequest
- default CompletableFuture<PutBucketTaggingResponse> putBucketTagging(Consumer<PutBucketTaggingRequest.Builder> putBucketTaggingRequest)
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
:
This is a convenience which creates an instance of the PutBucketTaggingRequest.Builder
avoiding the need
to create one manually via PutBucketTaggingRequest.builder()
putBucketTaggingRequest
- A Consumer
that will call methods on PutBucketTaggingRequest.Builder
to create a request.default CompletableFuture<PutBucketVersioningResponse> putBucketVersioning(PutBucketVersioningRequest putBucketVersioningRequest)
Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
You can set the versioning state with one of the following values:
Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.
If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.
If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the
x-amz-mfa request
header and the Status
and the MfaDelete
request elements
in a request to set the versioning state of the bucket.
If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.
Related Resources
putBucketVersioningRequest
- default CompletableFuture<PutBucketVersioningResponse> putBucketVersioning(Consumer<PutBucketVersioningRequest.Builder> putBucketVersioningRequest)
Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner.
You can set the versioning state with one of the following values:
Enabled—Enables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID.
Suspended—Disables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null.
If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning request does not return a versioning state value.
If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the
x-amz-mfa request
header and the Status
and the MfaDelete
request elements
in a request to set the versioning state of the bucket.
If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning.
Related Resources
This is a convenience which creates an instance of the PutBucketVersioningRequest.Builder
avoiding the
need to create one manually via PutBucketVersioningRequest.builder()
putBucketVersioningRequest
- A Consumer
that will call methods on PutBucketVersioningRequest.Builder
to create a
request.default CompletableFuture<PutBucketWebsiteResponse> putBucketWebsite(PutBucketWebsiteRequest putBucketWebsiteRequest)
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.
putBucketWebsiteRequest
- default CompletableFuture<PutBucketWebsiteResponse> putBucketWebsite(Consumer<PutBucketWebsiteRequest.Builder> putBucketWebsiteRequest)
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.
This is a convenience which creates an instance of the PutBucketWebsiteRequest.Builder
avoiding the need
to create one manually via PutBucketWebsiteRequest.builder()
putBucketWebsiteRequest
- A Consumer
that will call methods on PutBucketWebsiteRequest.Builder
to create a request.default CompletableFuture<PutObjectResponse> putObject(PutObjectRequest putObjectRequest, AsyncRequestBody requestBody)
Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.
Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.
To ensure that data is not corrupted traversing the network, use the Content-MD5
header. When you
use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an
error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag
to the calculated MD5 value.
The Content-MD5
header is required for any request to upload an object with a retention period
configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock
Overview in the Amazon Simple Storage Service Developer Guide.
Server-side Encryption
You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys. For more information, see Using Server-Side Encryption.
Access Control List (ACL)-Specific Request Headers
You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.
Storage Class Options
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.
Versioning
If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.
For more information about versioning, see Adding Objects to Versioning Enabled Buckets. For information about returning the versioning state of a bucket, see GetBucketVersioning.
Related Resources
putObjectRequest
- requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The
size of the content is expected to be known up front. See AsyncRequestBody
for specific details on
implementing this interface as well as links to precanned implementations for common scenarios like
uploading from a file. The service documentation for the request content is as follows '
Object data.
'default CompletableFuture<PutObjectResponse> putObject(Consumer<PutObjectRequest.Builder> putObjectRequest, AsyncRequestBody requestBody)
Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.
Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.
To ensure that data is not corrupted traversing the network, use the Content-MD5
header. When you
use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an
error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag
to the calculated MD5 value.
The Content-MD5
header is required for any request to upload an object with a retention period
configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock
Overview in the Amazon Simple Storage Service Developer Guide.
Server-side Encryption
You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys. For more information, see Using Server-Side Encryption.
Access Control List (ACL)-Specific Request Headers
You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.
Storage Class Options
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.
Versioning
If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.
For more information about versioning, see Adding Objects to Versioning Enabled Buckets. For information about returning the versioning state of a bucket, see GetBucketVersioning.
Related Resources
This is a convenience which creates an instance of the PutObjectRequest.Builder
avoiding the need to
create one manually via PutObjectRequest.builder()
putObjectRequest
- A Consumer
that will call methods on PutObjectRequest.Builder
to create a request.requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The
size of the content is expected to be known up front. See AsyncRequestBody
for specific details on
implementing this interface as well as links to precanned implementations for common scenarios like
uploading from a file. The service documentation for the request content is as follows '
Object data.
'default CompletableFuture<PutObjectResponse> putObject(PutObjectRequest putObjectRequest, Path sourcePath)
Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.
Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.
To ensure that data is not corrupted traversing the network, use the Content-MD5
header. When you
use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an
error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag
to the calculated MD5 value.
The Content-MD5
header is required for any request to upload an object with a retention period
configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock
Overview in the Amazon Simple Storage Service Developer Guide.
Server-side Encryption
You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys. For more information, see Using Server-Side Encryption.
Access Control List (ACL)-Specific Request Headers
You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.
Storage Class Options
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.
Versioning
If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.
For more information about versioning, see Adding Objects to Versioning Enabled Buckets. For information about returning the versioning state of a bucket, see GetBucketVersioning.
Related Resources
putObjectRequest
- sourcePath
- Path
to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
Object data.
'default CompletableFuture<PutObjectResponse> putObject(Consumer<PutObjectRequest.Builder> putObjectRequest, Path sourcePath)
Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it.
Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket.
Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead.
To ensure that data is not corrupted traversing the network, use the Content-MD5
header. When you
use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an
error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag
to the calculated MD5 value.
The Content-MD5
header is required for any request to upload an object with a retention period
configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock
Overview in the Amazon Simple Storage Service Developer Guide.
Server-side Encryption
You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys. For more information, see Using Server-Side Encryption.
Access Control List (ACL)-Specific Request Headers
You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.
Storage Class Options
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.
Versioning
If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects.
For more information about versioning, see Adding Objects to Versioning Enabled Buckets. For information about returning the versioning state of a bucket, see GetBucketVersioning.
Related Resources
This is a convenience which creates an instance of the PutObjectRequest.Builder
avoiding the need to
create one manually via PutObjectRequest.builder()
putObjectRequest
- A Consumer
that will call methods on PutObjectRequest.Builder
to create a request.sourcePath
- Path
to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
Object data.
'default CompletableFuture<PutObjectAclResponse> putObjectAcl(PutObjectAclRequest putObjectAclRequest)
Uses the acl
subresource to set the access control list (ACL) permissions for a new or existing
object in an S3 bucket. You must have WRITE_ACP
permission to set the ACL of an object. For more
information, see What
permissions can I grant? in the Amazon Simple Storage Service Developer Guide.
This action is not supported by Amazon S3 on Outposts.
Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 Developer Guide.
Access Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with the x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs,
known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL
name as the value of x-amz-ac
l. If you use this header, you cannot use other access control-specific
headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
,
x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. When using these headers,
you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the
permission. If you use these ACL-specific headers, you cannot use x-amz-acl
header to set a canned
ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see
Access Control List (ACL)
Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
emailAddress
– if the value specified is the email address of an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following x-amz-grant-read
header grants list objects permission to the two AWS
accounts identified by their email addresses.
x-amz-grant-read: emailAddress="[email protected]", emailAddress="[email protected]"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By the person's ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request.
By URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>[email protected]<></EmailAddress>lt;/Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
Versioning
The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of
an object. To set the ACL of a different version, use the versionId
subresource.
Related Resources
putObjectAclRequest
- default CompletableFuture<PutObjectAclResponse> putObjectAcl(Consumer<PutObjectAclRequest.Builder> putObjectAclRequest)
Uses the acl
subresource to set the access control list (ACL) permissions for a new or existing
object in an S3 bucket. You must have WRITE_ACP
permission to set the ACL of an object. For more
information, see What
permissions can I grant? in the Amazon Simple Storage Service Developer Guide.
This action is not supported by Amazon S3 on Outposts.
Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see Access Control List (ACL) Overview in the Amazon S3 Developer Guide.
Access Permissions
You can set access permissions using one of the following methods:
Specify a canned ACL with the x-amz-acl
request header. Amazon S3 supports a set of predefined ACLs,
known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL
name as the value of x-amz-ac
l. If you use this header, you cannot use other access control-specific
headers in your request. For more information, see Canned ACL.
Specify access permissions explicitly with the x-amz-grant-read
, x-amz-grant-read-acp
,
x-amz-grant-write-acp
, and x-amz-grant-full-control
headers. When using these headers,
you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the
permission. If you use these ACL-specific headers, you cannot use x-amz-acl
header to set a canned
ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see
Access Control List (ACL)
Overview.
You specify each grantee as a type=value pair, where the type is one of the following:
id
– if the value specified is the canonical user ID of an AWS account
uri
– if you are granting permissions to a predefined group
emailAddress
– if the value specified is the email address of an AWS account
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
For example, the following x-amz-grant-read
header grants list objects permission to the two AWS
accounts identified by their email addresses.
x-amz-grant-read: emailAddress="[email protected]", emailAddress="[email protected]"
You can use either a canned ACL or specify access permissions explicitly. You cannot do both.
Grantee Values
You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways:
By the person's ID:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"><ID><>ID<></ID><DisplayName><>GranteesEmail<></DisplayName> </Grantee>
DisplayName is optional and ignored in the request.
By URI:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"><URI><>http://acs.amazonaws.com/groups/global/AuthenticatedUsers<></URI></Grantee>
By Email address:
<Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"><EmailAddress><>[email protected]<></EmailAddress>lt;/Grantee>
The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser.
Using email addresses to specify a grantee is only supported in the following AWS Regions:
US East (N. Virginia)
US West (N. California)
US West (Oregon)
Asia Pacific (Singapore)
Asia Pacific (Sydney)
Asia Pacific (Tokyo)
Europe (Ireland)
South America (São Paulo)
For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints in the AWS General Reference.
Versioning
The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of
an object. To set the ACL of a different version, use the versionId
subresource.
Related Resources
This is a convenience which creates an instance of the PutObjectAclRequest.Builder
avoiding the need to
create one manually via PutObjectAclRequest.builder()
putObjectAclRequest
- A Consumer
that will call methods on PutObjectAclRequest.Builder
to create a request.default CompletableFuture<PutObjectLegalHoldResponse> putObjectLegalHold(PutObjectLegalHoldRequest putObjectLegalHoldRequest)
Applies a Legal Hold configuration to the specified object.
This action is not supported by Amazon S3 on Outposts.
Related Resources
putObjectLegalHoldRequest
- default CompletableFuture<PutObjectLegalHoldResponse> putObjectLegalHold(Consumer<PutObjectLegalHoldRequest.Builder> putObjectLegalHoldRequest)
Applies a Legal Hold configuration to the specified object.
This action is not supported by Amazon S3 on Outposts.
Related Resources
This is a convenience which creates an instance of the PutObjectLegalHoldRequest.Builder
avoiding the
need to create one manually via PutObjectLegalHoldRequest.builder()
putObjectLegalHoldRequest
- A Consumer
that will call methods on PutObjectLegalHoldRequest.Builder
to create a
request.default CompletableFuture<PutObjectLockConfigurationResponse> putObjectLockConfiguration(PutObjectLockConfigurationRequest putObjectLockConfigurationRequest)
Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.
DefaultRetention
requires either Days or Years. You can't specify both at the same time.
Related Resources
putObjectLockConfigurationRequest
- default CompletableFuture<PutObjectLockConfigurationResponse> putObjectLockConfiguration(Consumer<PutObjectLockConfigurationRequest.Builder> putObjectLockConfigurationRequest)
Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket.
DefaultRetention
requires either Days or Years. You can't specify both at the same time.
Related Resources
This is a convenience which creates an instance of the PutObjectLockConfigurationRequest.Builder
avoiding
the need to create one manually via PutObjectLockConfigurationRequest.builder()
putObjectLockConfigurationRequest
- A Consumer
that will call methods on PutObjectLockConfigurationRequest.Builder
to create a
request.default CompletableFuture<PutObjectRetentionResponse> putObjectRetention(PutObjectRetentionRequest putObjectRetentionRequest)
Places an Object Retention configuration on an object.
This action is not supported by Amazon S3 on Outposts.
Related Resources
putObjectRetentionRequest
- default CompletableFuture<PutObjectRetentionResponse> putObjectRetention(Consumer<PutObjectRetentionRequest.Builder> putObjectRetentionRequest)
Places an Object Retention configuration on an object.
This action is not supported by Amazon S3 on Outposts.
Related Resources
This is a convenience which creates an instance of the PutObjectRetentionRequest.Builder
avoiding the
need to create one manually via PutObjectRetentionRequest.builder()
putObjectRetentionRequest
- A Consumer
that will call methods on PutObjectRetentionRequest.Builder
to create a
request.default CompletableFuture<PutObjectTaggingResponse> putObjectTagging(PutObjectTaggingRequest putObjectTaggingRequest)
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
putObjectTaggingRequest
- default CompletableFuture<PutObjectTaggingResponse> putObjectTagging(Consumer<PutObjectTaggingRequest.Builder> putObjectTaggingRequest)
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
This is a convenience which creates an instance of the PutObjectTaggingRequest.Builder
avoiding the need
to create one manually via PutObjectTaggingRequest.builder()
putObjectTaggingRequest
- A Consumer
that will call methods on PutObjectTaggingRequest.Builder
to create a request.default CompletableFuture<PutPublicAccessBlockResponse> putPublicAccessBlock(PutPublicAccessBlockRequest putPublicAccessBlockRequest)
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
putPublicAccessBlockRequest
- default CompletableFuture<PutPublicAccessBlockResponse> putPublicAccessBlock(Consumer<PutPublicAccessBlockRequest.Builder> putPublicAccessBlockRequest)
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
This is a convenience which creates an instance of the PutPublicAccessBlockRequest.Builder
avoiding the
need to create one manually via PutPublicAccessBlockRequest.builder()
putPublicAccessBlockRequest
- A Consumer
that will call methods on PutPublicAccessBlockRequest.Builder
to create a
request.default CompletableFuture<RestoreObjectResponse> restoreObject(RestoreObjectRequest restoreObjectRequest)
Restores an archived copy of an object back into Amazon S3
This action is not supported by Amazon S3 on Outposts.
This action 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:
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 that you archive to the S3 Glacier, S3 Glacier Deep Archive, S3 Intelligent-Tiering Archive, or S3 Intelligent-Tiering Deep Archive storage classes are not accessible in real time. For objects in Archive Access tier or Deep Archive Access tier you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify.
To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.
When restoring an archived object (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 S3
Glacier or S3 Intelligent-Tiering Archive 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 is
typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited
retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for
objects stored in the S3 Glacier Deep Archive or S3 Intelligent-Tiering Deep Archive storage class.
Standard
- Standard retrievals allow you to access any of your archived objects within
several hours. This is the default option for retrieval requests that do not specify the retrieval option.
Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier or S3
Intelligent-Tiering Archive storage class. They typically finish within 12 hours for objects stored in the S3
Glacier Deep Archive or S3 Intelligent-Tiering Deep Archive storage class. Standard retrievals are free for
objects stored in S3 Intelligent-Tiering.
Bulk
- Bulk retrievals are the lowest-cost retrieval option in S3 Glacier, enabling you to
retrieve large amounts, even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 hours
for objects stored in the S3 Glacier or S3 Intelligent-Tiering Archive storage class. They typically finish
within 48 hours for objects stored in the S3 Glacier Deep Archive or S3 Intelligent-Tiering Deep Archive storage
class. Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.
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. 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 is not previously restored, then Amazon S3 returns 202 Accepted
in the response.
If the object is previously restored, Amazon S3 returns 200 OK
in the response.
Special Errors
Code: RestoreAlreadyInProgress
Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: GlacierExpeditedRetrievalNotAvailable
Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)
HTTP Status Code: 503
SOAP Fault Code Prefix: N/A
Related Resources
SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon Simple Storage Service Developer Guide
restoreObjectRequest
- default CompletableFuture<RestoreObjectResponse> restoreObject(Consumer<RestoreObjectRequest.Builder> restoreObjectRequest)
Restores an archived copy of an object back into Amazon S3
This action is not supported by Amazon S3 on Outposts.
This action 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:
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 that you archive to the S3 Glacier, S3 Glacier Deep Archive, S3 Intelligent-Tiering Archive, or S3 Intelligent-Tiering Deep Archive storage classes are not accessible in real time. For objects in Archive Access tier or Deep Archive Access tier you must first initiate a restore request, and then wait until the object is moved into the Frequent Access tier. For objects in S3 Glacier or S3 Glacier Deep Archive you must first initiate a restore request, and then wait until a temporary copy of the object is available. To access an archived object, you must restore the object for the duration (number of days) that you specify.
To restore a specific object version, you can provide a version ID. If you don't provide a version ID, Amazon S3 restores the current version.
When restoring an archived object (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 S3
Glacier or S3 Intelligent-Tiering Archive 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 is
typically made available within 1–5 minutes. Provisioned capacity ensures that retrieval capacity for Expedited
retrievals is available when you need it. Expedited retrievals and provisioned capacity are not available for
objects stored in the S3 Glacier Deep Archive or S3 Intelligent-Tiering Deep Archive storage class.
Standard
- Standard retrievals allow you to access any of your archived objects within
several hours. This is the default option for retrieval requests that do not specify the retrieval option.
Standard retrievals typically finish within 3–5 hours for objects stored in the S3 Glacier or S3
Intelligent-Tiering Archive storage class. They typically finish within 12 hours for objects stored in the S3
Glacier Deep Archive or S3 Intelligent-Tiering Deep Archive storage class. Standard retrievals are free for
objects stored in S3 Intelligent-Tiering.
Bulk
- Bulk retrievals are the lowest-cost retrieval option in S3 Glacier, enabling you to
retrieve large amounts, even petabytes, of data inexpensively. Bulk retrievals typically finish within 5–12 hours
for objects stored in the S3 Glacier or S3 Intelligent-Tiering Archive storage class. They typically finish
within 48 hours for objects stored in the S3 Glacier Deep Archive or S3 Intelligent-Tiering Deep Archive storage
class. Bulk retrievals are free for objects stored in S3 Intelligent-Tiering.
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. 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 is not previously restored, then Amazon S3 returns 202 Accepted
in the response.
If the object is previously restored, Amazon S3 returns 200 OK
in the response.
Special Errors
Code: RestoreAlreadyInProgress
Cause: Object restore is already in progress. (This error does not apply to SELECT type requests.)
HTTP Status Code: 409 Conflict
SOAP Fault Code Prefix: Client
Code: GlacierExpeditedRetrievalNotAvailable
Cause: expedited retrievals are currently not available. Try again later. (Returned if there is insufficient capacity to process the Expedited request. This error applies only to Expedited retrievals and not to S3 Standard or Bulk retrievals.)
HTTP Status Code: 503
SOAP Fault Code Prefix: N/A
Related Resources
SQL Reference for Amazon S3 Select and S3 Glacier Select in the Amazon Simple Storage Service Developer Guide
This is a convenience which creates an instance of the RestoreObjectRequest.Builder
avoiding the need to
create one manually via RestoreObjectRequest.builder()
restoreObjectRequest
- A Consumer
that will call methods on RestoreObjectRequest.Builder
to create a request.default CompletableFuture<UploadPartResponse> uploadPart(UploadPartRequest uploadPartRequest, AsyncRequestBody requestBody)
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.
If the upload request is signed with Signature Version 4, then AWS S3 uses the x-amz-content-sha256
header as a checksum instead of Content-MD5
. For more information see Authenticating
Requests: Using the Authorization Header (AWS Signature Version 4).
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
uploadPartRequest
- requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The
size of the content is expected to be known up front. See AsyncRequestBody
for specific details on
implementing this interface as well as links to precanned implementations for common scenarios like
uploading from a file. The service documentation for the request content is as follows '
Object data.
'default CompletableFuture<UploadPartResponse> uploadPart(Consumer<UploadPartRequest.Builder> uploadPartRequest, AsyncRequestBody requestBody)
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.
If the upload request is signed with Signature Version 4, then AWS S3 uses the x-amz-content-sha256
header as a checksum instead of Content-MD5
. For more information see Authenticating
Requests: Using the Authorization Header (AWS Signature Version 4).
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
This is a convenience which creates an instance of the UploadPartRequest.Builder
avoiding the need to
create one manually via UploadPartRequest.builder()
uploadPartRequest
- A Consumer
that will call methods on UploadPartRequest.Builder
to create a request.requestBody
- Functional interface that can be implemented to produce the request content in a non-blocking manner. The
size of the content is expected to be known up front. See AsyncRequestBody
for specific details on
implementing this interface as well as links to precanned implementations for common scenarios like
uploading from a file. The service documentation for the request content is as follows '
Object data.
'default CompletableFuture<UploadPartResponse> uploadPart(UploadPartRequest uploadPartRequest, Path sourcePath)
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.
If the upload request is signed with Signature Version 4, then AWS S3 uses the x-amz-content-sha256
header as a checksum instead of Content-MD5
. For more information see Authenticating
Requests: Using the Authorization Header (AWS Signature Version 4).
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
uploadPartRequest
- sourcePath
- Path
to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
Object data.
'default CompletableFuture<UploadPartResponse> uploadPart(Consumer<UploadPartRequest.Builder> uploadPartRequest, Path sourcePath)
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.
If the upload request is signed with Signature Version 4, then AWS S3 uses the x-amz-content-sha256
header as a checksum instead of Content-MD5
. For more information see Authenticating
Requests: Using the Authorization Header (AWS Signature Version 4).
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
This is a convenience which creates an instance of the UploadPartRequest.Builder
avoiding the need to
create one manually via UploadPartRequest.builder()
uploadPartRequest
- A Consumer
that will call methods on UploadPartRequest.Builder
to create a request.sourcePath
- Path
to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows '
Object data.
'default CompletableFuture<UploadPartCopyResponse> uploadPartCopy(UploadPartCopyRequest uploadPartCopyRequest)
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
uploadPartCopyRequest
- default CompletableFuture<UploadPartCopyResponse> uploadPartCopy(Consumer<UploadPartCopyRequest.Builder> uploadPartCopyRequest)
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
This is a convenience which creates an instance of the UploadPartCopyRequest.Builder
avoiding the need to
create one manually via UploadPartCopyRequest.builder()
uploadPartCopyRequest
- A Consumer
that will call methods on UploadPartCopyRequest.Builder
to create a request.default S3Utilities utilities()
S3Utilities
object with the configuration set on this client.default S3AsyncWaiter waiter()
S3AsyncWaiter
using this client.
Waiters created via this method are managed by the SDK and resources will be released when the service client is closed.
S3AsyncWaiter
Copyright © 2020. All rights reserved.