copy method
Creates a copy of an object stored in Object Storage. Objects up to 5 GB can be copied with a single copy operation. For objects larger than 5 GB, use the copyPart operation.
To specify the copy source, use the X-Amz-Copy-Source header. The copy request must not pass any data other than headers.
Note
Object Storage does not lock an object for writing and can simultaneously accept multiple requests that copy objects to the same resulting object. After all the requests are completed, the resulting object is the one whose copy operation was run last.
The object metadata is copied along with the object. If necessary, you can change the metadata by explicitly setting the appropriate headers.
You can also use headers to:
- Change an object's storage class.
- Add conditions for copying an object.
- Put a lock on an object (if the bucket is versioned and object lock is enabled).
The user must have permission to read the source object and write data to the resulting bucket.
Request
PUT /{bucket}/{key} HTTP/2
Path parameters
| Parameter | Description |
|---|---|
bucket |
Name of the resulting bucket. |
key |
Key of the resulting object. ID that the object is saved with in Object Storage. |
Headers
Required headers are listed in the table below.
| Header | Description |
|---|---|
X-Amz-Copy-Source |
The name of the bucket and the key of the object to copy separated by /.For example, X-Amz-Copy-Source: /source_bucket/sourceObject.If the bucket has versioning enabled, you can copy a specific version of the object. To do this, specify the object version ID in the header by adding ?versionId=<version-id> to the value of the header, for example: /mybucket/image.png?versionId=0005E4A66AD990A4. If you do not specify a version ID, the most recent version of the object will be copied. |
You should also use the necessary common request headers.
Use the headers from the table below if you need to change the default behavior of the copy method.
| Header | Description |
|---|---|
X-Amz-Metadata-Directive |
Metadata copy mode. If the header value is COPY, the object metadata is copied and all the X-Amz-Meta-* headers are ignored. Default behavior of the copy method.If the header value is REPLACE, the object metadata is replaced with the metadata specified in the request.The X-Amz-Storage-Class header is not copied; add it to the request if necessary. |
X-Amz-Copy-Source-If-Match |
Condition for copying an object. If the object's ETag matches the one specified in the header, the object is copied.If the condition is not met, Object Storage returns error 412. Can be used with the X-Amz-Copy-Source-If-Unmodified-Since. |
X-Amz-Copy-Source-If-None-Match |
Condition for copying an object. If the object's ETag does not match the one specified in the header, the object is copied.If the condition is not met, Object Storage returns error 412. Can be used with the X-Amz-Copy-Source-If-Unmodified-Since. |
X-Amz-Copy-Source-If-Unmodified-Since |
Condition for copying an object. The object is copied if it has not been modified since the specified time. If the condition is not met, Object Storage returns error 412. Can be used with the X-Amz-Copy-Source-If-Match. |
X-Amz-Copy-Source-If-Modified-Since |
Condition for copying an object. The object is copied if it has been modified since the specified time. If the condition is not met, Object Storage returns error 412. Can be used with the X-Amz-Copy-Source-If-None-Match. |
X-Amz-Server-Side-Encryption |
Default encryption algorithm used for new objects. |
X-Amz-Server-Side-Encryption-Aws-Kms-Key-Id |
ID of the KMS key used by default to encrypt new objects. |
X-Amz-Storage-Class |
Object storage class. Possible values:
|
X-Amz-Object-Lock-Mode |
Type of retention put on the object (if the bucket is versioned and object lock is enabled in it):
On an object version, you can put only retention (the headers |
X-Amz-Object-Lock-Retain-Until-Date |
Date and time until which the object is retained, specified in any format described in the HTTP standard. For example, Mon, 12 Dec 2022 09:00:00 GMT. Specified only together with the X-Amz-Object-Lock-Mode header. |
X-Amz-Object-Lock-Legal-Hold |
Type of legal hold put on the object (if the bucket is versioned and object lock is enabled in it):
On an object version, you can put only retention (the headers |
X-Amz-Meta-* |
User-defined metadata. Object Storage transforms all headers starting with X-Amz-Meta- as follows: X-Amz-Meta-foo-bar_baz → X-Amz-Meta-Foo-Bar_baz.Total user-defined header size must not exceed 2 KB. The size of user-defined data is determined as the length of the UTF-8 encoded string. Both the headers and their values are included in the size. Headers that have X-Amz-Metadata-Directive: COPY are ignored. |
Response
Headers
A response may contain common response headers and the headers listed in the table below.
| Header | Description |
|---|---|
X-Amz-Storage-Class |
Object storage class. Possible values:
|
Response codes
For a list of possible responses, see Responses.
Data schema
<CopyObjectResult>
<LastModified>2019-02-15T14:32:00</LastModified>
<ETag>"9bgh7535f2734ec974343yuc93985328"</ETag>
</CopyObjectResult>
| Element | Description |
|---|---|
CopyObjectResult |
Contains response elements. Path: /CopyObjectResult. |
ETag |
ETag of the resulting object. Because metadata is not taken into account when calculating the ETag, the ETag of the source and resulting objects must match.Path: /CopyObjectResult/ETag. |
LastModified |
Date when the object was last modified. Path: /CopyObjectResult/LastModified. |