Struct aws_sdk_s3::client::fluent_builders::CopyObject
source · [−]pub struct CopyObject { /* 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.
All copy requests must be authenticated. Additionally, you must have read access to the source object and write access to the destination bucket. For more information, see REST Authentication. Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account.
A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the 200 OK
response. This means that a 200 OK
response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately.
If the copy is successful, you receive a response with information about the copied object.
If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body.
The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing.
Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 Bad Request
error. For more information, see Transfer Acceleration.
Metadata
When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs.
To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the x-amz-metadata-directive
header. When you grant permissions, you can use the s3:x-amz-metadata-directive
condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy in the Amazon S3 User Guide. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3.
x-amz-copy-source-if Headers
To only copy an object under certain conditions, such as whether the Etag
matches or whether the object was modified before or after a specified date, use the following request parameters:
-
x-amz-copy-source-if-match
-
x-amz-copy-source-if-none-match
-
x-amz-copy-source-if-unmodified-since
-
x-amz-copy-source-if-modified-since
If both the x-amz-copy-source-if-match
and x-amz-copy-source-if-unmodified-since
headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK
and copies the data:
-
x-amz-copy-source-if-match
condition evaluates to true -
x-amz-copy-source-if-unmodified-since
condition evaluates to false
If both the x-amz-copy-source-if-none-match
and x-amz-copy-source-if-modified-since
headers are present in the request and evaluate as follows, Amazon S3 returns the 412 Precondition Failed
response code:
-
x-amz-copy-source-if-none-match
condition evaluates to false -
x-amz-copy-source-if-modified-since
condition evaluates to true
All headers with the x-amz-
prefix, including x-amz-copy-source
, must be signed.
Server-side encryption
When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with Amazon Web Services managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side Encryption.
If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys in the Amazon S3 User Guide.
Access Control List (ACL)-Specific Request Headers
When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual Amazon Web Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview and Managing ACLs Using the REST API.
If the bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept PUT requests that don't specify an ACL or PUT requests that specify bucket owner full control ACLs, such as the bucket-owner-full-control
canned ACL or an equivalent form of this ACL expressed in the XML format.
For more information, see Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
If your bucket uses the bucket owner enforced setting for Object Ownership, all objects written to the bucket by any account will be owned by the bucket owner.
Checksums
When copying an object, if it has a checksum, that checksum will be copied to the new object by default. When you copy the object over, you may optionally specify a different checksum algorithm to use with the x-amz-checksum-algorithm
header.
Storage Class Options
You can use the CopyObject
action to change the storage class of an object that is already stored in Amazon S3 using the StorageClass
parameter. For more information, see Storage Classes in the Amazon S3 User Guide.
Versioning
By default, x-amz-copy-source
identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the versionId
subresource.
If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the x-amz-version-id
response header in the response.
If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null.
If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject.
The following operations are related to CopyObject
:
For more information, see Copying Objects.
Implementations
sourceimpl CopyObject
impl CopyObject
sourcepub async fn send(self) -> Result<CopyObjectOutput, SdkError<CopyObjectError>>
pub async fn send(self) -> Result<CopyObjectOutput, SdkError<CopyObjectError>>
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 acl(self, input: ObjectCannedAcl) -> Self
pub fn acl(self, input: ObjectCannedAcl) -> Self
The canned ACL to apply to the object.
This action is not supported by Amazon S3 on Outposts.
sourcepub fn set_acl(self, input: Option<ObjectCannedAcl>) -> Self
pub fn set_acl(self, input: Option<ObjectCannedAcl>) -> Self
The canned ACL to apply to the object.
This action is not supported by 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.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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.
When using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon 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.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this 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.
When using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon 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 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 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 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.
sourcepub fn set_checksum_algorithm(self, input: Option<ChecksumAlgorithm>) -> Self
pub fn set_checksum_algorithm(self, input: Option<ChecksumAlgorithm>) -> Self
Indicates the algorithm 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.
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.
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.
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.
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.
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 content_type(self, input: impl Into<String>) -> Self
pub fn content_type(self, input: impl Into<String>) -> Self
A standard MIME type describing 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 describing 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. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:
-
For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object
reports/january.pdf
from the bucketawsexamplebucket
, useawsexamplebucket/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.
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.
To copy a specific version of an object, 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.
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. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:
-
For objects not accessed through an access point, specify the name of the source bucket and the key of the source object, separated by a slash (/). For example, to copy the object
reports/january.pdf
from the bucketawsexamplebucket
, useawsexamplebucket/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.
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.
To copy a specific version of an object, 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.
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.
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.
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.
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.
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.
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.
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.
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.
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 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 action is not supported by 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 action is not supported by 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 action is not supported by 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 action is not supported by 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 action is not supported by 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 action is not supported by 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 action is not supported by 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 action is not supported by 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 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 provided in the request.
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 provided in the request.
sourcepub fn tagging_directive(self, input: TaggingDirective) -> Self
pub fn tagging_directive(self, input: TaggingDirective) -> Self
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
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 are copied from the source object or replaced with tag-set provided in the request.
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).
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).
sourcepub fn storage_class(self, input: StorageClass) -> Self
pub fn storage_class(self, input: StorageClass) -> Self
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.
sourcepub fn set_storage_class(self, input: Option<StorageClass>) -> Self
pub fn set_storage_class(self, input: Option<StorageClass>) -> Self
By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 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 bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
sourcepub fn set_website_redirect_location(self, input: Option<String>) -> Self
pub fn set_website_redirect_location(self, input: Option<String>) -> Self
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
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 to when encrypting the object (for example, AES256).
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 to when encrypting the object (for example, AES256).
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.
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.
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.
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.
sourcepub fn ssekms_key_id(self, input: impl Into<String>) -> Self
pub fn ssekms_key_id(self, input: impl Into<String>) -> Self
Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using 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.
sourcepub fn set_ssekms_key_id(self, input: Option<String>) -> Self
pub fn set_ssekms_key_id(self, input: Option<String>) -> Self
Specifies the Amazon Web Services KMS key ID to use for object encryption. All GET and PUT requests for an object protected by Amazon Web Services KMS will fail if not made via SSL or using SigV4. For information about configuring using 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.
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.
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.
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 AWS KMS (SSE-KMS). Setting this header to true
causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.
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 AWS KMS (SSE-KMS). Setting this header to true
causes Amazon S3 to use an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.
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).
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).
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 one that was used when the source object was created.
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 one that was used when the source object was created.
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.
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.
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. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
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. For information about downloading objects from Requester Pays buckets, see Downloading Objects in Requester Pays Buckets in the Amazon S3 User Guide.
sourcepub fn tagging(self, input: impl Into<String>) -> Self
pub fn tagging(self, input: impl Into<String>) -> Self
The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective
. The tag-set must be encoded as URL Query parameters.
sourcepub fn set_tagging(self, input: Option<String>) -> Self
pub fn set_tagging(self, input: Option<String>) -> Self
The tag-set for the object destination object this value must be used in conjunction with the TaggingDirective
. The tag-set must be encoded as URL Query parameters.
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 copied object.
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 copied object.
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 copied object's Object Lock to expire.
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 copied object's Object Lock to expire.
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 copied object.
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 copied object.
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 destination bucket is owned by a different account, 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 destination bucket is owned by a different account, 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 source bucket is owned by a different account, 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 source bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden
(access denied).
Trait Implementations
sourceimpl Clone for CopyObject
impl Clone for CopyObject
sourcefn clone(&self) -> CopyObject
fn clone(&self) -> CopyObject
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for CopyObject
impl Send for CopyObject
impl Sync for CopyObject
impl Unpin for CopyObject
impl !UnwindSafe for CopyObject
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more