blib/lib/Paws/S3/CopyObject.pm

filter: Statementstmt 100% 52 / 52 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 54 / 54 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/S3/ContinuationEvent.pm ↑ Summary blib/lib/Paws/S3/CopyObjectOutput.pm »
1  
2 package Paws::S3::CopyObject;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has ACL => (is => 'ro', isa => 'Str', header_name => 'x-amz-acl', traits => ['ParamInHeader']);
5 1 has Bucket => (is => 'ro', isa => 'Str', uri_name => 'Bucket', traits => ['ParamInURI'], required => 1);
6 1 has BucketKeyEnabled => (is => 'ro', isa => 'Bool', header_name => 'x-amz-server-side-encryption-bucket-key-enabled', traits => ['ParamInHeader']);
7 1 has CacheControl => (is => 'ro', isa => 'Str', header_name => 'Cache-Control', traits => ['ParamInHeader']);
8 1 has ContentDisposition => (is => 'ro', isa => 'Str', header_name => 'Content-Disposition', traits => ['ParamInHeader']);
9 1 has ContentEncoding => (is => 'ro', isa => 'Str', header_name => 'Content-Encoding', traits => ['ParamInHeader']);
10 1 has ContentLanguage => (is => 'ro', isa => 'Str', header_name => 'Content-Language', traits => ['ParamInHeader']);
11 1 has ContentType => (is => 'ro', isa => 'Str', header_name => 'Content-Type', traits => ['ParamInHeader']);
12 1 has CopySource => (is => 'ro', isa => 'Str', header_name => 'x-amz-copy-source', traits => ['ParamInHeader'], required => 1);
13 1 has CopySourceIfMatch => (is => 'ro', isa => 'Str', header_name => 'x-amz-copy-source-if-match', traits => ['ParamInHeader']);
14 1 has CopySourceIfModifiedSince => (is => 'ro', isa => 'Str', header_name => 'x-amz-copy-source-if-modified-since', traits => ['ParamInHeader']);
15 1 has CopySourceIfNoneMatch => (is => 'ro', isa => 'Str', header_name => 'x-amz-copy-source-if-none-match', traits => ['ParamInHeader']);
16 1 has CopySourceIfUnmodifiedSince => (is => 'ro', isa => 'Str', header_name => 'x-amz-copy-source-if-unmodified-since', traits => ['ParamInHeader']);
17 1 has CopySourceSSECustomerAlgorithm => (is => 'ro', isa => 'Str', header_name => 'x-amz-copy-source-server-side-encryption-customer-algorithm', traits => ['ParamInHeader']);
18 1 has CopySourceSSECustomerKey => (is => 'ro', isa => 'Str', header_name => 'x-amz-copy-source-server-side-encryption-customer-key', traits => ['ParamInHeader']);
19 1 has CopySourceSSECustomerKeyMD5 => (is => 'ro', isa => 'Str', header_name => 'x-amz-copy-source-server-side-encryption-customer-key-MD5', traits => ['ParamInHeader']);
20 1 has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']);
21 1 has ExpectedSourceBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-source-expected-bucket-owner', traits => ['ParamInHeader']);
22 1 has Expires => (is => 'ro', isa => 'Str', header_name => 'Expires', traits => ['ParamInHeader']);
23 1 has GrantFullControl => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-full-control', traits => ['ParamInHeader']);
24 1 has GrantRead => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-read', traits => ['ParamInHeader']);
25 1 has GrantReadACP => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-read-acp', traits => ['ParamInHeader']);
26 1 has GrantWriteACP => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-write-acp', traits => ['ParamInHeader']);
27 1 has Key => (is => 'ro', isa => 'Str', uri_name => 'Key', traits => ['ParamInURI'], required => 1);
28 1 has Metadata => (is => 'ro', isa => 'Paws::S3::Metadata', header_prefix => 'x-amz-meta-', traits => ['ParamInHeaders']);
29 1 has MetadataDirective => (is => 'ro', isa => 'Str', header_name => 'x-amz-metadata-directive', traits => ['ParamInHeader']);
30 1 has ObjectLockLegalHoldStatus => (is => 'ro', isa => 'Str', header_name => 'x-amz-object-lock-legal-hold', traits => ['ParamInHeader']);
31 1 has ObjectLockMode => (is => 'ro', isa => 'Str', header_name => 'x-amz-object-lock-mode', traits => ['ParamInHeader']);
32 1 has ObjectLockRetainUntilDate => (is => 'ro', isa => 'Str', header_name => 'x-amz-object-lock-retain-until-date', traits => ['ParamInHeader']);
33 1 has RequestPayer => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-payer', traits => ['ParamInHeader']);
34 1 has ServerSideEncryption => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption', traits => ['ParamInHeader']);
35 1 has SSECustomerAlgorithm => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-algorithm', traits => ['ParamInHeader']);
36 1 has SSECustomerKey => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-key', traits => ['ParamInHeader']);
37 1 has SSECustomerKeyMD5 => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-key-MD5', traits => ['ParamInHeader']);
38 1 has SSEKMSEncryptionContext => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-context', traits => ['ParamInHeader']);
39 1 has SSEKMSKeyId => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-aws-kms-key-id', traits => ['ParamInHeader']);
40 1 has StorageClass => (is => 'ro', isa => 'Str', header_name => 'x-amz-storage-class', traits => ['ParamInHeader']);
41 1 has Tagging => (is => 'ro', isa => 'Str', header_name => 'x-amz-tagging', traits => ['ParamInHeader']);
42 1 has TaggingDirective => (is => 'ro', isa => 'Str', header_name => 'x-amz-tagging-directive', traits => ['ParamInHeader']);
43 1 has WebsiteRedirectLocation => (is => 'ro', isa => 'Str', header_name => 'x-amz-website-redirect-location', traits => ['ParamInHeader']);
44  
45  
46 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
47  
48 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CopyObject');
49 1 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}/{Key+}');
50 1 class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
51 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::CopyObjectOutput');
52 1 class_has _result_key => (isa => 'Str', is => 'ro');
53
54
55 1 1;
56  
57 ### main pod documentation begin ###
58  
59 =head1 NAME
60  
61 Paws::S3::CopyObject - Arguments for method CopyObject on L<Paws::S3>
62  
63 =head1 DESCRIPTION
64  
65 This class represents the parameters used for calling the method CopyObject on the
66 L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class
67 as arguments to method CopyObject.
68  
69 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CopyObject.
70  
71 =head1 SYNOPSIS
72  
73 my $s3 = Paws->service('S3');
74 # To copy an object
75 # The following example copies an object from one bucket to another.
76 my $CopyObjectOutput = $s3->CopyObject(
77 'Bucket' => 'destinationbucket',
78 'CopySource' => '/sourcebucket/HappyFacejpg',
79 'Key' => 'HappyFaceCopyjpg'
80 );
81  
82 # Results:
83 my $CopyObjectResult = $CopyObjectOutput->CopyObjectResult;
84  
85 # Returns a L<Paws::S3::CopyObjectOutput> object.
86  
87 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.
88 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/CopyObject>
89  
90 =head1 ATTRIBUTES
91  
92  
93 =head2 ACL => Str
94  
95 The canned ACL to apply to the object.
96  
97 This action is not supported by Amazon S3 on Outposts.
98  
99 Valid values are: C<"private">, C<"public-read">, C<"public-read-write">, C<"authenticated-read">, C<"aws-exec-read">, C<"bucket-owner-read">, C<"bucket-owner-full-control">
100  
101 =head2 B<REQUIRED> Bucket => Str
102  
103 The name of the destination bucket.
104  
105 When using this action with an access point, you must direct requests
106 to the access point hostname. The access point hostname takes the form
107 I<AccessPointName>-I<AccountId>.s3-accesspoint.I<Region>.amazonaws.com.
108 When using this action with an access point through the AWS SDKs, you
109 provide the access point ARN in place of the bucket name. For more
110 information about access point ARNs, see Using access points
111 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
112 in the I<Amazon S3 User Guide>.
113  
114 When using this action with Amazon S3 on Outposts, you must direct
115 requests to the S3 on Outposts hostname. The S3 on Outposts hostname
116 takes the form
117 I<AccessPointName>-I<AccountId>.I<outpostID>.s3-outposts.I<Region>.amazonaws.com.
118 When using this action using S3 on Outposts through the AWS SDKs, you
119 provide the Outposts bucket ARN in place of the bucket name. For more
120 information about S3 on Outposts ARNs, see Using S3 on Outposts
121 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html)
122 in the I<Amazon S3 User Guide>.
123  
124  
125  
126 =head2 BucketKeyEnabled => Bool
127  
128 Specifies whether Amazon S3 should use an S3 Bucket Key for object
129 encryption with server-side encryption using AWS KMS (SSE-KMS). Setting
130 this header to C<true> causes Amazon S3 to use an S3 Bucket Key for
131 object encryption with SSE-KMS.
132  
133 Specifying this header with a COPY action doesnE<rsquo>t affect
134 bucket-level settings for S3 Bucket Key.
135  
136  
137  
138 =head2 CacheControl => Str
139  
140 Specifies caching behavior along the request/reply chain.
141  
142  
143  
144 =head2 ContentDisposition => Str
145  
146 Specifies presentational information for the object.
147  
148  
149  
150 =head2 ContentEncoding => Str
151  
152 Specifies what content encodings have been applied to the object and
153 thus what decoding mechanisms must be applied to obtain the media-type
154 referenced by the Content-Type header field.
155  
156  
157  
158 =head2 ContentLanguage => Str
159  
160 The language the content is in.
161  
162  
163  
164 =head2 ContentType => Str
165  
166 A standard MIME type describing the format of the object data.
167  
168  
169  
170 =head2 B<REQUIRED> CopySource => Str
171  
172 Specifies the source object for the copy operation. You specify the
173 value in one of two formats, depending on whether you want to access
174 the source object through an access point
175 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html):
176  
177 =over
178  
179 =item *
180  
181 For objects not accessed through an access point, specify the name of
182 the source bucket and the key of the source object, separated by a
183 slash (/). For example, to copy the object C<reports/january.pdf> from
184 the bucket C<awsexamplebucket>, use
185 C<awsexamplebucket/reports/january.pdf>. The value must be URL encoded.
186  
187 =item *
188  
189 For objects accessed through access points, specify the Amazon Resource
190 Name (ARN) of the object as accessed through the access point, in the
191 format
192 C<arn:aws:s3:E<lt>RegionE<gt>:E<lt>account-idE<gt>:accesspoint/E<lt>access-point-nameE<gt>/object/E<lt>keyE<gt>>.
193 For example, to copy the object C<reports/january.pdf> through access
194 point C<my-access-point> owned by account C<123456789012> in Region
195 C<us-west-2>, use the URL encoding of
196 C<arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf>.
197 The value must be URL encoded.
198  
199 Amazon S3 supports copy operations using access points only when the
200 source and destination buckets are in the same AWS Region.
201  
202 Alternatively, for objects accessed through Amazon S3 on Outposts,
203 specify the ARN of the object as accessed in the format
204 C<arn:aws:s3-outposts:E<lt>RegionE<gt>:E<lt>account-idE<gt>:outpost/E<lt>outpost-idE<gt>/object/E<lt>keyE<gt>>.
205 For example, to copy the object C<reports/january.pdf> through outpost
206 C<my-outpost> owned by account C<123456789012> in Region C<us-west-2>,
207 use the URL encoding of
208 C<arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf>.
209 The value must be URL encoded.
210  
211 =back
212  
213 To copy a specific version of an object, append
214 C<?versionId=E<lt>version-idE<gt>> to the value (for example,
215 C<awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893>).
216 If you don't specify a version ID, Amazon S3 copies the latest version
217 of the source object.
218  
219  
220  
221 =head2 CopySourceIfMatch => Str
222  
223 Copies the object if its entity tag (ETag) matches the specified tag.
224  
225  
226  
227 =head2 CopySourceIfModifiedSince => Str
228  
229 Copies the object if it has been modified since the specified time.
230  
231  
232  
233 =head2 CopySourceIfNoneMatch => Str
234  
235 Copies the object if its entity tag (ETag) is different than the
236 specified ETag.
237  
238  
239  
240 =head2 CopySourceIfUnmodifiedSince => Str
241  
242 Copies the object if it hasn't been modified since the specified time.
243  
244  
245  
246 =head2 CopySourceSSECustomerAlgorithm => Str
247  
248 Specifies the algorithm to use when decrypting the source object (for
249 example, AES256).
250  
251  
252  
253 =head2 CopySourceSSECustomerKey => Str
254  
255 Specifies the customer-provided encryption key for Amazon S3 to use to
256 decrypt the source object. The encryption key provided in this header
257 must be one that was used when the source object was created.
258  
259  
260  
261 =head2 CopySourceSSECustomerKeyMD5 => Str
262  
263 Specifies the 128-bit MD5 digest of the encryption key according to RFC
264 1321. Amazon S3 uses this header for a message integrity check to
265 ensure that the encryption key was transmitted without error.
266  
267  
268  
269 =head2 ExpectedBucketOwner => Str
270  
271 The account ID of the expected destination bucket owner. If the
272 destination bucket is owned by a different account, the request will
273 fail with an HTTP C<403 (Access Denied)> error.
274  
275  
276  
277 =head2 ExpectedSourceBucketOwner => Str
278  
279 The account ID of the expected source bucket owner. If the source
280 bucket is owned by a different account, the request will fail with an
281 HTTP C<403 (Access Denied)> error.
282  
283  
284  
285 =head2 Expires => Str
286  
287 The date and time at which the object is no longer cacheable.
288  
289  
290  
291 =head2 GrantFullControl => Str
292  
293 Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
294 object.
295  
296 This action is not supported by Amazon S3 on Outposts.
297  
298  
299  
300 =head2 GrantRead => Str
301  
302 Allows grantee to read the object data and its metadata.
303  
304 This action is not supported by Amazon S3 on Outposts.
305  
306  
307  
308 =head2 GrantReadACP => Str
309  
310 Allows grantee to read the object ACL.
311  
312 This action is not supported by Amazon S3 on Outposts.
313  
314  
315  
316 =head2 GrantWriteACP => Str
317  
318 Allows grantee to write the ACL for the applicable object.
319  
320 This action is not supported by Amazon S3 on Outposts.
321  
322  
323  
324 =head2 B<REQUIRED> Key => Str
325  
326 The key of the destination object.
327  
328  
329  
330 =head2 Metadata => L<Paws::S3::Metadata>
331  
332 A map of metadata to store with the object in S3.
333  
334  
335  
336 =head2 MetadataDirective => Str
337  
338 Specifies whether the metadata is copied from the source object or
339 replaced with metadata provided in the request.
340  
341 Valid values are: C<"COPY">, C<"REPLACE">
342  
343 =head2 ObjectLockLegalHoldStatus => Str
344  
345 Specifies whether you want to apply a Legal Hold to the copied object.
346  
347 Valid values are: C<"ON">, C<"OFF">
348  
349 =head2 ObjectLockMode => Str
350  
351 The Object Lock mode that you want to apply to the copied object.
352  
353 Valid values are: C<"GOVERNANCE">, C<"COMPLIANCE">
354  
355 =head2 ObjectLockRetainUntilDate => Str
356  
357 The date and time when you want the copied object's Object Lock to
358 expire.
359  
360  
361  
362 =head2 RequestPayer => Str
363  
364  
365  
366 Valid values are: C<"requester">
367  
368 =head2 ServerSideEncryption => Str
369  
370 The server-side encryption algorithm used when storing this object in
371 Amazon S3 (for example, AES256, aws:kms).
372  
373 Valid values are: C<"AES256">, C<"aws:kms">
374  
375 =head2 SSECustomerAlgorithm => Str
376  
377 Specifies the algorithm to use to when encrypting the object (for
378 example, AES256).
379  
380  
381  
382 =head2 SSECustomerKey => Str
383  
384 Specifies the customer-provided encryption key for Amazon S3 to use in
385 encrypting data. This value is used to store the object and then it is
386 discarded; Amazon S3 does not store the encryption key. The key must be
387 appropriate for use with the algorithm specified in the
388 C<x-amz-server-side-encryption-customer-algorithm> header.
389  
390  
391  
392 =head2 SSECustomerKeyMD5 => Str
393  
394 Specifies the 128-bit MD5 digest of the encryption key according to RFC
395 1321. Amazon S3 uses this header for a message integrity check to
396 ensure that the encryption key was transmitted without error.
397  
398  
399  
400 =head2 SSEKMSEncryptionContext => Str
401  
402 Specifies the AWS KMS Encryption Context to use for object encryption.
403 The value of this header is a base64-encoded UTF-8 string holding JSON
404 with the encryption context key-value pairs.
405  
406  
407  
408 =head2 SSEKMSKeyId => Str
409  
410 Specifies the AWS KMS key ID to use for object encryption. All GET and
411 PUT requests for an object protected by AWS KMS will fail if not made
412 via SSL or using SigV4. For information about configuring using any of
413 the officially supported AWS SDKs and AWS CLI, see Specifying the
414 Signature Version in Request Authentication
415 (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version)
416 in the I<Amazon S3 User Guide>.
417  
418  
419  
420 =head2 StorageClass => Str
421  
422 By default, Amazon S3 uses the STANDARD Storage Class to store newly
423 created objects. The STANDARD storage class provides high durability
424 and high availability. Depending on performance needs, you can specify
425 a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS
426 Storage Class. For more information, see Storage Classes
427 (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html)
428 in the I<Amazon S3 User Guide>.
429  
430 Valid values are: C<"STANDARD">, C<"REDUCED_REDUNDANCY">, C<"STANDARD_IA">, C<"ONEZONE_IA">, C<"INTELLIGENT_TIERING">, C<"GLACIER">, C<"DEEP_ARCHIVE">, C<"OUTPOSTS">
431  
432 =head2 Tagging => Str
433  
434 The tag-set for the object destination object this value must be used
435 in conjunction with the C<TaggingDirective>. The tag-set must be
436 encoded as URL Query parameters.
437  
438  
439  
440 =head2 TaggingDirective => Str
441  
442 Specifies whether the object tag-set are copied from the source object
443 or replaced with tag-set provided in the request.
444  
445 Valid values are: C<"COPY">, C<"REPLACE">
446  
447 =head2 WebsiteRedirectLocation => Str
448  
449 If the bucket is configured as a website, redirects requests for this
450 object to another object in the same bucket or to an external URL.
451 Amazon S3 stores the value of this header in the object metadata.
452  
453  
454  
455  
456 =head1 SEE ALSO
457  
458 This class forms part of L<Paws>, documenting arguments for method CopyObject in L<Paws::S3>
459  
460 =head1 BUGS and CONTRIBUTIONS
461  
462 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
463  
464 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
465  
466 =cut
467  
« blib/lib/Paws/S3/ContinuationEvent.pm ↑ Summary blib/lib/Paws/S3/CopyObjectOutput.pm »