blib/lib/Paws/S3/CreateMultipartUpload.pm

filter: Statementstmt 100% 41 / 41 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 43 / 43 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/S3/CreateBucketOutput.pm ↑ Summary blib/lib/Paws/S3/CreateMultipartUploadOutput.pm »
1  
2 package Paws::S3::CreateMultipartUpload;
3 2 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 2 has ACL => (is => 'ro', isa => 'Str', header_name => 'x-amz-acl', traits => ['ParamInHeader']);
5 2 has Bucket => (is => 'ro', isa => 'Str', uri_name => 'Bucket', traits => ['ParamInURI'], required => 1);
6 2 has BucketKeyEnabled => (is => 'ro', isa => 'Bool', header_name => 'x-amz-server-side-encryption-bucket-key-enabled', traits => ['ParamInHeader']);
7 2 has CacheControl => (is => 'ro', isa => 'Str', header_name => 'Cache-Control', traits => ['ParamInHeader']);
8 2 has ContentDisposition => (is => 'ro', isa => 'Str', header_name => 'Content-Disposition', traits => ['ParamInHeader']);
9 2 has ContentEncoding => (is => 'ro', isa => 'Str', header_name => 'Content-Encoding', traits => ['ParamInHeader']);
10 2 has ContentLanguage => (is => 'ro', isa => 'Str', header_name => 'Content-Language', traits => ['ParamInHeader']);
11 2 has ContentType => (is => 'ro', isa => 'Str', header_name => 'Content-Type', traits => ['ParamInHeader']);
12 2 has ExpectedBucketOwner => (is => 'ro', isa => 'Str', header_name => 'x-amz-expected-bucket-owner', traits => ['ParamInHeader']);
13 2 has Expires => (is => 'ro', isa => 'Str', header_name => 'Expires', traits => ['ParamInHeader']);
14 2 has GrantFullControl => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-full-control', traits => ['ParamInHeader']);
15 2 has GrantRead => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-read', traits => ['ParamInHeader']);
16 2 has GrantReadACP => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-read-acp', traits => ['ParamInHeader']);
17 2 has GrantWriteACP => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-write-acp', traits => ['ParamInHeader']);
18 2 has Key => (is => 'ro', isa => 'Str', uri_name => 'Key', traits => ['ParamInURI'], required => 1);
19 2 has Metadata => (is => 'ro', isa => 'Paws::S3::Metadata', header_prefix => 'x-amz-meta-', traits => ['ParamInHeaders']);
20 2 has ObjectLockLegalHoldStatus => (is => 'ro', isa => 'Str', header_name => 'x-amz-object-lock-legal-hold', traits => ['ParamInHeader']);
21 2 has ObjectLockMode => (is => 'ro', isa => 'Str', header_name => 'x-amz-object-lock-mode', traits => ['ParamInHeader']);
22 2 has ObjectLockRetainUntilDate => (is => 'ro', isa => 'Str', header_name => 'x-amz-object-lock-retain-until-date', traits => ['ParamInHeader']);
23 2 has RequestPayer => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-payer', traits => ['ParamInHeader']);
24 2 has ServerSideEncryption => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption', traits => ['ParamInHeader']);
25 2 has SSECustomerAlgorithm => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-algorithm', traits => ['ParamInHeader']);
26 2 has SSECustomerKey => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-key', traits => ['ParamInHeader']);
27 2 has SSECustomerKeyMD5 => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-key-MD5', traits => ['ParamInHeader']);
28 2 has SSEKMSEncryptionContext => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-context', traits => ['ParamInHeader']);
29 2 has SSEKMSKeyId => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-aws-kms-key-id', traits => ['ParamInHeader']);
30 2 has StorageClass => (is => 'ro', isa => 'Str', header_name => 'x-amz-storage-class', traits => ['ParamInHeader']);
31 2 has Tagging => (is => 'ro', isa => 'Str', header_name => 'x-amz-tagging', traits => ['ParamInHeader']);
32 2 has WebsiteRedirectLocation => (is => 'ro', isa => 'Str', header_name => 'x-amz-website-redirect-location', traits => ['ParamInHeader']);
33  
34  
35 2 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
36  
37 2 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreateMultipartUpload');
38 2 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}/{Key+}?uploads');
39 2 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
40 2 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::CreateMultipartUploadOutput');
41 2 class_has _result_key => (isa => 'Str', is => 'ro');
42
43
44 2 1;
45  
46 ### main pod documentation begin ###
47  
48 =head1 NAME
49  
50 Paws::S3::CreateMultipartUpload - Arguments for method CreateMultipartUpload on L<Paws::S3>
51  
52 =head1 DESCRIPTION
53  
54 This class represents the parameters used for calling the method CreateMultipartUpload on the
55 L<Amazon Simple Storage Service|Paws::S3> service. Use the attributes of this class
56 as arguments to method CreateMultipartUpload.
57  
58 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreateMultipartUpload.
59  
60 =head1 SYNOPSIS
61  
62 my $s3 = Paws->service('S3');
63 # To initiate a multipart upload
64 # The following example initiates a multipart upload.
65 my $CreateMultipartUploadOutput = $s3->CreateMultipartUpload(
66 'Bucket' => 'examplebucket',
67 'Key' => 'largeobject'
68 );
69  
70 # Results:
71 my $Bucket = $CreateMultipartUploadOutput->Bucket;
72 my $Key = $CreateMultipartUploadOutput->Key;
73 my $UploadId = $CreateMultipartUploadOutput->UploadId;
74  
75 # Returns a L<Paws::S3::CreateMultipartUploadOutput> object.
76  
77 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.
78 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3/CreateMultipartUpload>
79  
80 =head1 ATTRIBUTES
81  
82  
83 =head2 ACL => Str
84  
85 The canned ACL to apply to the object.
86  
87 This action is not supported by Amazon S3 on Outposts.
88  
89 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">
90  
91 =head2 B<REQUIRED> Bucket => Str
92  
93 The name of the bucket to which to initiate the upload
94  
95 When using this action with an access point, you must direct requests
96 to the access point hostname. The access point hostname takes the form
97 I<AccessPointName>-I<AccountId>.s3-accesspoint.I<Region>.amazonaws.com.
98 When using this action with an access point through the AWS SDKs, you
99 provide the access point ARN in place of the bucket name. For more
100 information about access point ARNs, see Using access points
101 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-access-points.html)
102 in the I<Amazon S3 User Guide>.
103  
104 When using this action with Amazon S3 on Outposts, you must direct
105 requests to the S3 on Outposts hostname. The S3 on Outposts hostname
106 takes the form
107 I<AccessPointName>-I<AccountId>.I<outpostID>.s3-outposts.I<Region>.amazonaws.com.
108 When using this action using S3 on Outposts through the AWS SDKs, you
109 provide the Outposts bucket ARN in place of the bucket name. For more
110 information about S3 on Outposts ARNs, see Using S3 on Outposts
111 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/S3onOutposts.html)
112 in the I<Amazon S3 User Guide>.
113  
114  
115  
116 =head2 BucketKeyEnabled => Bool
117  
118 Specifies whether Amazon S3 should use an S3 Bucket Key for object
119 encryption with server-side encryption using AWS KMS (SSE-KMS). Setting
120 this header to C<true> causes Amazon S3 to use an S3 Bucket Key for
121 object encryption with SSE-KMS.
122  
123 Specifying this header with an object action doesnE<rsquo>t affect
124 bucket-level settings for S3 Bucket Key.
125  
126  
127  
128 =head2 CacheControl => Str
129  
130 Specifies caching behavior along the request/reply chain.
131  
132  
133  
134 =head2 ContentDisposition => Str
135  
136 Specifies presentational information for the object.
137  
138  
139  
140 =head2 ContentEncoding => Str
141  
142 Specifies what content encodings have been applied to the object and
143 thus what decoding mechanisms must be applied to obtain the media-type
144 referenced by the Content-Type header field.
145  
146  
147  
148 =head2 ContentLanguage => Str
149  
150 The language the content is in.
151  
152  
153  
154 =head2 ContentType => Str
155  
156 A standard MIME type describing the format of the object data.
157  
158  
159  
160 =head2 ExpectedBucketOwner => Str
161  
162 The account ID of the expected bucket owner. If the bucket is owned by
163 a different account, the request will fail with an HTTP C<403 (Access
164 Denied)> error.
165  
166  
167  
168 =head2 Expires => Str
169  
170 The date and time at which the object is no longer cacheable.
171  
172  
173  
174 =head2 GrantFullControl => Str
175  
176 Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
177 object.
178  
179 This action is not supported by Amazon S3 on Outposts.
180  
181  
182  
183 =head2 GrantRead => Str
184  
185 Allows grantee to read the object data and its metadata.
186  
187 This action is not supported by Amazon S3 on Outposts.
188  
189  
190  
191 =head2 GrantReadACP => Str
192  
193 Allows grantee to read the object ACL.
194  
195 This action is not supported by Amazon S3 on Outposts.
196  
197  
198  
199 =head2 GrantWriteACP => Str
200  
201 Allows grantee to write the ACL for the applicable object.
202  
203 This action is not supported by Amazon S3 on Outposts.
204  
205  
206  
207 =head2 B<REQUIRED> Key => Str
208  
209 Object key for which the multipart upload is to be initiated.
210  
211  
212  
213 =head2 Metadata => L<Paws::S3::Metadata>
214  
215 A map of metadata to store with the object in S3.
216  
217  
218  
219 =head2 ObjectLockLegalHoldStatus => Str
220  
221 Specifies whether you want to apply a Legal Hold to the uploaded
222 object.
223  
224 Valid values are: C<"ON">, C<"OFF">
225  
226 =head2 ObjectLockMode => Str
227  
228 Specifies the Object Lock mode that you want to apply to the uploaded
229 object.
230  
231 Valid values are: C<"GOVERNANCE">, C<"COMPLIANCE">
232  
233 =head2 ObjectLockRetainUntilDate => Str
234  
235 Specifies the date and time when you want the Object Lock to expire.
236  
237  
238  
239 =head2 RequestPayer => Str
240  
241  
242  
243 Valid values are: C<"requester">
244  
245 =head2 ServerSideEncryption => Str
246  
247 The server-side encryption algorithm used when storing this object in
248 Amazon S3 (for example, AES256, aws:kms).
249  
250 Valid values are: C<"AES256">, C<"aws:kms">
251  
252 =head2 SSECustomerAlgorithm => Str
253  
254 Specifies the algorithm to use to when encrypting the object (for
255 example, AES256).
256  
257  
258  
259 =head2 SSECustomerKey => Str
260  
261 Specifies the customer-provided encryption key for Amazon S3 to use in
262 encrypting data. This value is used to store the object and then it is
263 discarded; Amazon S3 does not store the encryption key. The key must be
264 appropriate for use with the algorithm specified in the
265 C<x-amz-server-side-encryption-customer-algorithm> header.
266  
267  
268  
269 =head2 SSECustomerKeyMD5 => Str
270  
271 Specifies the 128-bit MD5 digest of the encryption key according to RFC
272 1321. Amazon S3 uses this header for a message integrity check to
273 ensure that the encryption key was transmitted without error.
274  
275  
276  
277 =head2 SSEKMSEncryptionContext => Str
278  
279 Specifies the AWS KMS Encryption Context to use for object encryption.
280 The value of this header is a base64-encoded UTF-8 string holding JSON
281 with the encryption context key-value pairs.
282  
283  
284  
285 =head2 SSEKMSKeyId => Str
286  
287 Specifies the ID of the symmetric customer managed AWS KMS CMK to use
288 for object encryption. All GET and PUT requests for an object protected
289 by AWS KMS will fail if not made via SSL or using SigV4. For
290 information about configuring using any of the officially supported AWS
291 SDKs and AWS CLI, see Specifying the Signature Version in Request
292 Authentication
293 (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version)
294 in the I<Amazon S3 User Guide>.
295  
296  
297  
298 =head2 StorageClass => Str
299  
300 By default, Amazon S3 uses the STANDARD Storage Class to store newly
301 created objects. The STANDARD storage class provides high durability
302 and high availability. Depending on performance needs, you can specify
303 a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS
304 Storage Class. For more information, see Storage Classes
305 (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html)
306 in the I<Amazon S3 User Guide>.
307  
308 Valid values are: C<"STANDARD">, C<"REDUCED_REDUNDANCY">, C<"STANDARD_IA">, C<"ONEZONE_IA">, C<"INTELLIGENT_TIERING">, C<"GLACIER">, C<"DEEP_ARCHIVE">, C<"OUTPOSTS">
309  
310 =head2 Tagging => Str
311  
312 The tag-set for the object. The tag-set must be encoded as URL Query
313 parameters.
314  
315  
316  
317 =head2 WebsiteRedirectLocation => Str
318  
319 If the bucket is configured as a website, redirects requests for this
320 object to another object in the same bucket or to an external URL.
321 Amazon S3 stores the value of this header in the object metadata.
322  
323  
324  
325  
326 =head1 SEE ALSO
327  
328 This class forms part of L<Paws>, documenting arguments for method CreateMultipartUpload in L<Paws::S3>
329  
330 =head1 BUGS and CONTRIBUTIONS
331  
332 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
333  
334 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
335  
336 =cut
337  
« blib/lib/Paws/S3/CreateBucketOutput.pm ↑ Summary blib/lib/Paws/S3/CreateMultipartUploadOutput.pm »