File Coverage

blib/lib/Paws/S3/PutObject.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::S3::PutObject;
3 1     1   540 use Moose;
  1     2   2  
  1         6  
  2         977  
  2         5  
  2         16  
4             has ACL => (is => 'ro', isa => 'Str', header_name => 'x-amz-acl', traits => ['ParamInHeader']);
5             has Body => (is => 'ro', isa => 'Str', traits => ['ParamInBody']);
6             has Bucket => (is => 'ro', isa => 'Str', uri_name => 'Bucket', traits => ['ParamInURI'], required => 1);
7             has CacheControl => (is => 'ro', isa => 'Str', header_name => 'Cache-Control', traits => ['ParamInHeader']);
8             has ContentDisposition => (is => 'ro', isa => 'Str', header_name => 'Content-Disposition', traits => ['ParamInHeader']);
9             has ContentEncoding => (is => 'ro', isa => 'Str', header_name => 'Content-Encoding', traits => ['ParamInHeader']);
10             has ContentLanguage => (is => 'ro', isa => 'Str', header_name => 'Content-Language', traits => ['ParamInHeader']);
11             has ContentLength => (is => 'ro', isa => 'Int', header_name => 'Content-Length', traits => ['ParamInHeader']);
12             has ContentMD5 => (is => 'ro', isa => 'Str', header_name => 'Content-MD5', auto => 'MD5', traits => ['AutoInHeader']);
13             has ContentType => (is => 'ro', isa => 'Str', header_name => 'Content-Type', traits => ['ParamInHeader']);
14             has Expires => (is => 'ro', isa => 'Str', header_name => 'Expires', traits => ['ParamInHeader']);
15             has GrantFullControl => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-full-control', traits => ['ParamInHeader']);
16             has GrantRead => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-read', traits => ['ParamInHeader']);
17             has GrantReadACP => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-read-acp', traits => ['ParamInHeader']);
18             has GrantWriteACP => (is => 'ro', isa => 'Str', header_name => 'x-amz-grant-write-acp', traits => ['ParamInHeader']);
19             has Key => (is => 'ro', isa => 'Str', uri_name => 'Key', traits => ['ParamInURI'], required => 1);
20             has Metadata => (is => 'ro', isa => 'Paws::S3::Metadata', header_prefix => 'x-amz-meta-', traits => ['ParamInHeaders']);
21             has RequestPayer => (is => 'ro', isa => 'Str', header_name => 'x-amz-request-payer', traits => ['ParamInHeader']);
22             has ServerSideEncryption => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption', traits => ['ParamInHeader']);
23             has SSECustomerAlgorithm => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-algorithm', traits => ['ParamInHeader']);
24             has SSECustomerKey => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-key', traits => ['ParamInHeader']);
25             has SSECustomerKeyMD5 => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-customer-key-MD5', traits => ['ParamInHeader']);
26             has SSEKMSKeyId => (is => 'ro', isa => 'Str', header_name => 'x-amz-server-side-encryption-aws-kms-key-id', traits => ['ParamInHeader']);
27             has StorageClass => (is => 'ro', isa => 'Str', header_name => 'x-amz-storage-class', traits => ['ParamInHeader']);
28             has Tagging => (is => 'ro', isa => 'Str', header_name => 'x-amz-tagging', traits => ['ParamInHeader']);
29             has WebsiteRedirectLocation => (is => 'ro', isa => 'Str', header_name => 'x-amz-website-redirect-location', traits => ['ParamInHeader']);
30              
31 1     1   6146 use MooseX::ClassAttribute;
  1     2   2  
  1         9  
  2         12768  
  2         6  
  2         20  
