Skip to main content

CopyObject

Creates a copy of an object that is already stored in Astran S3.

Permissions​

ActionDescriptionResource
PutObjectGrants permission to add an object to a bucketdestination object
GetObjectGrants permission to retrieve an object from a bucketsource object

For more information about related Astran S3 APIs, see the following:

Request Syntax​

PUT /Bucket/Key+ HTTP/1.1
Host: <partition>.s3.astran.io
x-amz-copy-source: CopySource

Body

URI Request Parameters​

The request uses the following URI parameters.

Bucket

The name of the destination bucket.

Required: Yes

Key

The key of the destination object.

Length Constraints: Minimum length of 1.

Required: Yes

x-amz-copy-source

Specifies the source object for the copy operation.

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 astranexamplebucket, use astranexamplebucket/reports/january.pdf.

The value must be URL-encoded.

By default, Astran S3 copies the latest version of the source object. If the current version is a delete marker, Astran S3 behaves as if the object was deleted.

To copy a different version, use the versionId query parameter. Specifically, append ?versionId=<version-id> to the value (for example, astranexamplebucket/reports/january.pdf?versionId=<versionId>).

Request Body​

The request accepts the following binary data.

Body

Response Syntax​

HTTP/1.1 200
ETag: ETag
x-amx-copy-source-version-id: CopySourceVersionId
x-amz-version-id: VersionId
<CopyObjectResult>
   <ETag>string</ETag>
</CopyObjectResult>

Response Elements​

If the action is successful, the service sends back an HTTP 200 response.

The response returns the following HTTP headers.

ETag

Entity tag for the uploaded object.

To ensure that data is not corrupted traversing the network, for objects where the ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Astran S3 and compare the returned ETag to the calculated MD5 value.

x-amz-copy-source-version-id

Version ID of the source object that was copied, if a version ID was specified in the request.

x-amz-version-id

Version ID of the newly created copy, if the destination bucket had versioning enabled.

CopyObjectResult

Root level tag for the CopyObjectResult parameters, returned in XML format by the service.

Required: Yes

Examples​

Sample Request​

This example copies my-image.jpg into the bucket bucket, with the key name my-second-image.jpg.

           PUT /mybucket/my-second-image.jpg HTTP/1.1
           Host: <partition>.s3.astran.io
           Date: Fri, 13 Dec 2024 22:32:00 GMT
           x-amz-copy-source: /bucket/my-image.jpg
           Authorization: authorization string

Sample Response​

This example illustrates one usage of CopyObject.

           HTTP/1.1 200 OK
           x-amz-copy-source-version-id: the-source-object-version-id
           x-amz-version-id: the-destination-object-version-id
           Date: Fri, 13 Dec 2024 22:32:00 GMT

           <CopyObjectResult>
              <ETag>some-etag</ETag>
           </CopyObjectResult>

Sample Request: Copying a specified version of an object​

The following request copies the my-image.jpg key with the specified version ID, copies it into the bucket bucket, and gives it the my-second-image.jpg key.

           PUT /mybucket/my-second-image.jpg HTTP/1.1
           Host: <partition>.s3.astran.io
           Date: Fri, 13 Dec 2024 22:32:00 GMT
           x-amz-copy-source: /bucket/my-image.jpg?versionId=some-version-id
           Authorization: authorization string

Success Response: Copying a versioned object into a version-enabled bucket​

The following response shows that an object was copied into a target bucket where versioning is enabled.

            HTTP/1.1 200 OK
            x-amz-version-id: dest-version-id
            x-amz-copy-source-version-id: source-version-id
            Date: Fri, 13 Dec 2024 22:32:00 GMT

            <?xml version="1.0" encoding="UTF-8"?>
            <CopyObjectResult>
              <ETag>some-etag</ETag>
            </CopyObjectResult>

Success Response: Copying a versioned object into a version-suspended bucket​

The following response shows that an object was copied into a target bucket where versioning is suspended. The parameter VersionId does not appear.

           HTTP/1.1 200 OK
           x-amz-copy-source-version-id: some-version-id
           Date: Fri, 13 Dec 2024 22:32:00 GMT

           <?xml version="1.0" encoding="UTF-8"?>
            <CopyObjectResult>
              <LastModified>2024-12-13T22:32:00</LastModified>
              <ETag>some-etag</ETag>
            </CopyObjectResult>

See Also​

For more information about using this API in one of the language-specific AWS SDKs, see the following: