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');
my $CopyObjectOutput = $s3->CopyObject(
  Bucket                         => 'MyBucketName',
  CopySource                     => 'MyCopySource',
  Key                            => 'MyObjectKey',
  ACL                            => 'private',                    # OPTIONAL
  CacheControl                   => 'MyCacheControl',             # OPTIONAL
  ContentDisposition             => 'MyContentDisposition',       # OPTIONAL
  ContentEncoding                => 'MyContentEncoding',          # OPTIONAL
  ContentLanguage                => 'MyContentLanguage',          # OPTIONAL
  ContentType                    => 'MyContentType',              # OPTIONAL
  CopySourceIfMatch              => 'MyCopySourceIfMatch',        # OPTIONAL
  CopySourceIfModifiedSince      => '1970-01-01T01:00:00',        # OPTIONAL
  CopySourceIfNoneMatch          => 'MyCopySourceIfNoneMatch',    # OPTIONAL
  CopySourceIfUnmodifiedSince    => '1970-01-01T01:00:00',        # OPTIONAL
  CopySourceSSECustomerAlgorithm =>
    'MyCopySourceSSECustomerAlgorithm',                           # OPTIONAL
  CopySourceSSECustomerKey    => 'MyCopySourceSSECustomerKey',    # OPTIONAL
  CopySourceSSECustomerKeyMD5 => 'MyCopySourceSSECustomerKeyMD5', # OPTIONAL
  Expires                     => '1970-01-01T01:00:00',           # OPTIONAL
  GrantFullControl            => 'MyGrantFullControl',            # OPTIONAL
  GrantRead                   => 'MyGrantRead',                   # OPTIONAL
  GrantReadACP                => 'MyGrantReadACP',                # OPTIONAL
  GrantWriteACP               => 'MyGrantWriteACP',               # OPTIONAL
  Metadata          => { 'MyMetadataKey' => 'MyMetadataValue', }, # OPTIONAL
  MetadataDirective => 'COPY',                                    # OPTIONAL
  ObjectLockLegalHoldStatus => 'ON',                              # OPTIONAL
  ObjectLockMode            => 'GOVERNANCE',                      # OPTIONAL
  ObjectLockRetainUntilDate => '1970-01-01T01:00:00',             # OPTIONAL
  RequestPayer              => 'requester',                       # OPTIONAL
  SSECustomerAlgorithm      => 'MySSECustomerAlgorithm',          # OPTIONAL
  SSECustomerKey            => 'MySSECustomerKey',                # OPTIONAL
  SSECustomerKeyMD5         => 'MySSECustomerKeyMD5',             # OPTIONAL
  SSEKMSEncryptionContext   => 'MySSEKMSEncryptionContext',       # OPTIONAL
  SSEKMSKeyId               => 'MySSEKMSKeyId',                   # OPTIONAL
  ServerSideEncryption      => 'AES256',                          # OPTIONAL
  StorageClass              => 'STANDARD',                        # OPTIONAL
  Tagging                   => 'MyTaggingHeader',                 # OPTIONAL
  TaggingDirective          => 'COPY',                            # OPTIONAL
  WebsiteRedirectLocation   => 'MyWebsiteRedirectLocation',       # OPTIONAL
);

# Results:
my $CopyObjectResult        = $CopyObjectOutput->CopyObjectResult;
my $CopySourceVersionId     = $CopyObjectOutput->CopySourceVersionId;
my $Expiration              = $CopyObjectOutput->Expiration;
my $RequestCharged          = $CopyObjectOutput->RequestCharged;
my $SSECustomerAlgorithm    = $CopyObjectOutput->SSECustomerAlgorithm;
my $SSECustomerKeyMD5       = $CopyObjectOutput->SSECustomerKeyMD5;
my $SSEKMSEncryptionContext = $CopyObjectOutput->SSEKMSEncryptionContext;
my $SSEKMSKeyId             = $CopyObjectOutput->SSEKMSKeyId;
my $ServerSideEncryption    = $CopyObjectOutput->ServerSideEncryption;
my $VersionId               = $CopyObjectOutput->VersionId;

# 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.

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.

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

The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

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.

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.

GrantRead => Str

Allows grantee to read the object data and its metadata.

GrantReadACP => Str

Allows grantee to read the object ACL.

GrantWriteACP => Str

Allows grantee to write the ACL for the applicable object.

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 Developer Guide.

StorageClass => Str

The type of storage to use for the object. Defaults to 'STANDARD'.

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

Tagging => Str

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.

TaggingDirective => Str

Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.