NAME

Paws::S3::CopyObject - Arguments for method CopyObject on Paws::S3

DESCRIPTION

This class represents the parameters used for calling the method CopyObject on the Amazon Simple Storage Service service. Use the attributes of this class as arguments to method CopyObject.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CopyObject.

SYNOPSIS

    my $s3 = Paws->service('S3');
    # To copy an object
    # The following example copies an object from one bucket to another.
    my $CopyObjectOutput = $s3->CopyObject(
      'Bucket'     => 'destinationbucket',
      'CopySource' => '/sourcebucket/HappyFacejpg',
      'Key'        => 'HappyFaceCopyjpg'
    );
    # Results:
    my $CopyObjectResult = $CopyObjectOutput->CopyObjectResult;
    # Returns a L<Paws::S3::CopyObjectOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/s3/CopyObject>

ATTRIBUTES

ACL => Str

The canned ACL to apply to the object.

This action is not supported by Amazon S3 on Outposts.

Valid values are: "private", "public-read", "public-read-write", "authenticated-read", "aws-exec-read", "bucket-owner-read", "bucket-owner-full-control"

REQUIRED Bucket => Str

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 AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html) 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 using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html) in the Amazon S3 User Guide.

BucketKeyEnabled => Bool

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.

CacheControl => Str

Specifies caching behavior along the request/reply chain.

ContentDisposition => Str

Specifies presentational information for the object.

ContentEncoding => Str

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.

ContentLanguage => Str

The language the content is in.

ContentType => Str

A standard MIME type describing the format of the object data.

REQUIRED CopySource => Str

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 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html):

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 bucket "awsexamplebucket", use "awsexamplebucket/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:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>". For example, to copy the object "reports/january.pdf" through access point "my-access-point" owned by account 123456789012 in Region "us-west-2", use the URL encoding of "arn: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 AWS 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:<Region>:<account-id>:outpost/<outpost-id>/object/<key>". For example, to copy the object "reports/january.pdf" through outpost "my-outpost" owned by account 123456789012 in Region "us-west-2", use the URL encoding of "arn: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=<version-id>" 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.

CopySourceIfMatch => Str

Copies the object if its entity tag (ETag) matches the specified tag.

CopySourceIfModifiedSince => Str

Copies the object if it has been modified since the specified time.

CopySourceIfNoneMatch => Str

Copies the object if its entity tag (ETag) is different than the specified ETag.

CopySourceIfUnmodifiedSince => Str

Copies the object if it hasn't been modified since the specified time.

CopySourceSSECustomerAlgorithm => Str

Specifies the algorithm to use when decrypting the source object (for example, AES256).

CopySourceSSECustomerKey => Str

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.

CopySourceSSECustomerKeyMD5 => Str

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.

ExpectedBucketOwner => Str

The account ID of the expected destination bucket owner. If the destination bucket is owned by a different account, the request will fail with an HTTP "403 (Access Denied)" error.

ExpectedSourceBucketOwner => Str

The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the request will fail with an HTTP "403 (Access Denied)" error.

Expires => Str

The date and time at which the object is no longer cacheable.

GrantFullControl => Str

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

This action is not supported by Amazon S3 on Outposts.

GrantRead => Str

Allows grantee to read the object data and its metadata.

This action is not supported by Amazon S3 on Outposts.

GrantReadACP => Str

Allows grantee to read the object ACL.

This action is not supported by Amazon S3 on Outposts.

GrantWriteACP => Str

Allows grantee to write the ACL for the applicable object.

This action is not supported by Amazon S3 on Outposts.

REQUIRED Key => Str

The key of the destination object.

Metadata => Paws::S3::Metadata

A map of metadata to store with the object in S3.

MetadataDirective => Str

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Valid values are: "COPY", "REPLACE"

ObjectLockLegalHoldStatus => Str

Specifies whether you want to apply a Legal Hold to the copied object.

Valid values are: "ON", "OFF"

ObjectLockMode => Str

The Object Lock mode that you want to apply to the copied object.

Valid values are: "GOVERNANCE", "COMPLIANCE"

ObjectLockRetainUntilDate => Str

The date and time when you want the copied object's Object Lock to expire.

RequestPayer => Str

Valid values are: "requester"

ServerSideEncryption => Str

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Valid values are: "AES256", "aws:kms"

SSECustomerAlgorithm => Str

Specifies the algorithm to use to when encrypting the object (for example, AES256).

SSECustomerKey => Str

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.

SSECustomerKeyMD5 => Str

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.

SSEKMSEncryptionContext => Str

Specifies the AWS 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.

SSEKMSKeyId => Str

Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version) in the Amazon S3 User Guide.

StorageClass => Str

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 (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in the Amazon S3 User Guide.

Valid values are: "STANDARD", "REDUCED_REDUNDANCY", "STANDARD_IA", "ONEZONE_IA", "INTELLIGENT_TIERING", "GLACIER", "DEEP_ARCHIVE", "OUTPOSTS"

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>