copyObject method

required String bucket,
required String copySource,
required String key,
ObjectCannedACL? acl,
bool? bucketKeyEnabled,
String? cacheControl,
String? contentDisposition,
String? contentEncoding,
String? contentLanguage,
String? contentType,
String? copySourceIfMatch,
DateTime? copySourceIfModifiedSince,
String? copySourceIfNoneMatch,
DateTime? copySourceIfUnmodifiedSince,
String? copySourceSSECustomerAlgorithm,
Uint8List? copySourceSSECustomerKey,
String? copySourceSSECustomerKeyMD5,
String? expectedBucketOwner,
String? expectedSourceBucketOwner,
DateTime? expires,
String? grantFullControl,
String? grantRead,
String? grantReadACP,
String? grantWriteACP,
Map<String, String>? metadata,
MetadataDirective? metadataDirective,
ObjectLockLegalHoldStatus? objectLockLegalHoldStatus,
ObjectLockMode? objectLockMode,
DateTime? objectLockRetainUntilDate,
RequestPayer? requestPayer,
String? sSECustomerAlgorithm,
Uint8List? sSECustomerKey,
String? sSECustomerKeyMD5,
String? sSEKMSEncryptionContext,
String? sSEKMSKeyId,
ServerSideEncryption? serverSideEncryption,
StorageClass? storageClass,
String? tagging,
TaggingDirective? taggingDirective,
String? websiteRedirectLocation,

})

Creates a copy of an object that is already stored in Amazon S3. 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. 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. 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

Server-side encryption

When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with AWS managed encryption keys (SSE-S3 or SSE-KMS) or 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. 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 Simple Storage Service Developer Guide.

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.

May throw ObjectNotInActiveTierError.

Parameter bucket : The name of the destination bucket.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation with an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

When using this API with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com. When using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.

Parameter copySource : Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.
For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>. For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded. Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>. For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

Parameter key : The key of the destination object.

Parameter acl : The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Parameter bucketKeyEnabled : Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using AWS KMS (SSE-KMS). Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.

Specifying this header with a COPY operation doesn’t affect bucket-level settings for S3 Bucket Key.

Parameter cacheControl : Specifies caching behavior along the request/reply chain.

Parameter contentDisposition : Specifies presentational information for the object.

Parameter contentEncoding : Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

Parameter contentLanguage : The language the content is in.

Parameter contentType : A standard MIME type describing the format of the object data.

Parameter copySourceIfMatch : Copies the object if its entity tag (ETag) matches the specified tag.

Parameter copySourceIfModifiedSince : Copies the object if it has been modified since the specified time.

Parameter copySourceIfNoneMatch : Copies the object if its entity tag (ETag) is different than the specified ETag.

Parameter copySourceIfUnmodifiedSince : Copies the object if it hasn't been modified since the specified time.

Parameter copySourceSSECustomerAlgorithm : Specifies the algorithm to use when decrypting the source object (for example, AES256).

Parameter copySourceSSECustomerKey : Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

Parameter copySourceSSECustomerKeyMD5 : Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Parameter expectedBucketOwner : The account id of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Parameter expectedSourceBucketOwner : The account id of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Parameter expires : The date and time at which the object is no longer cacheable.

Parameter grantFullControl : Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

Parameter grantRead : Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

Parameter grantReadACP : Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

Parameter grantWriteACP : Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

Parameter metadata : A map of metadata to store with the object in S3.

Parameter metadataDirective : Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Parameter objectLockLegalHoldStatus : Specifies whether you want to apply a Legal Hold to the copied object.

Parameter objectLockMode : The Object Lock mode that you want to apply to the copied object.

Parameter objectLockRetainUntilDate : The date and time when you want the copied object's Object Lock to expire.

Parameter sSECustomerAlgorithm : Specifies the algorithm to use to when encrypting the object (for example, AES256).

Parameter sSECustomerKey : Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

Parameter sSECustomerKeyMD5 : Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Parameter sSEKMSEncryptionContext : Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.

Parameter sSEKMSKeyId : Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 Developer Guide.

Parameter serverSideEncryption : The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Parameter storageClass : By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 Service Developer Guide.

Parameter tagging : The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective. The tag-set must be encoded as URL Query parameters.

