public final class DefaultS3CrtAsyncClient extends DelegatingS3AsyncClient implements S3CrtAsyncClient
Modifier and Type | Class and Description |
---|---|
static class |
DefaultS3CrtAsyncClient.DefaultS3CrtClientBuilder |
SERVICE_METADATA_ID, SERVICE_NAME
Modifier and Type | Method and Description |
---|---|
CompletableFuture<CopyObjectResponse> |
copyObject(CopyObjectRequest copyObjectRequest)
Creates a copy of an object that is already stored in Amazon S3.
|
abortMultipartUpload, close, completeMultipartUpload, createBucket, createMultipartUpload, delegate, deleteBucket, deleteBucketAnalyticsConfiguration, deleteBucketCors, deleteBucketEncryption, deleteBucketIntelligentTieringConfiguration, deleteBucketInventoryConfiguration, deleteBucketLifecycle, deleteBucketMetricsConfiguration, deleteBucketOwnershipControls, deleteBucketPolicy, deleteBucketReplication, deleteBucketTagging, deleteBucketWebsite, deleteObject, deleteObjects, deleteObjectTagging, deletePublicAccessBlock, getBucketAccelerateConfiguration, getBucketAcl, getBucketAnalyticsConfiguration, getBucketCors, getBucketEncryption, getBucketIntelligentTieringConfiguration, getBucketInventoryConfiguration, getBucketLifecycleConfiguration, getBucketLocation, getBucketLogging, getBucketMetricsConfiguration, getBucketNotificationConfiguration, getBucketOwnershipControls, getBucketPolicy, getBucketPolicyStatus, getBucketReplication, getBucketRequestPayment, getBucketTagging, getBucketVersioning, getBucketWebsite, getObject, getObjectAcl, getObjectAttributes, getObjectLegalHold, getObjectLockConfiguration, getObjectRetention, getObjectTagging, getObjectTorrent, getPublicAccessBlock, headBucket, headObject, invokeOperation, listBucketAnalyticsConfigurations, listBucketIntelligentTieringConfigurations, listBucketInventoryConfigurations, listBucketMetricsConfigurations, listBuckets, listMultipartUploads, listObjects, listObjectsV2, listObjectVersions, listParts, putBucketAccelerateConfiguration, putBucketAcl, putBucketAnalyticsConfiguration, putBucketCors, putBucketEncryption, putBucketIntelligentTieringConfiguration, putBucketInventoryConfiguration, putBucketLifecycleConfiguration, putBucketLogging, putBucketMetricsConfiguration, putBucketNotificationConfiguration, putBucketOwnershipControls, putBucketPolicy, putBucketReplication, putBucketRequestPayment, putBucketTagging, putBucketVersioning, putBucketWebsite, putObject, putObjectAcl, putObjectLegalHold, putObjectLockConfiguration, putObjectRetention, putObjectTagging, putPublicAccessBlock, restoreObject, selectObjectContent, serviceClientConfiguration, serviceName, uploadPart, uploadPartCopy, utilities, waiter, writeGetObjectResponse
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
builder
abortMultipartUpload, abortMultipartUpload, completeMultipartUpload, completeMultipartUpload, copyObject, create, createBucket, createBucket, createMultipartUpload, createMultipartUpload, crtBuilder, crtCreate, deleteBucket, deleteBucket, deleteBucketAnalyticsConfiguration, deleteBucketAnalyticsConfiguration, deleteBucketCors, deleteBucketCors, deleteBucketEncryption, deleteBucketEncryption, deleteBucketIntelligentTieringConfiguration, deleteBucketIntelligentTieringConfiguration, deleteBucketInventoryConfiguration, deleteBucketInventoryConfiguration, deleteBucketLifecycle, deleteBucketLifecycle, deleteBucketMetricsConfiguration, deleteBucketMetricsConfiguration, deleteBucketOwnershipControls, deleteBucketOwnershipControls, deleteBucketPolicy, deleteBucketPolicy, deleteBucketReplication, deleteBucketReplication, deleteBucketTagging, deleteBucketTagging, deleteBucketWebsite, deleteBucketWebsite, deleteObject, deleteObject, deleteObjects, deleteObjects, deleteObjectTagging, deleteObjectTagging, deletePublicAccessBlock, deletePublicAccessBlock, getBucketAccelerateConfiguration, getBucketAccelerateConfiguration, getBucketAcl, getBucketAcl, getBucketAnalyticsConfiguration, getBucketAnalyticsConfiguration, getBucketCors, getBucketCors, getBucketEncryption, getBucketEncryption, getBucketIntelligentTieringConfiguration, getBucketIntelligentTieringConfiguration, getBucketInventoryConfiguration, getBucketInventoryConfiguration, getBucketLifecycleConfiguration, getBucketLifecycleConfiguration, getBucketLocation, getBucketLocation, getBucketLogging, getBucketLogging, getBucketMetricsConfiguration, getBucketMetricsConfiguration, getBucketNotificationConfiguration, getBucketNotificationConfiguration, getBucketOwnershipControls, getBucketOwnershipControls, getBucketPolicy, getBucketPolicy, getBucketPolicyStatus, getBucketPolicyStatus, getBucketReplication, getBucketReplication, getBucketRequestPayment, getBucketRequestPayment, getBucketTagging, getBucketTagging, getBucketVersioning, getBucketVersioning, getBucketWebsite, getBucketWebsite, getObject, getObject, getObject, getObject, getObjectAcl, getObjectAcl, getObjectAttributes, getObjectAttributes, getObjectLegalHold, getObjectLegalHold, getObjectLockConfiguration, getObjectLockConfiguration, getObjectRetention, getObjectRetention, getObjectTagging, getObjectTagging, getObjectTorrent, getObjectTorrent, getObjectTorrent, getObjectTorrent, getPublicAccessBlock, getPublicAccessBlock, headBucket, headBucket, headObject, headObject, listBucketAnalyticsConfigurations, listBucketAnalyticsConfigurations, listBucketIntelligentTieringConfigurations, listBucketIntelligentTieringConfigurations, listBucketInventoryConfigurations, listBucketInventoryConfigurations, listBucketMetricsConfigurations, listBucketMetricsConfigurations, listBuckets, listBuckets, listBuckets, listMultipartUploads, listMultipartUploads, listMultipartUploadsPaginator, listMultipartUploadsPaginator, listObjects, listObjects, listObjectsV2, listObjectsV2, listObjectsV2Paginator, listObjectsV2Paginator, listObjectVersions, listObjectVersions, listObjectVersionsPaginator, listObjectVersionsPaginator, listParts, listParts, listPartsPaginator, listPartsPaginator, putBucketAccelerateConfiguration, putBucketAccelerateConfiguration, putBucketAcl, putBucketAcl, putBucketAnalyticsConfiguration, putBucketAnalyticsConfiguration, putBucketCors, putBucketCors, putBucketEncryption, putBucketEncryption, putBucketIntelligentTieringConfiguration, putBucketIntelligentTieringConfiguration, putBucketInventoryConfiguration, putBucketInventoryConfiguration, putBucketLifecycleConfiguration, putBucketLifecycleConfiguration, putBucketLogging, putBucketLogging, putBucketMetricsConfiguration, putBucketMetricsConfiguration, putBucketNotificationConfiguration, putBucketNotificationConfiguration, putBucketOwnershipControls, putBucketOwnershipControls, putBucketPolicy, putBucketPolicy, putBucketReplication, putBucketReplication, putBucketRequestPayment, putBucketRequestPayment, putBucketTagging, putBucketTagging, putBucketVersioning, putBucketVersioning, putBucketWebsite, putBucketWebsite, putObject, putObject, putObject, putObject, putObjectAcl, putObjectAcl, putObjectLegalHold, putObjectLegalHold, putObjectLockConfiguration, putObjectLockConfiguration, putObjectRetention, putObjectRetention, putObjectTagging, putObjectTagging, putPublicAccessBlock, putPublicAccessBlock, restoreObject, restoreObject, selectObjectContent, selectObjectContent, serviceClientConfiguration, uploadPart, uploadPart, uploadPart, uploadPart, uploadPartCopy, uploadPartCopy, utilities, waiter, writeGetObjectResponse, writeGetObjectResponse, writeGetObjectResponse, writeGetObjectResponse
serviceName
close
public CompletableFuture<CopyObjectResponse> copyObject(CopyObjectRequest copyObjectRequest)
DelegatingS3AsyncClient
Creates a copy of an object that is already stored in Amazon S3.
You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy (UploadPartCopy) API. For more information, see Copy Object Using the REST Multipart Upload API.
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 action starts, you receive a standard Amazon S3 error. If the error
occurs during the copy operation, the error response is embedded in the 200 OK
response. This means
that a 200 OK
response can contain either a success or an error. If you call the S3 API directly,
make sure to design your application to parse the contents of the response and handle it appropriately. If you
use Amazon Web Services SDKs, SDKs handle this condition. The SDKs detect the embedded error and apply error
handling per your configuration settings (including automatically retrying the request as appropriate). If the
condition persists, the SDKs throws an exception (or, for the SDKs that don't use exceptions, they return the
error).
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. The request can also result in a data retrieval charge for the source if the source storage class bills for data retrieval. 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.
When copying an object, you can preserve all metadata (the default) or specify new metadata. However, the access control list (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 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys
for Amazon S3.
x-amz-website-redirect-location
is unique to each object and must be specified in the request
headers to copy the value.
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.
Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if you don't specify encryption information in your copy request, the encryption setting of the target object is set to the default encryption configuration of the destination bucket. By default, all buckets have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target object copy.
When you perform a CopyObject
operation, if you want to use a different type of encryption setting
for the target object, you can use other appropriate encryption-related headers to encrypt the target object with
a KMS key, an Amazon S3 managed key, or a customer-provided key. With server-side encryption, Amazon S3 encrypts
your data as it writes your data to disks in its data centers and decrypts the data when you access it. If the
encryption setting in your request is different from the default encryption configuration of the destination
bucket, the encryption setting in your request takes precedence. If the source object for the copy is stored in
Amazon S3 using SSE-C, you must provide the necessary encryption information in your request so that Amazon S3
can decrypt the object for copying. For more information about server-side encryption, see Using Server-Side
Encryption.
If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
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 Amazon Web Services accounts or to predefined groups that are 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.
If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs
are disabled and no longer affect permissions. Buckets that use this setting only accept PUT
requests that don't specify an ACL or PUT
requests that specify bucket owner full control ACLs, such
as the bucket-owner-full-control
canned ACL or an equivalent form of this ACL expressed in the XML
format.
For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.
When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you
copy the object over, you can optionally specify a different checksum algorithm to use with the
x-amz-checksum-algorithm
header.
You can use the CopyObject
action to change the storage class of an object that is already stored in
Amazon S3 by using the StorageClass
parameter. For more information, see Storage Classes in the
Amazon S3 User Guide.
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. For more information, see Copying Objects.
By default, x-amz-copy-source
header 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.
The following operations are related to CopyObject
:
copyObject
in interface S3AsyncClient
copyObject
in class DelegatingS3AsyncClient
Copyright © 2023. All rights reserved.