/AWS1/CL_S3CS3COPYOBJECTOP

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.

CONSTRUCTOR

IMPORTING

Optional arguments:

iv_targetresource TYPE /AWS1/S3CS3REGIONALORS3EXPRE00 /AWS1/S3CS3REGIONALORS3EXPRE00

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. A directory bucket as a destination bucket can be in Availability Zone or Local Zone.

  Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, you get an HTTP 400 Bad Request error with the error code InvalidRequest.

iv_cannedaccesscontrollist TYPE /AWS1/S3CS3CANNEDACCESSCTLLIST /AWS1/S3CS3CANNEDACCESSCTLLIST

This functionality is not supported by directory buckets.

it_accesscontrolgrants TYPE /AWS1/CL_S3CS3GRANT=>TT_S3GRANTLIST TT_S3GRANTLIST

This functionality is not supported by directory buckets.

iv_metadatadirective TYPE /AWS1/S3CS3METADATADIRECTIVE /AWS1/S3CS3METADATADIRECTIVE

iv_modifiedsinceconstraint TYPE /AWS1/S3CTIMESTAMP /AWS1/S3CTIMESTAMP

io_newobjectmetadata TYPE REF TO /AWS1/CL_S3CS3OBJECTMETADATA /AWS1/CL_S3CS3OBJECTMETADATA

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.

it_newobjecttagging TYPE /AWS1/CL_S3CS3TAG=>TT_S3TAGSET TT_S3TAGSET

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.

iv_redirectlocation TYPE /AWS1/S3CNONEMPTYMAXLENGTH2000 /AWS1/S3CNONEMPTYMAXLENGTH2000

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.

iv_requesterpays TYPE /AWS1/S3CBOOLEAN /AWS1/S3CBOOLEAN

This functionality is not supported by directory buckets.

iv_storageclass TYPE /AWS1/S3CS3STORAGECLASS /AWS1/S3CS3STORAGECLASS

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

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

iv_unmodifiedsinceconstraint TYPE /AWS1/S3CTIMESTAMP /AWS1/S3CTIMESTAMP

iv_sseawskmskeyid TYPE /AWS1/S3CKMSKEYARNSTRING /AWS1/S3CKMSKEYARNSTRING

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.

Directory buckets - If you specify SSEAlgorithm with KMS, you must specify the SSEAwsKmsKeyId parameter with the ID (Key ID or Key ARN) of the KMS symmetric encryption customer managed key to use. Otherwise, you get an HTTP 400 Bad Request error. The key alias format of the KMS key isn't supported. To encrypt new object copies in a directory bucket with SSE-KMS, you must specify SSE-KMS as the directory bucket's default encryption configuration with a KMS key (specifically, a customer managed key). The Amazon Web Services managed key (aws/s3) isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. After you specify a customer managed key for SSE-KMS as the bucket default encryption, you can't override the customer managed key for the bucket's SSE-KMS configuration. Then, when you specify server-side encryption settings for new object copies with SSE-KMS, you must make sure the encryption key is the same customer managed key that you specified for the directory bucket's default encryption configuration.

iv_targetkeyprefix TYPE /AWS1/S3CNONEMPTYMAXLENGTH1000 /AWS1/S3CNONEMPTYMAXLENGTH1000

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.

iv_objectlocklegalholdstatus TYPE /AWS1/S3CS3OBJLKLEGALHOLDSTAT /AWS1/S3CS3OBJLKLEGALHOLDSTAT

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

This functionality is not supported by directory buckets.

iv_objectlockmode TYPE /AWS1/S3CS3OBJECTLOCKMODE /AWS1/S3CS3OBJECTLOCKMODE

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

This functionality is not supported by directory buckets.

iv_objectlockretainuntildate TYPE /AWS1/S3CTIMESTAMP /AWS1/S3CTIMESTAMP

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.

iv_bucketkeyenabled TYPE /AWS1/S3CBOOLEAN /AWS1/S3CBOOLEAN

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 Copy action doesn’t affect bucket-level settings for S3 Bucket Key.

Directory buckets - S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets
to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through the Copy operation in Batch Operations. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

iv_checksumalgorithm TYPE /AWS1/S3CS3CHECKSUMALGORITHM /AWS1/S3CS3CHECKSUMALGORITHM

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.