Parameter taggingDirective : Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

Parameter websiteRedirectLocation : If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

Implementation

Future<CopyObjectOutput> copyObject({
  required String bucket,
  required String copySource,
  required String key,
  ObjectCannedACL? acl,
  bool? bucketKeyEnabled,
  String? cacheControl,
  String? contentDisposition,
  String? contentEncoding,
  String? contentLanguage,
  String? contentType,
  String? copySourceIfMatch,
  DateTime? copySourceIfModifiedSince,
  String? copySourceIfNoneMatch,
  DateTime? copySourceIfUnmodifiedSince,
  String? copySourceSSECustomerAlgorithm,
  Uint8List? copySourceSSECustomerKey,
  String? copySourceSSECustomerKeyMD5,
  String? expectedBucketOwner,
  String? expectedSourceBucketOwner,
  DateTime? expires,
  String? grantFullControl,
  String? grantRead,
  String? grantReadACP,
  String? grantWriteACP,
  Map<String, String>? metadata,
  MetadataDirective? metadataDirective,
  ObjectLockLegalHoldStatus? objectLockLegalHoldStatus,
  ObjectLockMode? objectLockMode,
  DateTime? objectLockRetainUntilDate,
  RequestPayer? requestPayer,
  String? sSECustomerAlgorithm,
  Uint8List? sSECustomerKey,
  String? sSECustomerKeyMD5,
  String? sSEKMSEncryptionContext,
  String? sSEKMSKeyId,
  ServerSideEncryption? serverSideEncryption,
  StorageClass? storageClass,
  String? tagging,
  TaggingDirective? taggingDirective,
  String? websiteRedirectLocation,
}) async {
  ArgumentError.checkNotNull(bucket, 'bucket');
  ArgumentError.checkNotNull(copySource, 'copySource');
  ArgumentError.checkNotNull(key, 'key');
  _s.validateStringLength(
    'key',
    key,
    1,
    1152921504606846976,
    isRequired: true,
  );
  final headers = <String, String>{
    'x-amz-copy-source': copySource.toString(),
    if (acl != null) 'x-amz-acl': acl.toValue(),
    if (bucketKeyEnabled != null)
      'x-amz-server-side-encryption-bucket-key-enabled':
          bucketKeyEnabled.toString(),
    if (cacheControl != null) 'Cache-Control': cacheControl.toString(),
    if (contentDisposition != null)
      'Content-Disposition': contentDisposition.toString(),
    if (contentEncoding != null)
      'Content-Encoding': contentEncoding.toString(),
    if (contentLanguage != null)
      'Content-Language': contentLanguage.toString(),
    if (contentType != null) 'Content-Type': contentType.toString(),
    if (copySourceIfMatch != null)
      'x-amz-copy-source-if-match': copySourceIfMatch.toString(),
    if (copySourceIfModifiedSince != null)
      'x-amz-copy-source-if-modified-since':
          _s.rfc822ToJson(copySourceIfModifiedSince),
    if (copySourceIfNoneMatch != null)
      'x-amz-copy-source-if-none-match': copySourceIfNoneMatch.toString(),
    if (copySourceIfUnmodifiedSince != null)
      'x-amz-copy-source-if-unmodified-since':
          _s.rfc822ToJson(copySourceIfUnmodifiedSince),
    if (copySourceSSECustomerAlgorithm != null)
      'x-amz-copy-source-server-side-encryption-customer-algorithm':
          copySourceSSECustomerAlgorithm.toString(),
    if (copySourceSSECustomerKey != null)
      'x-amz-copy-source-server-side-encryption-customer-key':
          copySourceSSECustomerKey.toString(),
    if (copySourceSSECustomerKeyMD5 != null)
      'x-amz-copy-source-server-side-encryption-customer-key-MD5':
          copySourceSSECustomerKeyMD5.toString(),
    if (expectedBucketOwner != null)
      'x-amz-expected-bucket-owner': expectedBucketOwner.toString(),
    if (expectedSourceBucketOwner != null)
      'x-amz-source-expected-bucket-owner':
          expectedSourceBucketOwner.toString(),
    if (expires != null) 'Expires': _s.rfc822ToJson(expires),
    if (grantFullControl != null)
      'x-amz-grant-full-control': grantFullControl.toString(),
    if (grantRead != null) 'x-amz-grant-read': grantRead.toString(),
    if (grantReadACP != null) 'x-amz-grant-read-acp': grantReadACP.toString(),
    if (grantWriteACP != null)
      'x-amz-grant-write-acp': grantWriteACP.toString(),
    if (metadata != null)
      ...metadata.map((key, value) => MapEntry('x-amz-meta-$key', value)),
    if (metadataDirective != null)
      'x-amz-metadata-directive': metadataDirective.toValue(),
    if (objectLockLegalHoldStatus != null)
      'x-amz-object-lock-legal-hold': objectLockLegalHoldStatus.toValue(),
    if (objectLockMode != null)
      'x-amz-object-lock-mode': objectLockMode.toValue(),
    if (objectLockRetainUntilDate != null)
      'x-amz-object-lock-retain-until-date':
          _s.iso8601ToJson(objectLockRetainUntilDate),
    if (requestPayer != null) 'x-amz-request-payer': requestPayer.toValue(),
    if (sSECustomerAlgorithm != null)
      'x-amz-server-side-encryption-customer-algorithm':
          sSECustomerAlgorithm.toString(),
    if (sSECustomerKey != null)
      'x-amz-server-side-encryption-customer-key': sSECustomerKey.toString(),
    if (sSECustomerKeyMD5 != null)
      'x-amz-server-side-encryption-customer-key-MD5':
          sSECustomerKeyMD5.toString(),
    if (sSEKMSEncryptionContext != null)
      'x-amz-server-side-encryption-context':
          sSEKMSEncryptionContext.toString(),
    if (sSEKMSKeyId != null)
      'x-amz-server-side-encryption-aws-kms-key-id': sSEKMSKeyId.toString(),
    if (serverSideEncryption != null)
      'x-amz-server-side-encryption': serverSideEncryption.toValue(),
    if (storageClass != null) 'x-amz-storage-class': storageClass.toValue(),
    if (tagging != null) 'x-amz-tagging': tagging.toString(),
    if (taggingDirective != null)
      'x-amz-tagging-directive': taggingDirective.toValue(),
    if (websiteRedirectLocation != null)
      'x-amz-website-redirect-location': websiteRedirectLocation.toString(),
  };
  final $result = await _protocol.sendRaw(
    method: 'PUT',
    requestUri:
        '/${Uri.encodeComponent(bucket)}/${key.split('/').map(Uri.encodeComponent).join('/')}',
    headers: headers,
    exceptionFnMap: _exceptionFns,
  );
  final $elem = await _s.xmlFromResponse($result);
  return CopyObjectOutput(
    copyObjectResult: CopyObjectResult.fromXml($elem),
    bucketKeyEnabled: _s.extractHeaderBoolValue(
        $result.headers, 'x-amz-server-side-encryption-bucket-key-enabled'),
    copySourceVersionId: _s.extractHeaderStringValue(
        $result.headers, 'x-amz-copy-source-version-id'),
    expiration:
        _s.extractHeaderStringValue($result.headers, 'x-amz-expiration'),
    requestCharged: _s
        .extractHeaderStringValue($result.headers, 'x-amz-request-charged')
        ?.toRequestCharged(),
    sSECustomerAlgorithm: _s.extractHeaderStringValue(
        $result.headers, 'x-amz-server-side-encryption-customer-algorithm'),
    sSECustomerKeyMD5: _s.extractHeaderStringValue(
        $result.headers, 'x-amz-server-side-encryption-customer-key-MD5'),
    sSEKMSEncryptionContext: _s.extractHeaderStringValue(
        $result.headers, 'x-amz-server-side-encryption-context'),
    sSEKMSKeyId: _s.extractHeaderStringValue(
        $result.headers, 'x-amz-server-side-encryption-aws-kms-key-id'),
    serverSideEncryption: _s
        .extractHeaderStringValue(
            $result.headers, 'x-amz-server-side-encryption')
        ?.toServerSideEncryption(),
    versionId:
        _s.extractHeaderStringValue($result.headers, 'x-amz-version-id'),
  );
}

copyObject method

Implementation

S3 class