Struct aws_sdk_s3control::types::S3CopyObjectOperation

#[non_exhaustive]
pub struct S3CopyObjectOperation {

    pub target_resource: Option<String>,
    pub canned_access_control_list: Option<S3CannedAccessControlList>,
    pub access_control_grants: Option<Vec<S3Grant>>,
    pub metadata_directive: Option<S3MetadataDirective>,
    pub modified_since_constraint: Option<DateTime>,
    pub new_object_metadata: Option<S3ObjectMetadata>,
    pub new_object_tagging: Option<Vec<S3Tag>>,
    pub redirect_location: Option<String>,
    pub requester_pays: bool,
    pub storage_class: Option<S3StorageClass>,
    pub un_modified_since_constraint: Option<DateTime>,
    pub sse_aws_kms_key_id: Option<String>,
    pub target_key_prefix: Option<String>,
    pub object_lock_legal_hold_status: Option<S3ObjectLockLegalHoldStatus>,
    pub object_lock_mode: Option<S3ObjectLockMode>,
    pub object_lock_retain_until_date: Option<DateTime>,
    pub bucket_key_enabled: bool,
    pub checksum_algorithm: Option<S3ChecksumAlgorithm>,
}

Contains the configuration parameters for a PUT Copy object operation. S3 Batch Operations passes every object to the underlying CopyObject API operation. For more information about the parameters for this operation, see CopyObject.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

target_resource: Option<String>

Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.

• General purpose buckets - For example, to copy objects to a general purpose bucket named destinationBucket, set the TargetResource property to arn:aws:s3:::destinationBucket.

• Directory buckets - For example, to copy objects to a directory bucket named destinationBucket in the Availability Zone; identified by the AZ ID usw2-az1, set the TargetResource property to arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3.

canned_access_control_list: Option<S3CannedAccessControlList>

This functionality is not supported by directory buckets.

access_control_grants: Option<Vec<S3Grant>>

This functionality is not supported by directory buckets.

metadata_directive: Option<S3MetadataDirective>

modified_since_constraint: Option<DateTime>

new_object_metadata: Option<S3ObjectMetadata>

If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.

new_object_tagging: Option<Vec<S3Tag>>

Specifies a list of tags to add to the destination objects after they are copied. If NewObjectTagging is not specified, the tags of the source objects are copied to destination objects by default.

Directory buckets - Tags aren't supported by directory buckets. If your source objects have tags and your destination bucket is a directory bucket, specify an empty tag set in the NewObjectTagging field to prevent copying the source object tags to the directory bucket.

redirect_location: Option<String>

If the destination bucket is configured as a website, specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object copy is accessed through a website endpoint.

This functionality is not supported by directory buckets.

requester_pays: bool

This functionality is not supported by directory buckets.

storage_class: Option<S3StorageClass>

Specify the storage class for the destination objects in a Copy operation.

Directory buckets - This functionality is not supported by directory buckets.

un_modified_since_constraint: Option<DateTime>

sse_aws_kms_key_id: Option<String>

This functionality is not supported by directory buckets.

target_key_prefix: Option<String>

Specifies the folder prefix that you want the objects to be copied into. For example, to copy objects into a folder named Folder1 in the destination bucket, set the TargetKeyPrefix property to Folder1.

object_lock_legal_hold_status: Option<S3ObjectLockLegalHoldStatus>

The legal hold status to be applied to all objects in the Batch Operations job.

This functionality is not supported by directory buckets.

object_lock_mode: Option<S3ObjectLockMode>

The retention mode to be applied to all objects in the Batch Operations job.

This functionality is not supported by directory buckets.

object_lock_retain_until_date: Option<DateTime>

The date when the applied object retention configuration expires on all objects in the Batch Operations job.

This functionality is not supported by directory buckets.

bucket_key_enabled: bool

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services 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 an object action doesn’t affect bucket-level settings for S3 Bucket Key.

This functionality is not supported by directory buckets.

checksum_algorithm: Option<S3ChecksumAlgorithm>

Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.

Implementations

impl S3CopyObjectOperation

pub fn target_resource(&self) -> Option<&str>

Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.

• General purpose buckets - For example, to copy objects to a general purpose bucket named destinationBucket, set the TargetResource property to arn:aws:s3:::destinationBucket.

• Directory buckets - For example, to copy objects to a directory bucket named destinationBucket in the Availability Zone; identified by the AZ ID usw2-az1, set the TargetResource property to arn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3.

pub fn canned_access_control_list(&self) -> Option<&S3CannedAccessControlList>

This functionality is not supported by directory buckets.

pub fn access_control_grants(&self) -> &[S3Grant]

This functionality is not supported by directory buckets.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .access_control_grants.is_none().

pub fn metadata_directive(&self) -> Option<&S3MetadataDirective>

pub fn modified_since_constraint(&self) -> Option<&DateTime>

pub fn new_object_metadata(&self) -> Option<&S3ObjectMetadata>

If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.

pub fn new_object_tagging(&self) -> &[S3Tag]

Specifies a list of tags to add to the destination objects after they are copied. If NewObjectTagging is not specified, the tags of the source objects are copied to destination objects by default.

Directory buckets - Tags aren't supported by directory buckets. If your source objects have tags and your destination bucket is a directory bucket, specify an empty tag set in the NewObjectTagging field to prevent copying the source object tags to the directory bucket.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .new_object_tagging.is_none().

pub fn redirect_location(&self) -> Option<&str>

If the destination bucket is configured as a website, specifies an optional metadata property for website redirects, x-amz-website-redirect-location. Allows webpage redirects if the object copy is accessed through a website endpoint.

This functionality is not supported by directory buckets.

pub fn requester_pays(&self) -> bool

This functionality is not supported by directory buckets.

pub fn storage_class(&self) -> Option<&S3StorageClass>

Specify the storage class for the destination objects in a Copy operation.

Directory buckets - This functionality is not supported by directory buckets.

pub fn un_modified_since_constraint(&self) -> Option<&DateTime>

pub fn sse_aws_kms_key_id(&self) -> Option<&str>

This functionality is not supported by directory buckets.

pub fn target_key_prefix(&self) -> Option<&str>

Specifies the folder prefix that you want the objects to be copied into. For example, to copy objects into a folder named Folder1 in the destination bucket, set the TargetKeyPrefix property to Folder1.

pub fn object_lock_legal_hold_status( &self ) -> Option<&S3ObjectLockLegalHoldStatus>

The legal hold status to be applied to all objects in the Batch Operations job.

This functionality is not supported by directory buckets.

pub fn object_lock_mode(&self) -> Option<&S3ObjectLockMode>

The retention mode to be applied to all objects in the Batch Operations job.

This functionality is not supported by directory buckets.

pub fn object_lock_retain_until_date(&self) -> Option<&DateTime>

The date when the applied object retention configuration expires on all objects in the Batch Operations job.

This functionality is not supported by directory buckets.

pub fn bucket_key_enabled(&self) -> bool

Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services 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 an object action doesn’t affect bucket-level settings for S3 Bucket Key.

This functionality is not supported by directory buckets.

pub fn checksum_algorithm(&self) -> Option<&S3ChecksumAlgorithm>

Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.

impl S3CopyObjectOperation

pub fn builder() -> S3CopyObjectOperationBuilder

Creates a new builder-style object to manufacture S3CopyObjectOperation.

Trait Implementations

impl Clone for S3CopyObjectOperation

fn clone(&self) -> S3CopyObjectOperation

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for S3CopyObjectOperation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for S3CopyObjectOperation

fn eq(&self, other: &S3CopyObjectOperation) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for S3CopyObjectOperation