---

Queryable Attributes

TargetResource

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. A directory bucket as a destination bucket can be in Availability Zone or Local Zone.

  Copying objects across different Amazon Web Services Regions isn't supported when the source or destination bucket is in Amazon Web Services Local Zones. The source and destination buckets must have the same parent Amazon Web Services Region. Otherwise, you get an HTTP 400 Bad Request error with the error code InvalidRequest.

Accessible with the following methods

Method	Description
GET_TARGETRESOURCE()	Getter for TARGETRESOURCE, with configurable default
ASK_TARGETRESOURCE()	Getter for TARGETRESOURCE w/ exceptions if field has no valu
HAS_TARGETRESOURCE()	Determine if TARGETRESOURCE has a value

CannedAccessControlList

This functionality is not supported by directory buckets.

Accessible with the following methods

Method	Description
GET_CANNEDACCESSCONTROLLIST()	Getter for CANNEDACCESSCONTROLLIST, with configurable defaul
ASK_CANNEDACCESSCONTROLLIST()	Getter for CANNEDACCESSCONTROLLIST w/ exceptions if field ha
HAS_CANNEDACCESSCONTROLLIST()	Determine if CANNEDACCESSCONTROLLIST has a value

AccessControlGrants

This functionality is not supported by directory buckets.

Accessible with the following methods

Method	Description
GET_ACCESSCONTROLGRANTS()	Getter for ACCESSCONTROLGRANTS, with configurable default
ASK_ACCESSCONTROLGRANTS()	Getter for ACCESSCONTROLGRANTS w/ exceptions if field has no
HAS_ACCESSCONTROLGRANTS()	Determine if ACCESSCONTROLGRANTS has a value

MetadataDirective

Accessible with the following methods

Method	Description
GET_METADATADIRECTIVE()	Getter for METADATADIRECTIVE, with configurable default
ASK_METADATADIRECTIVE()	Getter for METADATADIRECTIVE w/ exceptions if field has no v
HAS_METADATADIRECTIVE()	Determine if METADATADIRECTIVE has a value

ModifiedSinceConstraint

Accessible with the following methods

Method	Description
GET_MODIFIEDSINCECONSTRAINT()	Getter for MODIFIEDSINCECONSTRAINT, with configurable defaul
ASK_MODIFIEDSINCECONSTRAINT()	Getter for MODIFIEDSINCECONSTRAINT w/ exceptions if field ha
HAS_MODIFIEDSINCECONSTRAINT()	Determine if MODIFIEDSINCECONSTRAINT has a value

NewObjectMetadata

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.

Accessible with the following methods

Method	Description
GET_NEWOBJECTMETADATA()	Getter for NEWOBJECTMETADATA

NewObjectTagging

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.

Accessible with the following methods

Method	Description
GET_NEWOBJECTTAGGING()	Getter for NEWOBJECTTAGGING, with configurable default
ASK_NEWOBJECTTAGGING()	Getter for NEWOBJECTTAGGING w/ exceptions if field has no va
HAS_NEWOBJECTTAGGING()	Determine if NEWOBJECTTAGGING has a value

RedirectLocation

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.

Accessible with the following methods

Method	Description
GET_REDIRECTLOCATION()	Getter for REDIRECTLOCATION, with configurable default
ASK_REDIRECTLOCATION()	Getter for REDIRECTLOCATION w/ exceptions if field has no va
HAS_REDIRECTLOCATION()	Determine if REDIRECTLOCATION has a value

RequesterPays

This functionality is not supported by directory buckets.

Accessible with the following methods

Method	Description
GET_REQUESTERPAYS()	Getter for REQUESTERPAYS

StorageClass

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

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

Accessible with the following methods

Method	Description
GET_STORAGECLASS()	Getter for STORAGECLASS, with configurable default
ASK_STORAGECLASS()	Getter for STORAGECLASS w/ exceptions if field has no value
HAS_STORAGECLASS()	Determine if STORAGECLASS has a value

UnModifiedSinceConstraint

Accessible with the following methods

Method	Description
GET_UNMODDEDSINCECONSTRAINT()	Getter for UNMODIFIEDSINCECONSTRAINT, with configurable defa
ASK_UNMODDEDSINCECONSTRAINT()	Getter for UNMODIFIEDSINCECONSTRAINT w/ exceptions if field
HAS_UNMODDEDSINCECONSTRAINT()	Determine if UNMODIFIEDSINCECONSTRAINT has a value

