Struct aws_sdk_s3::operation::copy_object::builders::CopyObjectFluentBuilder
source · pub struct CopyObjectFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CopyObject
.
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.
You can copy individual objects between general purpose buckets, between directory buckets, and between general purpose buckets and directory buckets.
Directory buckets - For directory buckets, you must make requests for this API operation to the Zonal endpoint. These endpoints support virtual-hosted-style requests in the format https://bucket_name.s3express-az_id.region.amazonaws.com/key-name
. Path-style requests are not supported. For more information, see Regional and Zonal endpoints in the Amazon S3 User Guide.
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. For more information about how to enable a Region for your account, see Enable or disable a Region for standalone accounts in the Amazon Web Services Account Management Guide.
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.
- Authentication and authorization
-
All
CopyObject
requests must be authenticated and signed by using IAM credentials (access key ID and secret access key for the IAM identities). All headers with thex-amz-
prefix, includingx-amz-copy-source
, must be signed. For more information, see REST Authentication.Directory buckets - You must use the IAM credentials to authenticate and authorize your access to the
CopyObject
API operation, instead of using the temporary security credentials through theCreateSession
API operation.Amazon Web Services CLI or SDKs handles authentication and authorization on your behalf.
- Permissions
-
You must have read access to the source object and write access to the destination bucket.
-
General purpose bucket permissions - You must have permissions in an IAM policy based on the source and destination bucket types in a
CopyObject
operation.-
If the source object is in a general purpose bucket, you must have
s3:GetObject
permission to read the source object that is being copied. -
If the destination bucket is a general purpose bucket, you must have
s3:PutObject
permission to write the object copy to the destination bucket.
-
-
Directory bucket permissions - You must have permissions in a bucket policy or an IAM identity-based policy based on the source and destination bucket types in a
CopyObject
operation.-
If the source object that you want to copy is in a directory bucket, you must have the
s3express:CreateSession
permission in theAction
element of a policy to read the object. By default, the session is in theReadWrite
mode. If you want to restrict the access, you can explicitly set thes3express:SessionMode
condition key toReadOnly
on the copy source bucket. -
If the copy destination is a directory bucket, you must have the
s3express:CreateSession
permission in theAction
element of a policy to write the object to the destination. Thes3express:SessionMode
condition key can't be set toReadOnly
on the copy destination bucket.
For example policies, see Example bucket policies for S3 Express One Zone and Amazon Web Services Identity and Access Management (IAM) identity-based policies for S3 Express One Zone in the Amazon S3 User Guide.
-
-
- Response and special errors
-
When the request is an HTTP 1.1 request, the response is chunk encoded. When the request is not an HTTP 1.1 request, the response would not contain the
Content-Length
. You always need to read the entire response body to check if the copy succeeds. to keep the connection alive while we copy the data.-
If the copy is successful, you receive a response with information about the copied object.
-
A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. A
200 OK
response can contain either a success or an error.-
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. For example, in a cross-region copy, you may encounter throttling and receive a200 OK
response. For more information, see Resolve the Error 200 response when copying objects to Amazon S3. The200 OK
status code means the copy was accepted, but it doesn't mean the copy is complete. Another example is when you disconnect from Amazon S3 before the copy is complete, Amazon S3 might cancel the copy and you may receive a200 OK
response. You must stay connected to Amazon S3 until the entire response is successfully received and processed.If you call this API operation directly, make sure to design your application to parse the content 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 throw an exception (or, for the SDKs that don't use exceptions, they return an error).
-
-
- Charge
-
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. If the copy source is in a different region, the data transfer is billed to the copy source account. For pricing information, see Amazon S3 pricing.
- HTTP Host header syntax
-
Directory buckets - The HTTP Host header syntax is
Bucket_name.s3express-az_id.region.amazonaws.com
.
The following operations are related to CopyObject
:
Implementations§
source§impl CopyObjectFluentBuilder
impl CopyObjectFluentBuilder
sourcepub fn as_input(&self) -> &CopyObjectInputBuilder
pub fn as_input(&self) -> &CopyObjectInputBuilder
Access the CopyObject as a reference.
sourcepub async fn send(
self,
) -> Result<CopyObjectOutput, SdkError<CopyObjectError, HttpResponse>>
pub async fn send( self, ) -> Result<CopyObjectOutput, SdkError<CopyObjectError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn customize(
self,
) -> CustomizableOperation<CopyObjectOutput, CopyObjectError, Self>
pub fn customize( self, ) -> CustomizableOperation<CopyObjectOutput, CopyObjectError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn acl(self, input: ObjectCannedAcl) -> Self
pub fn acl(self, input: ObjectCannedAcl) -> Self
The canned access control list (ACL) to apply to the object.
When you copy an object, the ACL metadata is not preserved and is set to private
by default. Only the owner has full access control. To override the default ACL setting, specify a new ACL when you generate a copy request. For more information, see Using ACLs.
If the destination 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 destination 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.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn set_acl(self, input: Option<ObjectCannedAcl>) -> Self
pub fn set_acl(self, input: Option<ObjectCannedAcl>) -> Self
The canned access control list (ACL) to apply to the object.
When you copy an object, the ACL metadata is not preserved and is set to private
by default. Only the owner has full access control. To override the default ACL setting, specify a new ACL when you generate a copy request. For more information, see Using ACLs.
If the destination 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 destination 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.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn get_acl(&self) -> &Option<ObjectCannedAcl>
pub fn get_acl(&self) -> &Option<ObjectCannedAcl>
The canned access control list (ACL) to apply to the object.
When you copy an object, the ACL metadata is not preserved and is set to private
by default. Only the owner has full access control. To override the default ACL setting, specify a new ACL when you generate a copy request. For more information, see Using ACLs.
If the destination 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 destination 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.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn bucket(self, input: impl Into<String>) -> Self
pub fn bucket(self, input: impl Into<String>) -> Self
The name of the destination bucket.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3
(for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
sourcepub fn set_bucket(self, input: Option<String>) -> Self
pub fn set_bucket(self, input: Option<String>) -> Self
The name of the destination bucket.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3
(for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
sourcepub fn get_bucket(&self) -> &Option<String>
pub fn get_bucket(&self) -> &Option<String>
The name of the destination bucket.
Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket_name.s3express-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the format bucket_base_name--az-id--x-s3
(for example, DOC-EXAMPLE-BUCKET--usw2-az1--x-s3
). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
Access points - When you use this action with an access point, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When using the access point ARN, 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 action with an access point through the Amazon Web Services 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 S3 User Guide.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - When you use this action 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.
sourcepub fn cache_control(self, input: impl Into<String>) -> Self
pub fn cache_control(self, input: impl Into<String>) -> Self
Specifies the caching behavior along the request/reply chain.
sourcepub fn set_cache_control(self, input: Option<String>) -> Self
pub fn set_cache_control(self, input: Option<String>) -> Self
Specifies the caching behavior along the request/reply chain.
sourcepub fn get_cache_control(&self) -> &Option<String>
pub fn get_cache_control(&self) -> &Option<String>
Specifies the caching behavior along the request/reply chain.
sourcepub fn checksum_algorithm(self, input: ChecksumAlgorithm) -> Self
pub fn checksum_algorithm(self, input: ChecksumAlgorithm) -> Self
Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
When you copy an object, if the source object has a checksum, that checksum value will be copied to the new object by default. If the CopyObject
request does not include this x-amz-checksum-algorithm
header, the checksum algorithm will be copied from the source object to the destination object (if it's present on the source object). You can optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm
header. Unrecognized or unsupported values will respond with the HTTP status code 400 Bad Request
.
For directory buckets, when you use Amazon Web Services SDKs, CRC32
is the default checksum algorithm that's used for performance.
sourcepub fn set_checksum_algorithm(self, input: Option<ChecksumAlgorithm>) -> Self
pub fn set_checksum_algorithm(self, input: Option<ChecksumAlgorithm>) -> Self
Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
When you copy an object, if the source object has a checksum, that checksum value will be copied to the new object by default. If the CopyObject
request does not include this x-amz-checksum-algorithm
header, the checksum algorithm will be copied from the source object to the destination object (if it's present on the source object). You can optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm
header. Unrecognized or unsupported values will respond with the HTTP status code 400 Bad Request
.
For directory buckets, when you use Amazon Web Services SDKs, CRC32
is the default checksum algorithm that's used for performance.
sourcepub fn get_checksum_algorithm(&self) -> &Option<ChecksumAlgorithm>
pub fn get_checksum_algorithm(&self) -> &Option<ChecksumAlgorithm>
Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
When you copy an object, if the source object has a checksum, that checksum value will be copied to the new object by default. If the CopyObject
request does not include this x-amz-checksum-algorithm
header, the checksum algorithm will be copied from the source object to the destination object (if it's present on the source object). You can optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm
header. Unrecognized or unsupported values will respond with the HTTP status code 400 Bad Request
.
For directory buckets, when you use Amazon Web Services SDKs, CRC32
is the default checksum algorithm that's used for performance.
sourcepub fn content_disposition(self, input: impl Into<String>) -> Self
pub fn content_disposition(self, input: impl Into<String>) -> Self
Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.
sourcepub fn set_content_disposition(self, input: Option<String>) -> Self
pub fn set_content_disposition(self, input: Option<String>) -> Self
Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.
sourcepub fn get_content_disposition(&self) -> &Option<String>
pub fn get_content_disposition(&self) -> &Option<String>
Specifies presentational information for the object. Indicates whether an object should be displayed in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.
sourcepub fn content_encoding(self, input: impl Into<String>) -> Self
pub fn content_encoding(self, input: impl Into<String>) -> Self
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.
For directory buckets, only the aws-chunked
value is supported in this header field.
sourcepub fn set_content_encoding(self, input: Option<String>) -> Self
pub fn set_content_encoding(self, input: Option<String>) -> Self
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.
For directory buckets, only the aws-chunked
value is supported in this header field.
sourcepub fn get_content_encoding(&self) -> &Option<String>
pub fn get_content_encoding(&self) -> &Option<String>
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.
For directory buckets, only the aws-chunked
value is supported in this header field.
sourcepub fn content_language(self, input: impl Into<String>) -> Self
pub fn content_language(self, input: impl Into<String>) -> Self
The language the content is in.
sourcepub fn set_content_language(self, input: Option<String>) -> Self
pub fn set_content_language(self, input: Option<String>) -> Self
The language the content is in.
sourcepub fn get_content_language(&self) -> &Option<String>
pub fn get_content_language(&self) -> &Option<String>
The language the content is in.
sourcepub fn content_type(self, input: impl Into<String>) -> Self
pub fn content_type(self, input: impl Into<String>) -> Self
A standard MIME type that describes the format of the object data.
sourcepub fn set_content_type(self, input: Option<String>) -> Self
pub fn set_content_type(self, input: Option<String>) -> Self
A standard MIME type that describes the format of the object data.
sourcepub fn get_content_type(&self) -> &Option<String>
pub fn get_content_type(&self) -> &Option<String>
A standard MIME type that describes the format of the object data.
sourcepub fn copy_source(self, input: impl Into<String>) -> Self
pub fn copy_source(self, input: impl Into<String>) -> Self
Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket.
You specify the value of the copy source 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 general purpose bucketawsexamplebucket
, useawsexamplebucket/reports/january.pdf
. The value must be URL-encoded. To copy the objectreports/january.pdf
from the directory bucketawsexamplebucket--use1-az5--x-s3
, useawsexamplebucket--use1-az5--x-s3/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:
. For example, to copy the object: :accesspoint/ /object/ reports/january.pdf
through access pointmy-access-point
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.-
Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.
-
Access points are not supported by directory buckets.
Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format
arn:aws:s3-outposts:
. For example, to copy the object: :outpost/ /object/ reports/january.pdf
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded. -
If your source bucket versioning is enabled, the x-amz-copy-source
header by default 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
query parameter. Specifically, append ?versionId=
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.
If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the copied object. 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 destination bucket, the version ID that Amazon S3 generates in the x-amz-version-id
response header is always null.
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
sourcepub fn set_copy_source(self, input: Option<String>) -> Self
pub fn set_copy_source(self, input: Option<String>) -> Self
Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket.
You specify the value of the copy source 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 general purpose bucketawsexamplebucket
, useawsexamplebucket/reports/january.pdf
. The value must be URL-encoded. To copy the objectreports/january.pdf
from the directory bucketawsexamplebucket--use1-az5--x-s3
, useawsexamplebucket--use1-az5--x-s3/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:
. For example, to copy the object: :accesspoint/ /object/ reports/january.pdf
through access pointmy-access-point
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.-
Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.
-
Access points are not supported by directory buckets.
Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format
arn:aws:s3-outposts:
. For example, to copy the object: :outpost/ /object/ reports/january.pdf
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded. -
If your source bucket versioning is enabled, the x-amz-copy-source
header by default 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
query parameter. Specifically, append ?versionId=
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.
If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the copied object. 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 destination bucket, the version ID that Amazon S3 generates in the x-amz-version-id
response header is always null.
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
sourcepub fn get_copy_source(&self) -> &Option<String>
pub fn get_copy_source(&self) -> &Option<String>
Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object is an object that was uploaded by using a multipart upload, the object copy will be a single part object after the source object is copied to the destination bucket.
You specify the value of the copy source 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 general purpose bucketawsexamplebucket
, useawsexamplebucket/reports/january.pdf
. The value must be URL-encoded. To copy the objectreports/january.pdf
from the directory bucketawsexamplebucket--use1-az5--x-s3
, useawsexamplebucket--use1-az5--x-s3/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:
. For example, to copy the object: :accesspoint/ /object/ reports/january.pdf
through access pointmy-access-point
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf
. The value must be URL encoded.-
Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the same Amazon Web Services Region.
-
Access points are not supported by directory buckets.
Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format
arn:aws:s3-outposts:
. For example, to copy the object: :outpost/ /object/ reports/january.pdf
through outpostmy-outpost
owned by account123456789012
in Regionus-west-2
, use the URL encoding ofarn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf
. The value must be URL-encoded. -
If your source bucket versioning is enabled, the x-amz-copy-source
header by default 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
query parameter. Specifically, append ?versionId=
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.
If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the copied object. 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 destination bucket, the version ID that Amazon S3 generates in the x-amz-version-id
response header is always null.
Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
sourcepub fn copy_source_if_match(self, input: impl Into<String>) -> Self
pub fn copy_source_if_match(self, input: impl Into<String>) -> Self
Copies the object if its entity tag (ETag) matches the specified tag.
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
sourcepub fn set_copy_source_if_match(self, input: Option<String>) -> Self
pub fn set_copy_source_if_match(self, input: Option<String>) -> Self
Copies the object if its entity tag (ETag) matches the specified tag.
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
sourcepub fn get_copy_source_if_match(&self) -> &Option<String>
pub fn get_copy_source_if_match(&self) -> &Option<String>
Copies the object if its entity tag (ETag) matches the specified tag.
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
sourcepub fn copy_source_if_modified_since(self, input: DateTime) -> Self
pub fn copy_source_if_modified_since(self, input: DateTime) -> Self
Copies the object if it has been modified since the specified time.
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
sourcepub fn set_copy_source_if_modified_since(self, input: Option<DateTime>) -> Self
pub fn set_copy_source_if_modified_since(self, input: Option<DateTime>) -> Self
Copies the object if it has been modified since the specified time.
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
sourcepub fn get_copy_source_if_modified_since(&self) -> &Option<DateTime>
pub fn get_copy_source_if_modified_since(&self) -> &Option<DateTime>
Copies the object if it has been modified since the specified time.
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
sourcepub fn copy_source_if_none_match(self, input: impl Into<String>) -> Self
pub fn copy_source_if_none_match(self, input: impl Into<String>) -> Self
Copies the object if its entity tag (ETag) is different than the specified ETag.
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
sourcepub fn set_copy_source_if_none_match(self, input: Option<String>) -> Self
pub fn set_copy_source_if_none_match(self, input: Option<String>) -> Self
Copies the object if its entity tag (ETag) is different than the specified ETag.
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
sourcepub fn get_copy_source_if_none_match(&self) -> &Option<String>
pub fn get_copy_source_if_none_match(&self) -> &Option<String>
Copies the object if its entity tag (ETag) is different than the specified ETag.
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
sourcepub fn copy_source_if_unmodified_since(self, input: DateTime) -> Self
pub fn copy_source_if_unmodified_since(self, input: DateTime) -> Self
Copies the object if it hasn't been modified since the specified time.
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
sourcepub fn set_copy_source_if_unmodified_since(
self,
input: Option<DateTime>,
) -> Self
pub fn set_copy_source_if_unmodified_since( self, input: Option<DateTime>, ) -> Self
Copies the object if it hasn't been modified since the specified time.
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
sourcepub fn get_copy_source_if_unmodified_since(&self) -> &Option<DateTime>
pub fn get_copy_source_if_unmodified_since(&self) -> &Option<DateTime>
Copies the object if it hasn't been modified since the specified time.
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
sourcepub fn expires(self, input: DateTime) -> Self
pub fn expires(self, input: DateTime) -> Self
The date and time at which the object is no longer cacheable.
sourcepub fn set_expires(self, input: Option<DateTime>) -> Self
pub fn set_expires(self, input: Option<DateTime>) -> Self
The date and time at which the object is no longer cacheable.
sourcepub fn get_expires(&self) -> &Option<DateTime>
pub fn get_expires(&self) -> &Option<DateTime>
The date and time at which the object is no longer cacheable.
sourcepub fn grant_full_control(self, input: impl Into<String>) -> Self
pub fn grant_full_control(self, input: impl Into<String>) -> Self
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn set_grant_full_control(self, input: Option<String>) -> Self
pub fn set_grant_full_control(self, input: Option<String>) -> Self
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn get_grant_full_control(&self) -> &Option<String>
pub fn get_grant_full_control(&self) -> &Option<String>
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn grant_read(self, input: impl Into<String>) -> Self
pub fn grant_read(self, input: impl Into<String>) -> Self
Allows grantee to read the object data and its metadata.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn set_grant_read(self, input: Option<String>) -> Self
pub fn set_grant_read(self, input: Option<String>) -> Self
Allows grantee to read the object data and its metadata.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn get_grant_read(&self) -> &Option<String>
pub fn get_grant_read(&self) -> &Option<String>
Allows grantee to read the object data and its metadata.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn grant_read_acp(self, input: impl Into<String>) -> Self
pub fn grant_read_acp(self, input: impl Into<String>) -> Self
Allows grantee to read the object ACL.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn set_grant_read_acp(self, input: Option<String>) -> Self
pub fn set_grant_read_acp(self, input: Option<String>) -> Self
Allows grantee to read the object ACL.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn get_grant_read_acp(&self) -> &Option<String>
pub fn get_grant_read_acp(&self) -> &Option<String>
Allows grantee to read the object ACL.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn grant_write_acp(self, input: impl Into<String>) -> Self
pub fn grant_write_acp(self, input: impl Into<String>) -> Self
Allows grantee to write the ACL for the applicable object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn set_grant_write_acp(self, input: Option<String>) -> Self
pub fn set_grant_write_acp(self, input: Option<String>) -> Self
Allows grantee to write the ACL for the applicable object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn get_grant_write_acp(&self) -> &Option<String>
pub fn get_grant_write_acp(&self) -> &Option<String>
Allows grantee to write the ACL for the applicable object.
-
This functionality is not supported for directory buckets.
-
This functionality is not supported for Amazon S3 on Outposts.
sourcepub fn metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn metadata(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to Metadata
.
To override the contents of this collection use set_metadata
.
A map of metadata to store with the object in S3.
sourcepub fn set_metadata(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_metadata(self, input: Option<HashMap<String, String>>) -> Self
A map of metadata to store with the object in S3.
sourcepub fn get_metadata(&self) -> &Option<HashMap<String, String>>
pub fn get_metadata(&self) -> &Option<HashMap<String, String>>
A map of metadata to store with the object in S3.
sourcepub fn metadata_directive(self, input: MetadataDirective) -> Self
pub fn metadata_directive(self, input: MetadataDirective) -> Self
Specifies whether the metadata is copied from the source object or replaced with metadata that's provided in the request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If this header isn’t specified, COPY
is the default behavior.
General purpose bucket - For general purpose buckets, 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 Amazon S3 condition key examples in the Amazon S3 User Guide.
x-amz-website-redirect-location
is unique to each object and is not copied when using the x-amz-metadata-directive
header. To copy the value, you must specify x-amz-website-redirect-location
in the request header.
sourcepub fn set_metadata_directive(self, input: Option<MetadataDirective>) -> Self
pub fn set_metadata_directive(self, input: Option<MetadataDirective>) -> Self
Specifies whether the metadata is copied from the source object or replaced with metadata that's provided in the request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If this header isn’t specified, COPY
is the default behavior.
General purpose bucket - For general purpose buckets, 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 Amazon S3 condition key examples in the Amazon S3 User Guide.
x-amz-website-redirect-location
is unique to each object and is not copied when using the x-amz-metadata-directive
header. To copy the value, you must specify x-amz-website-redirect-location
in the request header.
sourcepub fn get_metadata_directive(&self) -> &Option<MetadataDirective>
pub fn get_metadata_directive(&self) -> &Option<MetadataDirective>
Specifies whether the metadata is copied from the source object or replaced with metadata that's provided in the request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If this header isn’t specified, COPY
is the default behavior.
General purpose bucket - For general purpose buckets, 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 Amazon S3 condition key examples in the Amazon S3 User Guide.
x-amz-website-redirect-location
is unique to each object and is not copied when using the x-amz-metadata-directive
header. To copy the value, you must specify x-amz-website-redirect-location
in the request header.
sourcepub fn tagging_directive(self, input: TaggingDirective) -> Self
pub fn tagging_directive(self, input: TaggingDirective) -> Self
Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's provided in the request.
The default value is COPY
.
Directory buckets - For directory buckets in a CopyObject
operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented
status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented
response in any of the following situations:
-
When you attempt to
COPY
the tag-set from an S3 source object that has non-empty tags. -
When you attempt to
REPLACE
the tag-set of a source object and set a non-empty value tox-amz-tagging
. -
When you don't set the
x-amz-tagging-directive
header and the source object has non-empty tags. This is because the default value ofx-amz-tagging-directive
isCOPY
.
Because only the empty tag-set is supported for directory buckets in a CopyObject
operation, the following situations are allowed:
-
When you attempt to
COPY
the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object. -
When you attempt to
REPLACE
the tag-set of a directory bucket source object and set thex-amz-tagging
value of the directory bucket destination object to empty. -
When you attempt to
REPLACE
the tag-set of a general purpose bucket source object that has non-empty tags and set thex-amz-tagging
value of the directory bucket destination object to empty. -
When you attempt to
REPLACE
the tag-set of a directory bucket source object and don't set thex-amz-tagging
value of the directory bucket destination object. This is because the default value ofx-amz-tagging
is the empty value.
sourcepub fn set_tagging_directive(self, input: Option<TaggingDirective>) -> Self
pub fn set_tagging_directive(self, input: Option<TaggingDirective>) -> Self
Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's provided in the request.
The default value is COPY
.
Directory buckets - For directory buckets in a CopyObject
operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented
status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented
response in any of the following situations:
-
When you attempt to
COPY
the tag-set from an S3 source object that has non-empty tags. -
When you attempt to
REPLACE
the tag-set of a source object and set a non-empty value tox-amz-tagging
. -
When you don't set the
x-amz-tagging-directive
header and the source object has non-empty tags. This is because the default value ofx-amz-tagging-directive
isCOPY
.
Because only the empty tag-set is supported for directory buckets in a CopyObject
operation, the following situations are allowed:
-
When you attempt to
COPY
the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object. -
When you attempt to
REPLACE
the tag-set of a directory bucket source object and set thex-amz-tagging
value of the directory bucket destination object to empty. -
When you attempt to
REPLACE
the tag-set of a general purpose bucket source object that has non-empty tags and set thex-amz-tagging
value of the directory bucket destination object to empty. -
When you attempt to
REPLACE
the tag-set of a directory bucket source object and don't set thex-amz-tagging
value of the directory bucket destination object. This is because the default value ofx-amz-tagging
is the empty value.
sourcepub fn get_tagging_directive(&self) -> &Option<TaggingDirective>
pub fn get_tagging_directive(&self) -> &Option<TaggingDirective>
Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's provided in the request.
The default value is COPY
.
Directory buckets - For directory buckets in a CopyObject
operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented
status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented
response in any of the following situations:
-
When you attempt to
COPY
the tag-set from an S3 source object that has non-empty tags. -
When you attempt to
REPLACE
the tag-set of a source object and set a non-empty value tox-amz-tagging
. -
When you don't set the
x-amz-tagging-directive
header and the source object has non-empty tags. This is because the default value ofx-amz-tagging-directive
isCOPY
.
Because only the empty tag-set is supported for directory buckets in a CopyObject
operation, the following situations are allowed:
-
When you attempt to
COPY
the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object. -
When you attempt to
REPLACE
the tag-set of a directory bucket source object and set thex-amz-tagging
value of the directory bucket destination object to empty. -
When you attempt to
REPLACE
the tag-set of a general purpose bucket source object that has non-empty tags and set thex-amz-tagging
value of the directory bucket destination object to empty. -
When you attempt to
REPLACE
the tag-set of a directory bucket source object and don't set thex-amz-tagging
value of the directory bucket destination object. This is because the default value ofx-amz-tagging
is the empty value.
sourcepub fn server_side_encryption(self, input: ServerSideEncryption) -> Self
pub fn server_side_encryption(self, input: ServerSideEncryption) -> Self
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
). Unrecognized or unsupported values won’t write a destination object and will receive a 400 Bad Request
response.
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 specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. 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.
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. For more information about server-side encryption, see Using Server-Side Encryption in the Amazon S3 User Guide.
For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) is supported.
sourcepub fn set_server_side_encryption(
self,
input: Option<ServerSideEncryption>,
) -> Self
pub fn set_server_side_encryption( self, input: Option<ServerSideEncryption>, ) -> Self
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
). Unrecognized or unsupported values won’t write a destination object and will receive a 400 Bad Request
response.
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 specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. 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.
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. For more information about server-side encryption, see Using Server-Side Encryption in the Amazon S3 User Guide.
For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) is supported.
sourcepub fn get_server_side_encryption(&self) -> &Option<ServerSideEncryption>
pub fn get_server_side_encryption(&self) -> &Option<ServerSideEncryption>
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
). Unrecognized or unsupported values won’t write a destination object and will receive a 400 Bad Request
response.
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 specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. 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.
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. For more information about server-side encryption, see Using Server-Side Encryption in the Amazon S3 User Guide.
For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256
) is supported.
sourcepub fn storage_class(self, input: StorageClass) -> Self
pub fn storage_class(self, input: StorageClass) -> Self
If the x-amz-storage-class
header is not used, the copied object will be stored in the STANDARD
Storage Class by default. The STANDARD
storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class.
-
Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. Unsupported storage class values won't write a destination object and will respond with the HTTP status code
400 Bad Request
. -
Amazon S3 on Outposts - S3 on Outposts only uses the
OUTPOSTS
Storage Class.
You can use the CopyObject
action to change the storage class of an object that is already stored in Amazon S3 by using the x-amz-storage-class
header. For more information, see Storage Classes in the Amazon S3 User Guide.
Before using an object as a source object for the copy operation, you must restore a copy of it if it meets any of the following conditions:
-
The storage class of the source object is
GLACIER
orDEEP_ARCHIVE
. -
The storage class of the source object is
INTELLIGENT_TIERING
and it's S3 Intelligent-Tiering access tier isArchive Access
orDeep Archive Access
.
For more information, see RestoreObject and Copying Objects in the Amazon S3 User Guide.
sourcepub fn set_storage_class(self, input: Option<StorageClass>) -> Self
pub fn set_storage_class(self, input: Option<StorageClass>) -> Self
If the x-amz-storage-class
header is not used, the copied object will be stored in the STANDARD
Storage Class by default. The STANDARD
storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class.
-
Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. Unsupported storage class values won't write a destination object and will respond with the HTTP status code
400 Bad Request
. -
Amazon S3 on Outposts - S3 on Outposts only uses the
OUTPOSTS
Storage Class.
You can use the CopyObject
action to change the storage class of an object that is already stored in Amazon S3 by using the x-amz-storage-class
header. For more information, see Storage Classes in the Amazon S3 User Guide.
Before using an object as a source object for the copy operation, you must restore a copy of it if it meets any of the following conditions:
-
The storage class of the source object is
GLACIER
orDEEP_ARCHIVE
. -
The storage class of the source object is
INTELLIGENT_TIERING
and it's S3 Intelligent-Tiering access tier isArchive Access
orDeep Archive Access
.
For more information, see RestoreObject and Copying Objects in the Amazon S3 User Guide.
sourcepub fn get_storage_class(&self) -> &Option<StorageClass>
pub fn get_storage_class(&self) -> &Option<StorageClass>
If the x-amz-storage-class
header is not used, the copied object will be stored in the STANDARD
Storage Class by default. The STANDARD
storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class.
-
Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects. Unsupported storage class values won't write a destination object and will respond with the HTTP status code
400 Bad Request
. -
Amazon S3 on Outposts - S3 on Outposts only uses the
OUTPOSTS
Storage Class.
You can use the CopyObject
action to change the storage class of an object that is already stored in Amazon S3 by using the x-amz-storage-class
header. For more information, see Storage Classes in the Amazon S3 User Guide.
Before using an object as a source object for the copy operation, you must restore a copy of it if it meets any of the following conditions:
-
The storage class of the source object is
GLACIER
orDEEP_ARCHIVE
. -
The storage class of the source object is
INTELLIGENT_TIERING
and it's S3 Intelligent-Tiering access tier isArchive Access
orDeep Archive Access
.
For more information, see RestoreObject and Copying Objects in the Amazon S3 User Guide.
sourcepub fn website_redirect_location(self, input: impl Into<String>) -> Self
pub fn website_redirect_location(self, input: impl Into<String>) -> Self
If the destination bucket is configured as a website, redirects requests for this object copy to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the x-amz-metadata-directive
header. Instead, you may opt to provide this header in combination with the x-amz-metadata-directive
header.
This functionality is not supported for directory buckets.
sourcepub fn set_website_redirect_location(self, input: Option<String>) -> Self
pub fn set_website_redirect_location(self, input: Option<String>) -> Self
If the destination bucket is configured as a website, redirects requests for this object copy to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the x-amz-metadata-directive
header. Instead, you may opt to provide this header in combination with the x-amz-metadata-directive
header.
This functionality is not supported for directory buckets.
sourcepub fn get_website_redirect_location(&self) -> &Option<String>
pub fn get_website_redirect_location(&self) -> &Option<String>
If the destination bucket is configured as a website, redirects requests for this object copy to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This value is unique to each object and is not copied when using the x-amz-metadata-directive
header. Instead, you may opt to provide this header in combination with the x-amz-metadata-directive
header.
This functionality is not supported for directory buckets.
sourcepub fn sse_customer_algorithm(self, input: impl Into<String>) -> Self
pub fn sse_customer_algorithm(self, input: impl Into<String>) -> Self
Specifies the algorithm to use when encrypting the object (for example, AES256
).
When you perform a CopyObject
operation, if you want to use a different type of encryption setting for the target object, you can specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. 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.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn set_sse_customer_algorithm(self, input: Option<String>) -> Self
pub fn set_sse_customer_algorithm(self, input: Option<String>) -> Self
Specifies the algorithm to use when encrypting the object (for example, AES256
).
When you perform a CopyObject
operation, if you want to use a different type of encryption setting for the target object, you can specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. 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.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn get_sse_customer_algorithm(&self) -> &Option<String>
pub fn get_sse_customer_algorithm(&self) -> &Option<String>
Specifies the algorithm to use when encrypting the object (for example, AES256
).
When you perform a CopyObject
operation, if you want to use a different type of encryption setting for the target object, you can specify appropriate encryption-related headers to encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. 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.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn sse_customer_key(self, input: impl Into<String>) -> Self
pub fn sse_customer_key(self, input: impl Into<String>) -> Self
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.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn set_sse_customer_key(self, input: Option<String>) -> Self
pub fn set_sse_customer_key(self, input: Option<String>) -> Self
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.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn get_sse_customer_key(&self) -> &Option<String>
pub fn get_sse_customer_key(&self) -> &Option<String>
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.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn sse_customer_key_md5(self, input: impl Into<String>) -> Self
pub fn sse_customer_key_md5(self, input: impl Into<String>) -> Self
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.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn set_sse_customer_key_md5(self, input: Option<String>) -> Self
pub fn set_sse_customer_key_md5(self, input: Option<String>) -> Self
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.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn get_sse_customer_key_md5(&self) -> &Option<String>
pub fn get_sse_customer_key_md5(&self) -> &Option<String>
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.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn ssekms_key_id(self, input: impl Into<String>) -> Self
pub fn ssekms_key_id(self, input: impl Into<String>) -> Self
Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn set_ssekms_key_id(self, input: Option<String>) -> Self
pub fn set_ssekms_key_id(self, input: Option<String>) -> Self
Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn get_ssekms_key_id(&self) -> &Option<String>
pub fn get_ssekms_key_id(&self) -> &Option<String>
Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn ssekms_encryption_context(self, input: impl Into<String>) -> Self
pub fn ssekms_encryption_context(self, input: impl Into<String>) -> Self
Specifies the Amazon Web Services 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. This value must be explicitly added to specify encryption context for CopyObject
requests.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn set_ssekms_encryption_context(self, input: Option<String>) -> Self
pub fn set_ssekms_encryption_context(self, input: Option<String>) -> Self
Specifies the Amazon Web Services 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. This value must be explicitly added to specify encryption context for CopyObject
requests.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn get_ssekms_encryption_context(&self) -> &Option<String>
pub fn get_ssekms_encryption_context(&self) -> &Option<String>
Specifies the Amazon Web Services 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. This value must be explicitly added to specify encryption context for CopyObject
requests.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn bucket_key_enabled(self, input: bool) -> Self
pub fn bucket_key_enabled(self, input: bool) -> Self
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object.
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 action doesn’t affect bucket-level settings for S3 Bucket Key.
For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn set_bucket_key_enabled(self, input: Option<bool>) -> Self
pub fn set_bucket_key_enabled(self, input: Option<bool>) -> Self
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object.
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 action doesn’t affect bucket-level settings for S3 Bucket Key.
For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn get_bucket_key_enabled(&self) -> &Option<bool>
pub fn get_bucket_key_enabled(&self) -> &Option<bool>
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Key Management Service (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object.
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 action doesn’t affect bucket-level settings for S3 Bucket Key.
For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
This functionality is not supported when the destination bucket is a directory bucket.
sourcepub fn copy_source_sse_customer_algorithm(
self,
input: impl Into<String>,
) -> Self
pub fn copy_source_sse_customer_algorithm( self, input: impl Into<String>, ) -> Self
Specifies the algorithm to use when decrypting the source object (for example, AES256
).
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.
This functionality is not supported when the source object is in a directory bucket.
sourcepub fn set_copy_source_sse_customer_algorithm(
self,
input: Option<String>,
) -> Self
pub fn set_copy_source_sse_customer_algorithm( self, input: Option<String>, ) -> Self
Specifies the algorithm to use when decrypting the source object (for example, AES256
).
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.
This functionality is not supported when the source object is in a directory bucket.
sourcepub fn get_copy_source_sse_customer_algorithm(&self) -> &Option<String>
pub fn get_copy_source_sse_customer_algorithm(&self) -> &Option<String>
Specifies the algorithm to use when decrypting the source object (for example, AES256
).
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.
This functionality is not supported when the source object is in a directory bucket.
sourcepub fn copy_source_sse_customer_key(self, input: impl Into<String>) -> Self
pub fn copy_source_sse_customer_key(self, input: impl Into<String>) -> Self
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 the same one that was used when the source object was created.
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.
This functionality is not supported when the source object is in a directory bucket.
sourcepub fn set_copy_source_sse_customer_key(self, input: Option<String>) -> Self
pub fn set_copy_source_sse_customer_key(self, input: Option<String>) -> Self
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 the same one that was used when the source object was created.
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.
This functionality is not supported when the source object is in a directory bucket.
sourcepub fn get_copy_source_sse_customer_key(&self) -> &Option<String>
pub fn get_copy_source_sse_customer_key(&self) -> &Option<String>
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 the same one that was used when the source object was created.
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.
This functionality is not supported when the source object is in a directory bucket.
sourcepub fn copy_source_sse_customer_key_md5(self, input: impl Into<String>) -> Self
pub fn copy_source_sse_customer_key_md5(self, input: impl Into<String>) -> Self
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.
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.
This functionality is not supported when the source object is in a directory bucket.
sourcepub fn set_copy_source_sse_customer_key_md5(self, input: Option<String>) -> Self
pub fn set_copy_source_sse_customer_key_md5(self, input: Option<String>) -> Self
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.
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.
This functionality is not supported when the source object is in a directory bucket.
sourcepub fn get_copy_source_sse_customer_key_md5(&self) -> &Option<String>
pub fn get_copy_source_sse_customer_key_md5(&self) -> &Option<String>
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.
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.
This functionality is not supported when the source object is in a directory bucket.
sourcepub fn request_payer(self, input: RequestPayer) -> Self
pub fn request_payer(self, input: RequestPayer) -> Self
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn set_request_payer(self, input: Option<RequestPayer>) -> Self
pub fn set_request_payer(self, input: Option<RequestPayer>) -> Self
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn get_request_payer(&self) -> &Option<RequestPayer>
pub fn get_request_payer(&self) -> &Option<RequestPayer>
Confirms that the requester knows that they will be charged for the request. Bucket owners need not specify this parameter in their requests. If either the source or destination S3 bucket has Requester Pays enabled, the requester will pay for corresponding charges to copy the object. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
This functionality is not supported for directory buckets.
sourcepub fn tagging(self, input: impl Into<String>) -> Self
pub fn tagging(self, input: impl Into<String>) -> Self
The tag-set for the object copy in the destination bucket. This value must be used in conjunction with the x-amz-tagging-directive
if you choose REPLACE
for the x-amz-tagging-directive
. If you choose COPY
for the x-amz-tagging-directive
, you don't need to set the x-amz-tagging
header, because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query parameters.
The default value is the empty value.
Directory buckets - For directory buckets in a CopyObject
operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented
status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented
response in any of the following situations:
-
When you attempt to
COPY
the tag-set from an S3 source object that has non-empty tags. -
When you attempt to
REPLACE
the tag-set of a source object and set a non-empty value tox-amz-tagging
. -
When you don't set the
x-amz-tagging-directive
header and the source object has non-empty tags. This is because the default value ofx-amz-tagging-directive
isCOPY
.
Because only the empty tag-set is supported for directory buckets in a CopyObject
operation, the following situations are allowed:
-
When you attempt to
COPY
the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object. -
When you attempt to
REPLACE
the tag-set of a directory bucket source object and set thex-amz-tagging
value of the directory bucket destination object to empty. -
When you attempt to
REPLACE
the tag-set of a general purpose bucket source object that has non-empty tags and set thex-amz-tagging
value of the directory bucket destination object to empty. -
When you attempt to
REPLACE
the tag-set of a directory bucket source object and don't set thex-amz-tagging
value of the directory bucket destination object. This is because the default value ofx-amz-tagging
is the empty value.
sourcepub fn set_tagging(self, input: Option<String>) -> Self
pub fn set_tagging(self, input: Option<String>) -> Self
The tag-set for the object copy in the destination bucket. This value must be used in conjunction with the x-amz-tagging-directive
if you choose REPLACE
for the x-amz-tagging-directive
. If you choose COPY
for the x-amz-tagging-directive
, you don't need to set the x-amz-tagging
header, because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query parameters.
The default value is the empty value.
Directory buckets - For directory buckets in a CopyObject
operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented
status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented
response in any of the following situations:
-
When you attempt to
COPY
the tag-set from an S3 source object that has non-empty tags. -
When you attempt to
REPLACE
the tag-set of a source object and set a non-empty value tox-amz-tagging
. -
When you don't set the
x-amz-tagging-directive
header and the source object has non-empty tags. This is because the default value ofx-amz-tagging-directive
isCOPY
.
Because only the empty tag-set is supported for directory buckets in a CopyObject
operation, the following situations are allowed:
-
When you attempt to
COPY
the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object. -
When you attempt to
REPLACE
the tag-set of a directory bucket source object and set thex-amz-tagging
value of the directory bucket destination object to empty. -
When you attempt to
REPLACE
the tag-set of a general purpose bucket source object that has non-empty tags and set thex-amz-tagging
value of the directory bucket destination object to empty. -
When you attempt to
REPLACE
the tag-set of a directory bucket source object and don't set thex-amz-tagging
value of the directory bucket destination object. This is because the default value ofx-amz-tagging
is the empty value.
sourcepub fn get_tagging(&self) -> &Option<String>
pub fn get_tagging(&self) -> &Option<String>
The tag-set for the object copy in the destination bucket. This value must be used in conjunction with the x-amz-tagging-directive
if you choose REPLACE
for the x-amz-tagging-directive
. If you choose COPY
for the x-amz-tagging-directive
, you don't need to set the x-amz-tagging
header, because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query parameters.
The default value is the empty value.
Directory buckets - For directory buckets in a CopyObject
operation, only the empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a 501 Not Implemented
status code. When the destination bucket is a directory bucket, you will receive a 501 Not Implemented
response in any of the following situations:
-
When you attempt to
COPY
the tag-set from an S3 source object that has non-empty tags. -
When you attempt to
REPLACE
the tag-set of a source object and set a non-empty value tox-amz-tagging
. -
When you don't set the
x-amz-tagging-directive
header and the source object has non-empty tags. This is because the default value ofx-amz-tagging-directive
isCOPY
.
Because only the empty tag-set is supported for directory buckets in a CopyObject
operation, the following situations are allowed:
-
When you attempt to
COPY
the tag-set from a directory bucket source object that has no tags to a general purpose bucket. It copies an empty tag-set to the destination object. -
When you attempt to
REPLACE
the tag-set of a directory bucket source object and set thex-amz-tagging
value of the directory bucket destination object to empty. -
When you attempt to
REPLACE
the tag-set of a general purpose bucket source object that has non-empty tags and set thex-amz-tagging
value of the directory bucket destination object to empty. -
When you attempt to
REPLACE
the tag-set of a directory bucket source object and don't set thex-amz-tagging
value of the directory bucket destination object. This is because the default value ofx-amz-tagging
is the empty value.
sourcepub fn object_lock_mode(self, input: ObjectLockMode) -> Self
pub fn object_lock_mode(self, input: ObjectLockMode) -> Self
The Object Lock mode that you want to apply to the object copy.
This functionality is not supported for directory buckets.
sourcepub fn set_object_lock_mode(self, input: Option<ObjectLockMode>) -> Self
pub fn set_object_lock_mode(self, input: Option<ObjectLockMode>) -> Self
The Object Lock mode that you want to apply to the object copy.
This functionality is not supported for directory buckets.
sourcepub fn get_object_lock_mode(&self) -> &Option<ObjectLockMode>
pub fn get_object_lock_mode(&self) -> &Option<ObjectLockMode>
The Object Lock mode that you want to apply to the object copy.
This functionality is not supported for directory buckets.
sourcepub fn object_lock_retain_until_date(self, input: DateTime) -> Self
pub fn object_lock_retain_until_date(self, input: DateTime) -> Self
The date and time when you want the Object Lock of the object copy to expire.
This functionality is not supported for directory buckets.
sourcepub fn set_object_lock_retain_until_date(self, input: Option<DateTime>) -> Self
pub fn set_object_lock_retain_until_date(self, input: Option<DateTime>) -> Self
The date and time when you want the Object Lock of the object copy to expire.
This functionality is not supported for directory buckets.
sourcepub fn get_object_lock_retain_until_date(&self) -> &Option<DateTime>
pub fn get_object_lock_retain_until_date(&self) -> &Option<DateTime>
The date and time when you want the Object Lock of the object copy to expire.
This functionality is not supported for directory buckets.
sourcepub fn object_lock_legal_hold_status(
self,
input: ObjectLockLegalHoldStatus,
) -> Self
pub fn object_lock_legal_hold_status( self, input: ObjectLockLegalHoldStatus, ) -> Self
Specifies whether you want to apply a legal hold to the object copy.
This functionality is not supported for directory buckets.
sourcepub fn set_object_lock_legal_hold_status(
self,
input: Option<ObjectLockLegalHoldStatus>,
) -> Self
pub fn set_object_lock_legal_hold_status( self, input: Option<ObjectLockLegalHoldStatus>, ) -> Self
Specifies whether you want to apply a legal hold to the object copy.
This functionality is not supported for directory buckets.
sourcepub fn get_object_lock_legal_hold_status(
&self,
) -> &Option<ObjectLockLegalHoldStatus>
pub fn get_object_lock_legal_hold_status( &self, ) -> &Option<ObjectLockLegalHoldStatus>
Specifies whether you want to apply a legal hold to the object copy.
This functionality is not supported for directory buckets.
sourcepub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
pub fn expected_bucket_owner(self, input: impl Into<String>) -> Self
The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
pub fn set_expected_bucket_owner(self, input: Option<String>) -> Self
The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub fn get_expected_bucket_owner(&self) -> &Option<String>
pub fn get_expected_bucket_owner(&self) -> &Option<String>
The account ID of the expected destination bucket owner. If the account ID that you provide does not match the actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub fn expected_source_bucket_owner(self, input: impl Into<String>) -> Self
pub fn expected_source_bucket_owner(self, input: impl Into<String>) -> Self
The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub fn set_expected_source_bucket_owner(self, input: Option<String>) -> Self
pub fn set_expected_source_bucket_owner(self, input: Option<String>) -> Self
The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
sourcepub fn get_expected_source_bucket_owner(&self) -> &Option<String>
pub fn get_expected_source_bucket_owner(&self) -> &Option<String>
The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden
(access denied).
Trait Implementations§
source§impl Clone for CopyObjectFluentBuilder
impl Clone for CopyObjectFluentBuilder
source§fn clone(&self) -> CopyObjectFluentBuilder
fn clone(&self) -> CopyObjectFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CopyObjectFluentBuilder
impl !RefUnwindSafe for CopyObjectFluentBuilder
impl Send for CopyObjectFluentBuilder
impl Sync for CopyObjectFluentBuilder
impl Unpin for CopyObjectFluentBuilder
impl !UnwindSafe for CopyObjectFluentBuilder
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)