32              
33             class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutObject');
34             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{Bucket}/{Key+}');
35             class_has _api_method => (isa => 'Str', is => 'ro', default => 'PUT');
36             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3::PutObjectOutput');
37             class_has _result_key => (isa => 'Str', is => 'ro');
38             class_has _stream_param => (is => 'ro', default => 'Body');
39             1;
40              
41             ### main pod documentation begin ###
42              
43             =head1 NAME
44              
45             Paws::S3::PutObject - Arguments for method PutObject on Paws::S3
46              
47             =head1 DESCRIPTION
48              
49             This class represents the parameters used for calling the method PutObject on the
50             Amazon Simple Storage Service service. Use the attributes of this class
51             as arguments to method PutObject.
52              
53             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutObject.
54              
55             As an example:
56              
57             $service_obj->PutObject(Att1 => $value1, Att2 => $value2, ...);
58              
59             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.
60              
61             =head1 ATTRIBUTES
62              
63              
64             =head2 ACL => Str
65              
66             The canned ACL to apply to the object.
67              
68             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">
69              
70             =head2 Body => Str
71              
72             Object data.
73              
74              
75              
76             =head2 B<REQUIRED> Bucket => Str
77              
78             Name of the bucket to which the PUT operation was initiated.
79              
80              
81              
82             =head2 CacheControl => Str
83              
84             Specifies caching behavior along the request/reply chain.
85              
86              
87              
88             =head2 ContentDisposition => Str
89              
90             Specifies presentational information for the object.
91              
92              
93              
94             =head2 ContentEncoding => Str
95              
96             Specifies what content encodings have been applied to the object and
97             thus what decoding mechanisms must be applied to obtain the media-type
98             referenced by the Content-Type header field.
99              
100              
101              
102             =head2 ContentLanguage => Str
103              
104             The language the content is in.
105              
106              
107              
108             =head2 ContentLength => Int
109              
110             Size of the body in bytes. This parameter is useful when the size of
111             the body cannot be determined automatically.
112              
113              
114              
115             =head2 ContentMD5 => Str
116              
117             The base64-encoded 128-bit MD5 digest of the part data.
118              
119              
120              
121             =head2 ContentType => Str
122              
123             A standard MIME type describing the format of the object data.
124              
125              
126              
127             =head2 Expires => Str
128              
129             The date and time at which the object is no longer cacheable.
130              
131              
132              
133             =head2 GrantFullControl => Str
134              
135             Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the
136             object.
137              
138              
139              
140             =head2 GrantRead => Str
141              
142             Allows grantee to read the object data and its metadata.
143              
144              
145              
146             =head2 GrantReadACP => Str
147              
148             Allows grantee to read the object ACL.
149              
150              
151              
152             =head2 GrantWriteACP => Str
153              
154             Allows grantee to write the ACL for the applicable object.
155              
156              
157              
158             =head2 B<REQUIRED> Key => Str
159              
160             Object key for which the PUT operation was initiated.
161              
162              
163              
164             =head2 Metadata => L<Paws::S3::Metadata>
165              
166             A map of metadata to store with the object in S3.
167              
168              
169              
170             =head2 RequestPayer => Str
171              
172              
173              
174             Valid values are: C<"requester">
175              
176             =head2 ServerSideEncryption => Str
177              
178             The Server-side encryption algorithm used when storing this object in
179             S3 (e.g., AES256, aws:kms).
180              
181             Valid values are: C<"AES256">, C<"aws:kms">
182              
183             =head2 SSECustomerAlgorithm => Str
184              
185             Specifies the algorithm to use to when encrypting the object (e.g.,
186             AES256).
187              
188              
189              
190             =head2 SSECustomerKey => Str
191              
192             Specifies the customer-provided encryption key for Amazon S3 to use in
193             encrypting data. This value is used to store the object and then it is
194             discarded; Amazon does not store the encryption key. The key must be
195             appropriate for use with the algorithm specified in the
196             x-amz-server-side-encryption-customer-algorithm header.
197              
198              
199              
200             =head2 SSECustomerKeyMD5 => Str
201              
202             Specifies the 128-bit MD5 digest of the encryption key according to RFC
203             1321. Amazon S3 uses this header for a message integrity check to
204             ensure the encryption key was transmitted without error.
205              
206              
207              
208             =head2 SSEKMSKeyId => Str
209              
210             Specifies the AWS KMS key ID to use for object encryption. All GET and
211             PUT requests for an object protected by AWS KMS will fail if not made
212             via SSL or using SigV4. Documentation on configuring any of the
213             officially supported AWS SDKs and CLI can be found at
214             http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
215              
216              
217              
218             =head2 StorageClass => Str
219              
220             The type of storage to use for the object. Defaults to 'STANDARD'.
221              
222             Valid values are: C<"STANDARD">, C<"REDUCED_REDUNDANCY">, C<"STANDARD_IA">
223              
224             =head2 Tagging => Str
225              
226             The tag-set for the object. The tag-set must be encoded as URL Query
227             parameters
228              
229              
230              
231             =head2 WebsiteRedirectLocation => Str
232              
233             If the bucket is configured as a website, redirects requests for this
234             object to another object in the same bucket or to an external URL.
235             Amazon S3 stores the value of this header in the object metadata.
236              
237              
238              
239              
240             =head1 SEE ALSO
241              
242             This class forms part of L<Paws>, documenting arguments for method PutObject in L<Paws::S3>
243              
244             =head1 BUGS and CONTRIBUTIONS
245              
246             The source code is located here: https://github.com/pplu/aws-sdk-perl
247              
248             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
249              
250             =cut
251