SSEAwsKmsKeyId

Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.

Directory buckets - If you specify SSEAlgorithm with KMS, you must specify the SSEAwsKmsKeyId parameter with the ID (Key ID or Key ARN) of the KMS symmetric encryption customer managed key to use. Otherwise, you get an HTTP 400 Bad Request error. The key alias format of the KMS key isn't supported. To encrypt new object copies in a directory bucket with SSE-KMS, you must specify SSE-KMS as the directory bucket's default encryption configuration with a KMS key (specifically, a customer managed key). The Amazon Web Services managed key (aws/s3) isn't supported. Your SSE-KMS configuration can only support 1 customer managed key per directory bucket for the lifetime of the bucket. After you specify a customer managed key for SSE-KMS as the bucket default encryption, you can't override the customer managed key for the bucket's SSE-KMS configuration. Then, when you specify server-side encryption settings for new object copies with SSE-KMS, you must make sure the encryption key is the same customer managed key that you specified for the directory bucket's default encryption configuration.

Accessible with the following methods

Method	Description
GET_SSEAWSKMSKEYID()	Getter for SSEAWSKMSKEYID, with configurable default
ASK_SSEAWSKMSKEYID()	Getter for SSEAWSKMSKEYID w/ exceptions if field has no valu
HAS_SSEAWSKMSKEYID()	Determine if SSEAWSKMSKEYID has a value

TargetKeyPrefix

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.

Accessible with the following methods

Method	Description
GET_TARGETKEYPREFIX()	Getter for TARGETKEYPREFIX, with configurable default
ASK_TARGETKEYPREFIX()	Getter for TARGETKEYPREFIX w/ exceptions if field has no val
HAS_TARGETKEYPREFIX()	Determine if TARGETKEYPREFIX has a value

ObjectLockLegalHoldStatus

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

This functionality is not supported by directory buckets.

Accessible with the following methods

Method	Description
GET_OBJLOCKLEGALHOLDSTATUS()	Getter for OBJECTLOCKLEGALHOLDSTATUS, with configurable defa
ASK_OBJLOCKLEGALHOLDSTATUS()	Getter for OBJECTLOCKLEGALHOLDSTATUS w/ exceptions if field
HAS_OBJLOCKLEGALHOLDSTATUS()	Determine if OBJECTLOCKLEGALHOLDSTATUS has a value

ObjectLockMode

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

This functionality is not supported by directory buckets.

Accessible with the following methods

Method	Description
GET_OBJECTLOCKMODE()	Getter for OBJECTLOCKMODE, with configurable default
ASK_OBJECTLOCKMODE()	Getter for OBJECTLOCKMODE w/ exceptions if field has no valu
HAS_OBJECTLOCKMODE()	Determine if OBJECTLOCKMODE has a value

ObjectLockRetainUntilDate

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.

Accessible with the following methods

Method	Description
GET_OBJLOCKRETAINUNTILDATE()	Getter for OBJECTLOCKRETAINUNTILDATE, with configurable defa
ASK_OBJLOCKRETAINUNTILDATE()	Getter for OBJECTLOCKRETAINUNTILDATE w/ exceptions if field
HAS_OBJLOCKRETAINUNTILDATE()	Determine if OBJECTLOCKRETAINUNTILDATE has a value

BucketKeyEnabled

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 Copy action doesn’t affect bucket-level settings for S3 Bucket Key.

Directory buckets - S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted objects from general purpose buckets
to directory buckets, from directory buckets to general purpose buckets, or between directory buckets, through the Copy operation in Batch Operations. In this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.

Accessible with the following methods

Method	Description
GET_BUCKETKEYENABLED()	Getter for BUCKETKEYENABLED

ChecksumAlgorithm

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.

Accessible with the following methods

Method	Description
GET_CHECKSUMALGORITHM()	Getter for CHECKSUMALGORITHM, with configurable default
ASK_CHECKSUMALGORITHM()	Getter for CHECKSUMALGORITHM w/ exceptions if field has no v
HAS_CHECKSUMALGORITHM()	Determine if CHECKSUMALGORITHM has a value