blib/lib/Paws/S3.pm

filter: Statementstmt 43.4% 189 / 435 Branchbran 46.0% 23 / 50 Conditioncond 50.0% 6 / 12 MC/DCmcdc 25.0% 2 / 8 Subroutinesub 44.6% 50 / 112 Podpod 95.2% 101 / 106 totaltotal 51.3% 371 / 723 CC 49 SCAR 29.6
CC
49
Cov
44%
ListAllObjectVersions
132.0
ListAllMultipartUploads
90.0
ListAllParts
56.0
CRAP 19.3
« blib/lib/Paws/Route53Domains.pm ↑ Summary blib/lib/Paws/ImportExport.pm »
1 package Paws::S3;
2 15 ▶ warn "Paws::S3 is not stable / supported / entirely developed" unless $ENV{'PAWS_SILENCE_UNSTABLE_WARNINGS'};
Branch: 1 branch
BranchTrueFalseTotal
unless $ENV{"PAWS_SILENCE_UNSTABLE_WARNINGS"} 15 0 15
3 15 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 201 ▶ sub service { 's3' }
Subroutine service: called CC=1 SCAR=0.0
Pod undocumented
5 0 ▶ sub signing_name { 's3' }
Subroutine signing_name: not called CC=1 SCAR=6.9
Pod undocumented
6 0 ▶ sub version { '2006-03-01' }
Subroutine version: not called CC=1 SCAR=6.9
Pod undocumented
7 44 ▶ sub flattened_arrays { 1 }
Subroutine flattened_arrays: called CC=1 SCAR=0.0
Pod undocumented
8 15 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
9 71 ▶ has retry => (is => 'ro', isa => 'HashRef', default => sub {
Subroutine __ANON__: called CC=1 SCAR=0.0
10 71 { base => 'rand', type => 'exponential', growth_factor => 2 }
11 15 });
12 71 ▶ has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
Subroutine __ANON__: called CC=1 SCAR=0.0
13 6 ▶ sub { defined $_[0]->http_status and $_[0]->http_status == 400 and $_[0]->code eq 'BadDigest' },
Subroutine __ANON__: called CC=3 SCAR=11.1
Branch: 1 branch
BranchTrueFalseTotal
defined $_[0]->http_status and $_[0]->http_status == 400 and $_[0]->code eq "BadDigest" 2 4 6
Condition66%2/3
defined $_[0]->http_status and $_[0]->http_status == 400
!ll&&!rl&&r
042
MC/DC50%1/2
defined $_[0]->http_status and $_[0]->http_status == 400
defined $_[0]->http_status $_[0]->http_status == 400
Truth table66%2/3
A and B
A= defined $_[0]->http_statusB= $_[0]->http_status == 400
ABresult
0X0
100
111
14 6 ▶ sub { defined $_[0]->http_status and $_[0]->http_status == 400 and $_[0]->code eq 'RequestTimeout' },
Subroutine __ANON__: called CC=3 SCAR=11.1
Branch: 1 branch
BranchTrueFalseTotal
defined $_[0]->http_status and $_[0]->http_status == 400 and $_[0]->code eq "RequestTimeout" 2 4 6
Condition66%2/3
defined $_[0]->http_status and $_[0]->http_status == 400
!ll&&!rl&&r
042
MC/DC50%1/2
defined $_[0]->http_status and $_[0]->http_status == 400
defined $_[0]->http_status $_[0]->http_status == 400
Truth table66%2/3
A and B
A= defined $_[0]->http_statusB= $_[0]->http_status == 400
ABresult
0X0
100
111
15 71 ] });
16  
17 15 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::S3Signature', 'Paws::Net::RestXmlCaller';
18  
19 71 ▶ has '+region_rules' => (default => sub {
Subroutine __ANON__: called CC=1 SCAR=0.0
20 71 my $regioninfo;
21 71 $regioninfo = [
22 {
23 constraints => [
24 [
25 'region',
26 'oneOf',
27 [
28 'us-east-1',
29 undef
30 ]
31 ]
32 ],
33 properties => {
34 credentialScope => {
35 region => 'us-east-1'
36 }
37 },
38 uri => '{scheme}://s3.amazonaws.com'
39 },
40 {
41 constraints => [
42 [
43 'region',
44 'startsWith',
45 'cn-'
46 ]
47 ],
48 properties => {
49 signatureVersion => 's3v4'
50 },
51 uri => '{scheme}://{service}.{region}.amazonaws.com.cn'
52 },
53 {
54 constraints => [
55 [
56 'region',
57 'oneOf',
58 [
59 'us-east-1',
60 'ap-northeast-1',
61 'sa-east-1',
62 'ap-southeast-1',
63 'ap-southeast-2',
64 'us-west-2',
65 'us-west-1',
66 'eu-west-1',
67 'us-gov-west-1',
68 'fips-us-gov-west-1'
69 ]
70 ]
71 ],
72 uri => '{scheme}://{service}-{region}.amazonaws.com'
73 },
74 {
75 constraints => [
76 [
77 'region',
78 'notEquals',
79 undef
80 ]
81 ],
82 properties => {
83 signatureVersion => 's3v4'
84 },
85 uri => '{scheme}://{service}.{region}.amazonaws.com'
86 }
87 ];
88  
89 71 return $regioninfo;
90 15 });
91  
92
93 1 ▶ sub AbortMultipartUpload {
Subroutine AbortMultipartUpload: called CC=1 SCAR=0.0
Pod documented
94 1 my $self = shift;
95 1 my $call_object = $self->new_with_coercions('Paws::S3::AbortMultipartUpload', @_);
96 1 return $self->caller->do_call($self, $call_object);
97 }
98 3 ▶ sub CompleteMultipartUpload {
Subroutine CompleteMultipartUpload: called CC=1 SCAR=0.0
Pod documented
99 3 my $self = shift;
100 3 my $call_object = $self->new_with_coercions('Paws::S3::CompleteMultipartUpload', @_);
101 3 return $self->caller->do_call($self, $call_object);
102 }
103 2 ▶ sub CopyObject {
Subroutine CopyObject: called CC=1 SCAR=0.0
Pod documented
104 2 my $self = shift;
105 2 my $call_object = $self->new_with_coercions('Paws::S3::CopyObject', @_);
106 2 return $self->caller->do_call($self, $call_object);
107 }
108 4 ▶ sub CreateBucket {
Subroutine CreateBucket: called CC=1 SCAR=0.0
Pod documented
109 4 my $self = shift;
110 4 my $call_object = $self->new_with_coercions('Paws::S3::CreateBucket', @_);
111 4 return $self->caller->do_call($self, $call_object);
112 }
113 3 ▶ sub CreateMultipartUpload {
Subroutine CreateMultipartUpload: called CC=1 SCAR=0.0
Pod documented
114 3 my $self = shift;
115 3 my $call_object = $self->new_with_coercions('Paws::S3::CreateMultipartUpload', @_);
116 3 return $self->caller->do_call($self, $call_object);
117 }
118 1 ▶ sub DeleteBucket {
Subroutine DeleteBucket: called CC=1 SCAR=0.0
Pod documented
119 1 my $self = shift;
120 1 my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucket', @_);
121 1 return $self->caller->do_call($self, $call_object);
122 }
123 0 ▶ sub DeleteBucketAnalyticsConfiguration {
Subroutine DeleteBucketAnalyticsConfiguration: not called CC=1 SCAR=6.9
Pod documented
124 0 my $self = shift;
125 0 my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketAnalyticsConfiguration', @_);
126 0 return $self->caller->do_call($self, $call_object);
127 }
128 0 ▶ sub DeleteBucketCors {
Subroutine DeleteBucketCors: not called CC=1 SCAR=6.9
Pod documented
129 0 my $self = shift;
130 0 my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketCors', @_);
131 0 return $self->caller->do_call($self, $call_object);
132 }
133 0 ▶ sub DeleteBucketEncryption {
Subroutine DeleteBucketEncryption: not called CC=1 SCAR=6.9
Pod documented
134 0 my $self = shift;
135 0 my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketEncryption', @_);
136 0 return $self->caller->do_call($self, $call_object);
137 }
138 0 ▶ sub DeleteBucketIntelligentTieringConfiguration {
Subroutine DeleteBucketIntelligentTieringConfiguration: not called CC=1 SCAR=6.9
Pod documented
139 0 my $self = shift;
140 0 my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketIntelligentTieringConfiguration', @_);
141 0 return $self->caller->do_call($self, $call_object);
142 }
143 0 ▶ sub DeleteBucketInventoryConfiguration {
Subroutine DeleteBucketInventoryConfiguration: not called CC=1 SCAR=6.9
Pod documented
144 0 my $self = shift;
145 0 my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketInventoryConfiguration', @_);
146 0 return $self->caller->do_call($self, $call_object);
147 }
148 1 ▶ sub DeleteBucketLifecycle {
Subroutine DeleteBucketLifecycle: called CC=1 SCAR=0.0
Pod documented
149 1 my $self = shift;
150 1 my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketLifecycle', @_);
151 1 return $self->caller->do_call($self, $call_object);
152 }
153 0 ▶ sub DeleteBucketMetricsConfiguration {
Subroutine DeleteBucketMetricsConfiguration: not called CC=1 SCAR=6.9
Pod documented
154 0 my $self = shift;
155 0 my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketMetricsConfiguration', @_);
156 0 return $self->caller->do_call($self, $call_object);
157 }
158 0 ▶ sub DeleteBucketOwnershipControls {
Subroutine DeleteBucketOwnershipControls: not called CC=1 SCAR=6.9
Pod documented
159 0 my $self = shift;
160 0 my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketOwnershipControls', @_);
161 0 return $self->caller->do_call($self, $call_object);
162 }
163 0 ▶ sub DeleteBucketPolicy {
Subroutine DeleteBucketPolicy: not called CC=1 SCAR=6.9
Pod documented
164 0 my $self = shift;
165 0 my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketPolicy', @_);
166 0 return $self->caller->do_call($self, $call_object);
167 }
168 0 ▶ sub DeleteBucketReplication {
Subroutine DeleteBucketReplication: not called CC=1 SCAR=6.9
Pod documented
169 0 my $self = shift;
170 0 my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketReplication', @_);
171 0 return $self->caller->do_call($self, $call_object);
172 }
173 0 ▶ sub DeleteBucketTagging {
Subroutine DeleteBucketTagging: not called CC=1 SCAR=6.9
Pod documented
174 0 my $self = shift;
175 0 my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketTagging', @_);
176 0 return $self->caller->do_call($self, $call_object);
177 }
178 0 ▶ sub DeleteBucketWebsite {
Subroutine DeleteBucketWebsite: not called CC=1 SCAR=6.9
Pod documented
179 0 my $self = shift;
180 0 my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketWebsite', @_);
181 0 return $self->caller->do_call($self, $call_object);
182 }
183 1 ▶ sub DeleteObject {
Subroutine DeleteObject: called CC=1 SCAR=0.0
Pod documented
184 1 my $self = shift;
185 1 my $call_object = $self->new_with_coercions('Paws::S3::DeleteObject', @_);
186 1 return $self->caller->do_call($self, $call_object);
187 }
188 2 ▶ sub DeleteObjects {
Subroutine DeleteObjects: called CC=1 SCAR=0.0
Pod documented
189 2 my $self = shift;
190 2 my $call_object = $self->new_with_coercions('Paws::S3::DeleteObjects', @_);
191 2 return $self->caller->do_call($self, $call_object);
192 }
193 0 ▶ sub DeleteObjectTagging {
Subroutine DeleteObjectTagging: not called CC=1 SCAR=6.9
Pod documented
194 0 my $self = shift;
195 0 my $call_object = $self->new_with_coercions('Paws::S3::DeleteObjectTagging', @_);
196 0 return $self->caller->do_call($self, $call_object);
197 }
198 0 ▶ sub DeletePublicAccessBlock {
Subroutine DeletePublicAccessBlock: not called CC=1 SCAR=6.9
Pod documented
199 0 my $self = shift;
200 0 my $call_object = $self->new_with_coercions('Paws::S3::DeletePublicAccessBlock', @_);
201 0 return $self->caller->do_call($self, $call_object);
202 }
203 0 ▶ sub GetBucketAccelerateConfiguration {
Subroutine GetBucketAccelerateConfiguration: not called CC=1 SCAR=6.9
Pod documented
204 0 my $self = shift;
205 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketAccelerateConfiguration', @_);
206 0 return $self->caller->do_call($self, $call_object);
207 }
208 1 ▶ sub GetBucketAcl {
Subroutine GetBucketAcl: called CC=1 SCAR=0.0
Pod documented
209 1 my $self = shift;
210 1 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketAcl', @_);
211 1 return $self->caller->do_call($self, $call_object);
212 }
213 0 ▶ sub GetBucketAnalyticsConfiguration {
Subroutine GetBucketAnalyticsConfiguration: not called CC=1 SCAR=6.9
Pod documented
214 0 my $self = shift;
215 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketAnalyticsConfiguration', @_);
216 0 return $self->caller->do_call($self, $call_object);
217 }
218 0 ▶ sub GetBucketCors {
Subroutine GetBucketCors: not called CC=1 SCAR=6.9
Pod documented
219 0 my $self = shift;
220 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketCors', @_);
221 0 return $self->caller->do_call($self, $call_object);
222 }
223 0 ▶ sub GetBucketEncryption {
Subroutine GetBucketEncryption: not called CC=1 SCAR=6.9
Pod documented
224 0 my $self = shift;
225 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketEncryption', @_);
226 0 return $self->caller->do_call($self, $call_object);
227 }
228 0 ▶ sub GetBucketIntelligentTieringConfiguration {
Subroutine GetBucketIntelligentTieringConfiguration: not called CC=1 SCAR=6.9
Pod documented
229 0 my $self = shift;
230 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketIntelligentTieringConfiguration', @_);
231 0 return $self->caller->do_call($self, $call_object);
232 }
233 0 ▶ sub GetBucketInventoryConfiguration {
Subroutine GetBucketInventoryConfiguration: not called CC=1 SCAR=6.9
Pod documented
234 0 my $self = shift;
235 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketInventoryConfiguration', @_);
236 0 return $self->caller->do_call($self, $call_object);
237 }
238 0 ▶ sub GetBucketLifecycle {
Subroutine GetBucketLifecycle: not called CC=1 SCAR=6.9
Pod documented
239 0 my $self = shift;
240 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketLifecycle', @_);
241 0 return $self->caller->do_call($self, $call_object);
242 }
243 0 ▶ sub GetBucketLifecycleConfiguration {
Subroutine GetBucketLifecycleConfiguration: not called CC=1 SCAR=6.9
Pod documented
244 0 my $self = shift;
245 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketLifecycleConfiguration', @_);
246 0 return $self->caller->do_call($self, $call_object);
247 }
248 1 ▶ sub GetBucketLocation {
Subroutine GetBucketLocation: called CC=1 SCAR=0.0
Pod documented
249 1 my $self = shift;
250 1 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketLocation', @_);
251 1 return $self->caller->do_call($self, $call_object);
252 }
253 1 ▶ sub GetBucketLogging {
Subroutine GetBucketLogging: called CC=1 SCAR=0.0
Pod documented
254 1 my $self = shift;
255 1 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketLogging', @_);
256 1 return $self->caller->do_call($self, $call_object);
257 }
258 0 ▶ sub GetBucketMetricsConfiguration {
Subroutine GetBucketMetricsConfiguration: not called CC=1 SCAR=6.9
Pod documented
259 0 my $self = shift;
260 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketMetricsConfiguration', @_);
261 0 return $self->caller->do_call($self, $call_object);
262 }
263 0 ▶ sub GetBucketNotification {
Subroutine GetBucketNotification: not called CC=1 SCAR=6.9
Pod documented
264 0 my $self = shift;
265 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketNotification', @_);
266 0 return $self->caller->do_call($self, $call_object);
267 }
268 0 ▶ sub GetBucketNotificationConfiguration {
Subroutine GetBucketNotificationConfiguration: not called CC=1 SCAR=6.9
Pod documented
269 0 my $self = shift;
270 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketNotificationConfiguration', @_);
271 0 return $self->caller->do_call($self, $call_object);
272 }
273 0 ▶ sub GetBucketOwnershipControls {
Subroutine GetBucketOwnershipControls: not called CC=1 SCAR=6.9
Pod documented
274 0 my $self = shift;
275 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketOwnershipControls', @_);
276 0 return $self->caller->do_call($self, $call_object);
277 }
278 1 ▶ sub GetBucketPolicy {
Subroutine GetBucketPolicy: called CC=1 SCAR=0.0
Pod documented
279 1 my $self = shift;
280 1 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketPolicy', @_);
281 1 return $self->caller->do_call($self, $call_object);
282 }
283 0 ▶ sub GetBucketPolicyStatus {
Subroutine GetBucketPolicyStatus: not called CC=1 SCAR=6.9
Pod documented
284 0 my $self = shift;
285 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketPolicyStatus', @_);
286 0 return $self->caller->do_call($self, $call_object);
287 }
288 0 ▶ sub GetBucketReplication {
Subroutine GetBucketReplication: not called CC=1 SCAR=6.9
Pod documented
289 0 my $self = shift;
290 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketReplication', @_);
291 0 return $self->caller->do_call($self, $call_object);
292 }
293 0 ▶ sub GetBucketRequestPayment {
Subroutine GetBucketRequestPayment: not called CC=1 SCAR=6.9
Pod documented
294 0 my $self = shift;
295 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketRequestPayment', @_);
296 0 return $self->caller->do_call($self, $call_object);
297 }
298 0 ▶ sub GetBucketTagging {
Subroutine GetBucketTagging: not called CC=1 SCAR=6.9
Pod documented
299 0 my $self = shift;
300 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketTagging', @_);
301 0 return $self->caller->do_call($self, $call_object);
302 }
303 0 ▶ sub GetBucketVersioning {
Subroutine GetBucketVersioning: not called CC=1 SCAR=6.9
Pod documented
304 0 my $self = shift;
305 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketVersioning', @_);
306 0 return $self->caller->do_call($self, $call_object);
307 }
308 0 ▶ sub GetBucketWebsite {
Subroutine GetBucketWebsite: not called CC=1 SCAR=6.9
Pod documented
309 0 my $self = shift;
310 0 my $call_object = $self->new_with_coercions('Paws::S3::GetBucketWebsite', @_);
311 0 return $self->caller->do_call($self, $call_object);
312 }
313 3 ▶ sub GetObject {
Subroutine GetObject: called CC=1 SCAR=0.0
Pod documented
314 3 my $self = shift;
315 3 my $call_object = $self->new_with_coercions('Paws::S3::GetObject', @_);
316 3 return $self->caller->do_call($self, $call_object);
317 }
318 0 ▶ sub GetObjectAcl {
Subroutine GetObjectAcl: not called CC=1 SCAR=6.9
Pod documented
319 0 my $self = shift;
320 0 my $call_object = $self->new_with_coercions('Paws::S3::GetObjectAcl', @_);
321 0 return $self->caller->do_call($self, $call_object);
322 }
323 0 ▶ sub GetObjectLegalHold {
Subroutine GetObjectLegalHold: not called CC=1 SCAR=6.9
Pod documented
324 0 my $self = shift;
325 0 my $call_object = $self->new_with_coercions('Paws::S3::GetObjectLegalHold', @_);
326 0 return $self->caller->do_call($self, $call_object);
327 }
328 0 ▶ sub GetObjectLockConfiguration {
Subroutine GetObjectLockConfiguration: not called CC=1 SCAR=6.9
Pod documented
329 0 my $self = shift;
330 0 my $call_object = $self->new_with_coercions('Paws::S3::GetObjectLockConfiguration', @_);
331 0 return $self->caller->do_call($self, $call_object);
332 }
333 0 ▶ sub GetObjectRetention {
Subroutine GetObjectRetention: not called CC=1 SCAR=6.9
Pod documented
334 0 my $self = shift;
335 0 my $call_object = $self->new_with_coercions('Paws::S3::GetObjectRetention', @_);
336 0 return $self->caller->do_call($self, $call_object);
337 }
338 0 ▶ sub GetObjectTagging {
Subroutine GetObjectTagging: not called CC=1 SCAR=6.9
Pod documented
339 0 my $self = shift;
340 0 my $call_object = $self->new_with_coercions('Paws::S3::GetObjectTagging', @_);
341 0 return $self->caller->do_call($self, $call_object);
342 }
343 0 ▶ sub GetObjectTorrent {
Subroutine GetObjectTorrent: not called CC=1 SCAR=6.9
Pod documented
344 0 my $self = shift;
345 0 my $call_object = $self->new_with_coercions('Paws::S3::GetObjectTorrent', @_);
346 0 return $self->caller->do_call($self, $call_object);
347 }
348 0 ▶ sub GetPublicAccessBlock {
Subroutine GetPublicAccessBlock: not called CC=1 SCAR=6.9
Pod documented
349 0 my $self = shift;
350 0 my $call_object = $self->new_with_coercions('Paws::S3::GetPublicAccessBlock', @_);
351 0 return $self->caller->do_call($self, $call_object);
352 }
353 0 ▶ sub HeadBucket {
Subroutine HeadBucket: not called CC=1 SCAR=6.9
Pod documented
354 0 my $self = shift;
355 0 my $call_object = $self->new_with_coercions('Paws::S3::HeadBucket', @_);
356 0 return $self->caller->do_call($self, $call_object);
357 }
358 0 ▶ sub HeadObject {
Subroutine HeadObject: not called CC=1 SCAR=6.9
Pod documented
359 0 my $self = shift;
360 0 my $call_object = $self->new_with_coercions('Paws::S3::HeadObject', @_);
361 0 return $self->caller->do_call($self, $call_object);
362 }
363 0 ▶ sub ListBucketAnalyticsConfigurations {
Subroutine ListBucketAnalyticsConfigurations: not called CC=1 SCAR=6.9
Pod documented
364 0 my $self = shift;
365 0 my $call_object = $self->new_with_coercions('Paws::S3::ListBucketAnalyticsConfigurations', @_);
366 0 return $self->caller->do_call($self, $call_object);
367 }
368 0 ▶ sub ListBucketIntelligentTieringConfigurations {
Subroutine ListBucketIntelligentTieringConfigurations: not called CC=1 SCAR=6.9
Pod documented
369 0 my $self = shift;
370 0 my $call_object = $self->new_with_coercions('Paws::S3::ListBucketIntelligentTieringConfigurations', @_);
371 0 return $self->caller->do_call($self, $call_object);
372 }
373 0 ▶ sub ListBucketInventoryConfigurations {
Subroutine ListBucketInventoryConfigurations: not called CC=1 SCAR=6.9
Pod documented
374 0 my $self = shift;
375 0 my $call_object = $self->new_with_coercions('Paws::S3::ListBucketInventoryConfigurations', @_);
376 0 return $self->caller->do_call($self, $call_object);
377 }
378 0 ▶ sub ListBucketMetricsConfigurations {
Subroutine ListBucketMetricsConfigurations: not called CC=1 SCAR=6.9
Pod documented
379 0 my $self = shift;
380 0 my $call_object = $self->new_with_coercions('Paws::S3::ListBucketMetricsConfigurations', @_);
381 0 return $self->caller->do_call($self, $call_object);
382 }
383 5 ▶ sub ListBuckets {
Subroutine ListBuckets: called CC=1 SCAR=0.0
Pod documented
384 5 my $self = shift;
385 5 my $call_object = $self->new_with_coercions('Paws::S3::ListBuckets', @_);
386 5 return $self->caller->do_call($self, $call_object);
387 }
388 2 ▶ sub ListMultipartUploads {
Subroutine ListMultipartUploads: called CC=1 SCAR=0.0
Pod documented
389 2 my $self = shift;
390 2 my $call_object = $self->new_with_coercions('Paws::S3::ListMultipartUploads', @_);
391 2 return $self->caller->do_call($self, $call_object);
392 }
393 22 ▶ sub ListObjects {
Subroutine ListObjects: called CC=1 SCAR=0.0
Pod documented
394 22 my $self = shift;
395 22 my $call_object = $self->new_with_coercions('Paws::S3::ListObjects', @_);
396 22 return $self->caller->do_call($self, $call_object);
397 }
398 19 ▶ sub ListObjectsV2 {
Subroutine ListObjectsV2: called CC=1 SCAR=0.0
Pod documented
399 19 my $self = shift;
400 19 my $call_object = $self->new_with_coercions('Paws::S3::ListObjectsV2', @_);
401 19 return $self->caller->do_call($self, $call_object);
402 }
403 2 ▶ sub ListObjectVersions {
Subroutine ListObjectVersions: called CC=1 SCAR=0.0
Pod documented
404 2 my $self = shift;
405 2 my $call_object = $self->new_with_coercions('Paws::S3::ListObjectVersions', @_);
406 2 return $self->caller->do_call($self, $call_object);
407 }
408 2 ▶ sub ListParts {
Subroutine ListParts: called CC=1 SCAR=0.0
Pod documented
409 2 my $self = shift;
410 2 my $call_object = $self->new_with_coercions('Paws::S3::ListParts', @_);
411 2 return $self->caller->do_call($self, $call_object);
412 }
413 1 ▶ sub PutBucketAccelerateConfiguration {
Subroutine PutBucketAccelerateConfiguration: called CC=1 SCAR=0.0
Pod documented
414 1 my $self = shift;
415 1 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketAccelerateConfiguration', @_);
416 1 return $self->caller->do_call($self, $call_object);
417 }
418 1 ▶ sub PutBucketAcl {
Subroutine PutBucketAcl: called CC=1 SCAR=0.0
Pod documented
419 1 my $self = shift;
420 1 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketAcl', @_);
421 1 return $self->caller->do_call($self, $call_object);
422 }
423 0 ▶ sub PutBucketAnalyticsConfiguration {
Subroutine PutBucketAnalyticsConfiguration: not called CC=1 SCAR=6.9
Pod documented
424 0 my $self = shift;
425 0 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketAnalyticsConfiguration', @_);
426 0 return $self->caller->do_call($self, $call_object);
427 }
428 2 ▶ sub PutBucketCors {
Subroutine PutBucketCors: called CC=1 SCAR=0.0
Pod documented
429 2 my $self = shift;
430 2 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketCors', @_);
431 2 return $self->caller->do_call($self, $call_object);
432 }
433 1 ▶ sub PutBucketEncryption {
Subroutine PutBucketEncryption: called CC=1 SCAR=0.0
Pod documented
434 1 my $self = shift;
435 1 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketEncryption', @_);
436 1 return $self->caller->do_call($self, $call_object);
437 }
438 0 ▶ sub PutBucketIntelligentTieringConfiguration {
Subroutine PutBucketIntelligentTieringConfiguration: not called CC=1 SCAR=6.9
Pod documented
439 0 my $self = shift;
440 0 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketIntelligentTieringConfiguration', @_);
441 0 return $self->caller->do_call($self, $call_object);
442 }
443 1 ▶ sub PutBucketInventoryConfiguration {
Subroutine PutBucketInventoryConfiguration: called CC=1 SCAR=0.0
Pod documented
444 1 my $self = shift;
445 1 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketInventoryConfiguration', @_);
446 1 return $self->caller->do_call($self, $call_object);
447 }
448 0 ▶ sub PutBucketLifecycle {
Subroutine PutBucketLifecycle: not called CC=1 SCAR=6.9
Pod documented
449 0 my $self = shift;
450 0 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketLifecycle', @_);
451 0 return $self->caller->do_call($self, $call_object);
452 }
453 3 ▶ sub PutBucketLifecycleConfiguration {
Subroutine PutBucketLifecycleConfiguration: called CC=1 SCAR=0.0
Pod documented
454 3 my $self = shift;
455 3 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketLifecycleConfiguration', @_);
456 3 return $self->caller->do_call($self, $call_object);
457 }
458 1 ▶ sub PutBucketLogging {
Subroutine PutBucketLogging: called CC=1 SCAR=0.0
Pod documented
459 1 my $self = shift;
460 1 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketLogging', @_);
461 1 return $self->caller->do_call($self, $call_object);
462 }
463 1 ▶ sub PutBucketMetricsConfiguration {
Subroutine PutBucketMetricsConfiguration: called CC=1 SCAR=0.0
Pod documented
464 1 my $self = shift;
465 1 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketMetricsConfiguration', @_);
466 1 return $self->caller->do_call($self, $call_object);
467 }
468 1 ▶ sub PutBucketNotification {
Subroutine PutBucketNotification: called CC=1 SCAR=0.0
Pod documented
469 1 my $self = shift;
470 1 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketNotification', @_);
471 1 return $self->caller->do_call($self, $call_object);
472 }
473 0 ▶ sub PutBucketNotificationConfiguration {
Subroutine PutBucketNotificationConfiguration: not called CC=1 SCAR=6.9
Pod documented
474 0 my $self = shift;
475 0 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketNotificationConfiguration', @_);
476 0 return $self->caller->do_call($self, $call_object);
477 }
478 0 ▶ sub PutBucketOwnershipControls {
Subroutine PutBucketOwnershipControls: not called CC=1 SCAR=6.9
Pod documented
479 0 my $self = shift;
480 0 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketOwnershipControls', @_);
481 0 return $self->caller->do_call($self, $call_object);
482 }
483 1 ▶ sub PutBucketPolicy {
Subroutine PutBucketPolicy: called CC=1 SCAR=0.0
Pod documented
484 1 my $self = shift;
485 1 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketPolicy', @_);
486 1 return $self->caller->do_call($self, $call_object);
487 }
488 2 ▶ sub PutBucketReplication {
Subroutine PutBucketReplication: called CC=1 SCAR=0.0
Pod documented
489 2 my $self = shift;
490 2 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketReplication', @_);
491 2 return $self->caller->do_call($self, $call_object);
492 }
493 1 ▶ sub PutBucketRequestPayment {
Subroutine PutBucketRequestPayment: called CC=1 SCAR=0.0
Pod documented
494 1 my $self = shift;
495 1 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketRequestPayment', @_);
496 1 return $self->caller->do_call($self, $call_object);
497 }
498 2 ▶ sub PutBucketTagging {
Subroutine PutBucketTagging: called CC=1 SCAR=0.0
Pod documented
499 2 my $self = shift;
500 2 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketTagging', @_);
501 2 return $self->caller->do_call($self, $call_object);
502 }
503 1 ▶ sub PutBucketVersioning {
Subroutine PutBucketVersioning: called CC=1 SCAR=0.0
Pod documented
504 1 my $self = shift;
505 1 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketVersioning', @_);
506 1 return $self->caller->do_call($self, $call_object);
507 }
508 1 ▶ sub PutBucketWebsite {
Subroutine PutBucketWebsite: called CC=1 SCAR=0.0
Pod documented
509 1 my $self = shift;
510 1 my $call_object = $self->new_with_coercions('Paws::S3::PutBucketWebsite', @_);
511 1 return $self->caller->do_call($self, $call_object);
512 }
513 196 ▶ sub PutObject {
Subroutine PutObject: called CC=1 SCAR=0.0
Pod documented
514 196 my $self = shift;
515 196 my $call_object = $self->new_with_coercions('Paws::S3::PutObject', @_);
516 196 return $self->caller->do_call($self, $call_object);
517 }
518 0 ▶ sub PutObjectAcl {
Subroutine PutObjectAcl: not called CC=1 SCAR=6.9
Pod documented
519 0 my $self = shift;
520 0 my $call_object = $self->new_with_coercions('Paws::S3::PutObjectAcl', @_);
521 0 return $self->caller->do_call($self, $call_object);
522 }
523 0 ▶ sub PutObjectLegalHold {
Subroutine PutObjectLegalHold: not called CC=1 SCAR=6.9
Pod documented
524 0 my $self = shift;
525 0 my $call_object = $self->new_with_coercions('Paws::S3::PutObjectLegalHold', @_);
526 0 return $self->caller->do_call($self, $call_object);
527 }
528 0 ▶ sub PutObjectLockConfiguration {
Subroutine PutObjectLockConfiguration: not called CC=1 SCAR=6.9
Pod documented
529 0 my $self = shift;
530 0 my $call_object = $self->new_with_coercions('Paws::S3::PutObjectLockConfiguration', @_);
531 0 return $self->caller->do_call($self, $call_object);
532 }
533 0 ▶ sub PutObjectRetention {
Subroutine PutObjectRetention: not called CC=1 SCAR=6.9
Pod documented
534 0 my $self = shift;
535 0 my $call_object = $self->new_with_coercions('Paws::S3::PutObjectRetention', @_);
536 0 return $self->caller->do_call($self, $call_object);
537 }
538 2 ▶ sub PutObjectTagging {
Subroutine PutObjectTagging: called CC=1 SCAR=0.0
Pod documented
539 2 my $self = shift;
540 2 my $call_object = $self->new_with_coercions('Paws::S3::PutObjectTagging', @_);
541 2 return $self->caller->do_call($self, $call_object);
542 }
543 0 ▶ sub PutPublicAccessBlock {
Subroutine PutPublicAccessBlock: not called CC=1 SCAR=6.9
Pod documented
544 0 my $self = shift;
545 0 my $call_object = $self->new_with_coercions('Paws::S3::PutPublicAccessBlock', @_);
546 0 return $self->caller->do_call($self, $call_object);
547 }
548 1 ▶ sub RestoreObject {
Subroutine RestoreObject: called CC=1 SCAR=0.0
Pod documented
549 1 my $self = shift;
550 1 my $call_object = $self->new_with_coercions('Paws::S3::RestoreObject', @_);
551 1 return $self->caller->do_call($self, $call_object);
552 }
553 2 ▶ sub SelectObjectContent {
Subroutine SelectObjectContent: called CC=1 SCAR=0.0
Pod documented
554 2 my $self = shift;
555 2 my $call_object = $self->new_with_coercions('Paws::S3::SelectObjectContent', @_);
556 2 return $self->caller->do_call($self, $call_object);
557 }
558 3 ▶ sub UploadPart {
Subroutine UploadPart: called CC=1 SCAR=0.0
Pod documented
559 3 my $self = shift;
560 3 my $call_object = $self->new_with_coercions('Paws::S3::UploadPart', @_);
561 3 return $self->caller->do_call($self, $call_object);
562 }
563 0 ▶ sub UploadPartCopy {
Subroutine UploadPartCopy: not called CC=1 SCAR=6.9
Pod documented
564 0 my $self = shift;
565 0 my $call_object = $self->new_with_coercions('Paws::S3::UploadPartCopy', @_);
566 0 return $self->caller->do_call($self, $call_object);
567 }
568 0 ▶ sub WriteGetObjectResponse {
Subroutine WriteGetObjectResponse: not called CC=1 SCAR=6.9
Pod documented
569 0 my $self = shift;
570 0 my $call_object = $self->new_with_coercions('Paws::S3::WriteGetObjectResponse', @_);
571 0 return $self->caller->do_call($self, $call_object);
572 }
573
574 0 ▶ sub ListAllMultipartUploads {
Subroutine ListAllMultipartUploads: not called CC=9 SCAR=45.0
Pod documented
575 0 my $self = shift;
576  
577 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
578 0 my $result = $self->ListMultipartUploads(@_);
579 0 my $next_result = $result;
580  
581 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
582 0 ▶ while ($next_result->IsTruncated) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->IsTruncated) 0 0 0
583 0 $next_result = $self->ListMultipartUploads(@_, KeyMarker => $next_result->NextKeyMarker, UploadIdMarker => $next_result->NextUploadIdMarker);
584 0 push @{ $result->Uploads }, @{ $next_result->Uploads };
585 0 push @{ $result->CommonPrefixes }, @{ $next_result->CommonPrefixes };
586 }
587 0 return $result;
588 } else {
589 0 ▶ while ($result->IsTruncated) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->IsTruncated) 0 0 0
590 0 $callback->($_ => 'Uploads') foreach (@{ $result->Uploads });
591 0 $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes });
592 0 $result = $self->ListMultipartUploads(@_, KeyMarker => $result->NextKeyMarker, UploadIdMarker => $result->NextUploadIdMarker);
593 }
594 0 $callback->($_ => 'Uploads') foreach (@{ $result->Uploads });
595 0 $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes });
596 }
597  
598 return undef
599 0 }
600 4 ▶ sub ListAllObjects {
Subroutine ListAllObjects: called CC=13 SCAR=26.0
Pod documented
601 4 my $self = shift;
602  
603 4 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 2 2 4
604 4 my $result = $self->ListObjects(@_);
605 4 my $next_result = $result;
606  
607 4 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 2 2 4
608 2 ▶ while ($next_result->IsTruncated) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->IsTruncated) 4 2 6
609 4 ▶ $next_result = $self->ListObjects(@_, Marker => $result->NextMarker || ( (defined $result->Contents->[-1]) ? $result->Contents->[-1]->Key : undef ));
Branch: 1 branch
BranchTrueFalseTotal
defined $result->Contents->[-1] ? : 4 0 4
Condition33%1/3
$result->NextMarker || (defined $result->Contents->[-1] ? $result->Contents->[-1]->Key : undef)
l!l&&r!l&&!r
040
MC/DC0%0/2
$result->NextMarker || (defined $result->Contents->[-1] ? $result->Contents->[-1]->Key : undef)
$result->NextMarker (defined $result->Contents->[-1] ? $result->Contents->[-1]->Key : undef)
Truth table33%1/3
A || B
A= $result->NextMarkerB= (defined $result->Contents->[-1] ? $result->Contents->[-1]->Key : undef)
ABresult
1X1
011
000
610 4 push @{ $result->Contents }, @{ $next_result->Contents };
611 4 push @{ $result->CommonPrefixes }, @{ $next_result->CommonPrefixes };
612 }
613 2 return $result;
614 } else {
615 2 ▶ while ($result->IsTruncated) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->IsTruncated) 4 2 6
616 4 $callback->($_ => 'Contents') foreach (@{ $result->Contents });
617 4 $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes });
618 4 ▶ $result = $self->ListObjects(@_, Marker => $result->NextMarker || ( (defined $result->Contents->[-1]) ? $result->Contents->[-1]->Key : undef ));
Branch: 1 branch
BranchTrueFalseTotal
defined $result->Contents->[-1] ? : 4 0 4
Condition33%1/3
$result->NextMarker || (defined $result->Contents->[-1] ? $result->Contents->[-1]->Key : undef)
l!l&&r!l&&!r
040
MC/DC0%0/2
$result->NextMarker || (defined $result->Contents->[-1] ? $result->Contents->[-1]->Key : undef)
$result->NextMarker (defined $result->Contents->[-1] ? $result->Contents->[-1]->Key : undef)
Truth table33%1/3
A || B
A= $result->NextMarkerB= (defined $result->Contents->[-1] ? $result->Contents->[-1]->Key : undef)
ABresult
1X1
011
000
619 }
620 2 $callback->($_ => 'Contents') foreach (@{ $result->Contents });
621 2 $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes });
622 }
623  
624 return undef
625 2 }
626 4 ▶ sub ListAllObjectsV2 {
Subroutine ListAllObjectsV2: called CC=9 SCAR=22.0
Pod documented
627 4 my $self = shift;
628  
629 4 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 2 2 4
630 4 my $result = $self->ListObjectsV2(@_);
631 4 my $next_result = $result;
632  
633 4 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 2 2 4
634 2 ▶ while ($next_result->IsTruncated) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->IsTruncated) 4 2 6
635 4 $next_result = $self->ListObjectsV2(@_, ContinuationToken => $next_result->NextContinuationToken);
636 4 push @{ $result->Contents }, @{ $next_result->Contents };
637 4 push @{ $result->CommonPrefixes }, @{ $next_result->CommonPrefixes };
638 }
639 2 return $result;
640 } else {
641 2 ▶ while ($result->IsTruncated) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->IsTruncated) 4 2 6
642 4 $callback->($_ => 'Contents') foreach (@{ $result->Contents });
643 4 $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes });
644 4 $result = $self->ListObjectsV2(@_, ContinuationToken => $result->NextContinuationToken);
645 }
646 2 $callback->($_ => 'Contents') foreach (@{ $result->Contents });
647 2 $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes });
648 }
649  
650 return undef
651 2 }
652 0 ▶ sub ListAllObjectVersions {
Subroutine ListAllObjectVersions: not called CC=11 SCAR=48.8
Pod documented
653 0 my $self = shift;
654  
655 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
656 0 my $result = $self->ListObjectVersions(@_);
657 0 my $next_result = $result;
658  
659 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
660 0 ▶ while ($next_result->IsTruncated) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->IsTruncated) 0 0 0
661 0 $next_result = $self->ListObjectVersions(@_, KeyMarker => $next_result->NextKeyMarker, VersionIdMarker => $next_result->NextVersionIdMarker);
662 0 push @{ $result->Versions }, @{ $next_result->Versions };
663 0 push @{ $result->DeleteMarkers }, @{ $next_result->DeleteMarkers };
664 0 push @{ $result->CommonPrefixes }, @{ $next_result->CommonPrefixes };
665 }
666 0 return $result;
667 } else {
668 0 ▶ while ($result->IsTruncated) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->IsTruncated) 0 0 0
669 0 $callback->($_ => 'Versions') foreach (@{ $result->Versions });
670 0 $callback->($_ => 'DeleteMarkers') foreach (@{ $result->DeleteMarkers });
671 0 $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes });
672 0 $result = $self->ListObjectVersions(@_, KeyMarker => $result->NextKeyMarker, VersionIdMarker => $result->NextVersionIdMarker);
673 }
674 0 $callback->($_ => 'Versions') foreach (@{ $result->Versions });
675 0 $callback->($_ => 'DeleteMarkers') foreach (@{ $result->DeleteMarkers });
676 0 $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes });
677 }
678  
679 return undef
680 0 }
681 0 ▶ sub ListAllParts {
Subroutine ListAllParts: not called CC=7 SCAR=40.3
Pod documented
682 0 my $self = shift;
683  
684 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
685 0 my $result = $self->ListParts(@_);
686 0 my $next_result = $result;
687  
688 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
689 0 ▶ while ($next_result->IsTruncated) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->IsTruncated) 0 0 0
690 0 $next_result = $self->ListParts(@_, PartNumberMarker => $next_result->NextPartNumberMarker);
691 0 push @{ $result->Parts }, @{ $next_result->Parts };
692 }
693 0 return $result;
694 } else {
695 0 ▶ while ($result->IsTruncated) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->IsTruncated) 0 0 0
696 0 $callback->($_ => 'Parts') foreach (@{ $result->Parts });
697 0 $result = $self->ListParts(@_, PartNumberMarker => $result->NextPartNumberMarker);
698 }
699 0 $callback->($_ => 'Parts') foreach (@{ $result->Parts });
700 }
701  
702 return undef
703 0 }
704  
705  
706 0 ▶ sub operations { qw/AbortMultipartUpload CompleteMultipartUpload CopyObject CreateBucket CreateMultipartUpload DeleteBucket DeleteBucketAnalyticsConfiguration DeleteBucketCors DeleteBucketEncryption DeleteBucketIntelligentTieringConfiguration DeleteBucketInventoryConfiguration DeleteBucketLifecycle DeleteBucketMetricsConfiguration DeleteBucketOwnershipControls DeleteBucketPolicy DeleteBucketReplication DeleteBucketTagging DeleteBucketWebsite DeleteObject DeleteObjects DeleteObjectTagging DeletePublicAccessBlock GetBucketAccelerateConfiguration GetBucketAcl GetBucketAnalyticsConfiguration GetBucketCors GetBucketEncryption GetBucketIntelligentTieringConfiguration GetBucketInventoryConfiguration GetBucketLifecycle GetBucketLifecycleConfiguration GetBucketLocation GetBucketLogging GetBucketMetricsConfiguration GetBucketNotification GetBucketNotificationConfiguration GetBucketOwnershipControls GetBucketPolicy GetBucketPolicyStatus GetBucketReplication GetBucketRequestPayment GetBucketTagging GetBucketVersioning GetBucketWebsite GetObject GetObjectAcl GetObjectLegalHold GetObjectLockConfiguration GetObjectRetention GetObjectTagging GetObjectTorrent GetPublicAccessBlock HeadBucket HeadObject ListBucketAnalyticsConfigurations ListBucketIntelligentTieringConfigurations ListBucketInventoryConfigurations ListBucketMetricsConfigurations ListBuckets ListMultipartUploads ListObjects ListObjectsV2 ListObjectVersions ListParts PutBucketAccelerateConfiguration PutBucketAcl PutBucketAnalyticsConfiguration PutBucketCors PutBucketEncryption PutBucketIntelligentTieringConfiguration PutBucketInventoryConfiguration PutBucketLifecycle PutBucketLifecycleConfiguration PutBucketLogging PutBucketMetricsConfiguration PutBucketNotification PutBucketNotificationConfiguration PutBucketOwnershipControls PutBucketPolicy PutBucketReplication PutBucketRequestPayment PutBucketTagging PutBucketVersioning PutBucketWebsite PutObject PutObjectAcl PutObjectLegalHold PutObjectLockConfiguration PutObjectRetention PutObjectTagging PutPublicAccessBlock RestoreObject SelectObjectContent UploadPart UploadPartCopy WriteGetObjectResponse / }
Subroutine operations: not called CC=1 SCAR=6.9
Pod undocumented
707  
708 15 1;
709  
710 ### main pod documentation begin ###
711  
712 =head1 NAME
713  
714 Paws::S3 - Perl Interface to AWS Amazon Simple Storage Service
715  
716 =head1 SYNOPSIS
717  
718 use Paws;
719  
720 my $obj = Paws->service('S3');
721 my $res = $obj->Method(
722 Arg1 => $val1,
723 Arg2 => [ 'V1', 'V2' ],
724 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
725 # of the arguments type
726 Arg3 => { Att1 => 'Val1' },
727 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
728 # the constructor of the arguments type
729 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
730 );
731  
732 =head1 DESCRIPTION
733  
734 Amazon Simple Storage Service
735  
736 Amazon Simple Storage Service is storage for the Internet. It is
737 designed to make web-scale computing easier for developers.
738  
739 Amazon S3 has a simple web services interface that you can use to store
740 and retrieve any amount of data, at any time, from anywhere on the web.
741 It gives any developer access to the same highly scalable, reliable,
742 fast, inexpensive data storage infrastructure that Amazon uses to run
743 its own global network of web sites. The service aims to maximize
744 benefits of scale and to pass those benefits on to developers.
745  
746 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01>
747  
748  
749 =head1 METHODS
750  
751 =head2 AbortMultipartUpload
752  
753 =over
754  
755 =item Bucket => Str
756  
757 =item Key => Str
758  
759 =item UploadId => Str
760  
761 =item [ExpectedBucketOwner => Str]
762  
763 =item [RequestPayer => Str]
764  
765  
766 =back
767  
768 Each argument is described in detail in: L<Paws::S3::AbortMultipartUpload>
769  
770 Returns: a L<Paws::S3::AbortMultipartUploadOutput> instance
771  
772 This action aborts a multipart upload. After a multipart upload is
773 aborted, no additional parts can be uploaded using that upload ID. The
774 storage consumed by any previously uploaded parts will be freed.
775 However, if any part uploads are currently in progress, those part
776 uploads might or might not succeed. As a result, it might be necessary
777 to abort a given multipart upload multiple times in order to completely
778 free all storage consumed by all parts.
779  
780 To verify that all parts have been removed, so you don't get charged
781 for the part storage, you should call the ListParts
782 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
783 action and ensure that the parts list is empty.
784  
785 For information about permissions required to use the multipart upload,
786 see Multipart Upload and Permissions
787 (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html).
788  
789 The following operations are related to C<AbortMultipartUpload>:
790  
791 =over
792  
793 =item *
794  
795 CreateMultipartUpload
796 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
797  
798 =item *
799  
800 UploadPart
801 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
802  
803 =item *
804  
805 CompleteMultipartUpload
806 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
807  
808 =item *
809  
810 ListParts
811 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
812  
813 =item *
814  
815 ListMultipartUploads
816 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
817  
818 =back
819  
820  
821  
822 =head2 CompleteMultipartUpload
823  
824 =over
825  
826 =item Bucket => Str
827  
828 =item Key => Str
829  
830 =item UploadId => Str
831  
832 =item [ExpectedBucketOwner => Str]
833  
834 =item [MultipartUpload => L<Paws::S3::CompletedMultipartUpload>]
835  
836 =item [RequestPayer => Str]
837  
838  
839 =back
840  
841 Each argument is described in detail in: L<Paws::S3::CompleteMultipartUpload>
842  
843 Returns: a L<Paws::S3::CompleteMultipartUploadOutput> instance
844  
845 Completes a multipart upload by assembling previously uploaded parts.
846  
847 You first initiate the multipart upload and then upload all parts using
848 the UploadPart
849 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
850 operation. After successfully uploading all relevant parts of an
851 upload, you call this action to complete the upload. Upon receiving
852 this request, Amazon S3 concatenates all the parts in ascending order
853 by part number to create a new object. In the Complete Multipart Upload
854 request, you must provide the parts list. You must ensure that the
855 parts list is complete. This action concatenates the parts that you
856 provide in the list. For each part in the list, you must provide the
857 part number and the C<ETag> value, returned after that part was
858 uploaded.
859  
860 Processing of a Complete Multipart Upload request could take several
861 minutes to complete. After Amazon S3 begins processing the request, it
862 sends an HTTP response header that specifies a 200 OK response. While
863 processing is in progress, Amazon S3 periodically sends white space
864 characters to keep the connection from timing out. Because a request
865 could fail after the initial 200 OK response has been sent, it is
866 important that you check the response body to determine whether the
867 request succeeded.
868  
869 Note that if C<CompleteMultipartUpload> fails, applications should be
870 prepared to retry the failed requests. For more information, see Amazon
871 S3 Error Best Practices
872 (https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html).
873  
874 For more information about multipart uploads, see Uploading Objects
875 Using Multipart Upload
876 (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html).
877  
878 For information about permissions required to use the multipart upload
879 API, see Multipart Upload and Permissions
880 (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html).
881  
882 C<CompleteMultipartUpload> has the following special errors:
883  
884 =over
885  
886 =item *
887  
888 Error code: C<EntityTooSmall>
889  
890 =over
891  
892 =item *
893  
894 Description: Your proposed upload is smaller than the minimum allowed
895 object size. Each part must be at least 5 MB in size, except the last
896 part.
897  
898 =item *
899  
900 400 Bad Request
901  
902 =back
903  
904 =item *
905  
906 Error code: C<InvalidPart>
907  
908 =over
909  
910 =item *
911  
912 Description: One or more of the specified parts could not be found. The
913 part might not have been uploaded, or the specified entity tag might
914 not have matched the part's entity tag.
915  
916 =item *
917  
918 400 Bad Request
919  
920 =back
921  
922 =item *
923  
924 Error code: C<InvalidPartOrder>
925  
926 =over
927  
928 =item *
929  
930 Description: The list of parts was not in ascending order. The parts
931 list must be specified in order by part number.
932  
933 =item *
934  
935 400 Bad Request
936  
937 =back
938  
939 =item *
940  
941 Error code: C<NoSuchUpload>
942  
943 =over
944  
945 =item *
946  
947 Description: The specified multipart upload does not exist. The upload
948 ID might be invalid, or the multipart upload might have been aborted or
949 completed.
950  
951 =item *
952  
953 404 Not Found
954  
955 =back
956  
957 =back
958  
959 The following operations are related to C<CompleteMultipartUpload>:
960  
961 =over
962  
963 =item *
964  
965 CreateMultipartUpload
966 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
967  
968 =item *
969  
970 UploadPart
971 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
972  
973 =item *
974  
975 AbortMultipartUpload
976 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
977  
978 =item *
979  
980 ListParts
981 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
982  
983 =item *
984  
985 ListMultipartUploads
986 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
987  
988 =back
989  
990  
991  
992 =head2 CopyObject
993  
994 =over
995  
996 =item Bucket => Str
997  
998 =item CopySource => Str
999  
1000 =item Key => Str
1001  
1002 =item [ACL => Str]
1003  
1004 =item [BucketKeyEnabled => Bool]
1005  
1006 =item [CacheControl => Str]
1007  
1008 =item [ContentDisposition => Str]
1009  
1010 =item [ContentEncoding => Str]
1011  
1012 =item [ContentLanguage => Str]
1013  
1014 =item [ContentType => Str]
1015  
1016 =item [CopySourceIfMatch => Str]
1017  
1018 =item [CopySourceIfModifiedSince => Str]
1019  
1020 =item [CopySourceIfNoneMatch => Str]
1021  
1022 =item [CopySourceIfUnmodifiedSince => Str]
1023  
1024 =item [CopySourceSSECustomerAlgorithm => Str]
1025  
1026 =item [CopySourceSSECustomerKey => Str]
1027  
1028 =item [CopySourceSSECustomerKeyMD5 => Str]
1029  
1030 =item [ExpectedBucketOwner => Str]
1031  
1032 =item [ExpectedSourceBucketOwner => Str]
1033  
1034 =item [Expires => Str]
1035  
1036 =item [GrantFullControl => Str]
1037  
1038 =item [GrantRead => Str]
1039  
1040 =item [GrantReadACP => Str]
1041  
1042 =item [GrantWriteACP => Str]
1043  
1044 =item [Metadata => L<Paws::S3::Metadata>]
1045  
1046 =item [MetadataDirective => Str]
1047  
1048 =item [ObjectLockLegalHoldStatus => Str]
1049  
1050 =item [ObjectLockMode => Str]
1051  
1052 =item [ObjectLockRetainUntilDate => Str]
1053  
1054 =item [RequestPayer => Str]
1055  
1056 =item [ServerSideEncryption => Str]
1057  
1058 =item [SSECustomerAlgorithm => Str]
1059  
1060 =item [SSECustomerKey => Str]
1061  
1062 =item [SSECustomerKeyMD5 => Str]
1063  
1064 =item [SSEKMSEncryptionContext => Str]
1065  
1066 =item [SSEKMSKeyId => Str]
1067  
1068 =item [StorageClass => Str]
1069  
1070 =item [Tagging => Str]
1071  
1072 =item [TaggingDirective => Str]
1073  
1074 =item [WebsiteRedirectLocation => Str]
1075  
1076  
1077 =back
1078  
1079 Each argument is described in detail in: L<Paws::S3::CopyObject>
1080  
1081 Returns: a L<Paws::S3::CopyObjectOutput> instance
1082  
1083 Creates a copy of an object that is already stored in Amazon S3.
1084  
1085 You can store individual objects of up to 5 TB in Amazon S3. You create
1086 a copy of your object up to 5 GB in size in a single atomic action
1087 using this API. However, to copy an object greater than 5 GB, you must
1088 use the multipart upload Upload Part - Copy API. For more information,
1089 see Copy Object Using the REST Multipart Upload API
1090 (https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html).
1091  
1092 All copy requests must be authenticated. Additionally, you must have
1093 I<read> access to the source object and I<write> access to the
1094 destination bucket. For more information, see REST Authentication
1095 (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html).
1096 Both the Region that you want to copy the object from and the Region
1097 that you want to copy the object to must be enabled for your account.
1098  
1099 A copy request might return an error when Amazon S3 receives the copy
1100 request or while Amazon S3 is copying the files. If the error occurs
1101 before the copy action starts, you receive a standard Amazon S3 error.
1102 If the error occurs during the copy operation, the error response is
1103 embedded in the C<200 OK> response. This means that a C<200 OK>
1104 response can contain either a success or an error. Design your
1105 application to parse the contents of the response and handle it
1106 appropriately.
1107  
1108 If the copy is successful, you receive a response with information
1109 about the copied object.
1110  
1111 If the request is an HTTP 1.1 request, the response is chunk encoded.
1112 If it were not, it would not contain the content-length, and you would
1113 need to read the entire body.
1114  
1115 The copy request charge is based on the storage class and Region that
1116 you specify for the destination object. For pricing information, see
1117 Amazon S3 pricing (http://aws.amazon.com/s3/pricing/).
1118  
1119 Amazon S3 transfer acceleration does not support cross-Region copies.
1120 If you request a cross-Region copy using a transfer acceleration
1121 endpoint, you get a 400 C<Bad Request> error. For more information, see
1122 Transfer Acceleration
1123 (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html).
1124  
1125 B<Metadata>
1126  
1127 When copying an object, you can preserve all metadata (default) or
1128 specify new metadata. However, the ACL is not preserved and is set to
1129 private for the user making the request. To override the default ACL
1130 setting, specify a new ACL when generating a copy request. For more
1131 information, see Using ACLs
1132 (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).
1133  
1134 To specify whether you want the object metadata copied from the source
1135 object or replaced with metadata provided in the request, you can
1136 optionally add the C<x-amz-metadata-directive> header. When you grant
1137 permissions, you can use the C<s3:x-amz-metadata-directive> condition
1138 key to enforce certain metadata behavior when objects are uploaded. For
1139 more information, see Specifying Conditions in a Policy
1140 (https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html)
1141 in the I<Amazon S3 User Guide>. For a complete list of Amazon
1142 S3-specific condition keys, see Actions, Resources, and Condition Keys
1143 for Amazon S3
1144 (https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html).
1145  
1146 B<C<x-amz-copy-source-if> Headers>
1147  
1148 To only copy an object under certain conditions, such as whether the
1149 C<Etag> matches or whether the object was modified before or after a
1150 specified date, use the following request parameters:
1151  
1152 =over
1153  
1154 =item *
1155  
1156 C<x-amz-copy-source-if-match>
1157  
1158 =item *
1159  
1160 C<x-amz-copy-source-if-none-match>
1161  
1162 =item *
1163  
1164 C<x-amz-copy-source-if-unmodified-since>
1165  
1166 =item *
1167  
1168 C<x-amz-copy-source-if-modified-since>
1169  
1170 =back
1171  
1172 If both the C<x-amz-copy-source-if-match> and
1173 C<x-amz-copy-source-if-unmodified-since> headers are present in the
1174 request and evaluate as follows, Amazon S3 returns C<200 OK> and copies
1175 the data:
1176  
1177 =over
1178  
1179 =item *
1180  
1181 C<x-amz-copy-source-if-match> condition evaluates to true
1182  
1183 =item *
1184  
1185 C<x-amz-copy-source-if-unmodified-since> condition evaluates to false
1186  
1187 =back
1188  
1189 If both the C<x-amz-copy-source-if-none-match> and
1190 C<x-amz-copy-source-if-modified-since> headers are present in the
1191 request and evaluate as follows, Amazon S3 returns the C<412
1192 Precondition Failed> response code:
1193  
1194 =over
1195  
1196 =item *
1197  
1198 C<x-amz-copy-source-if-none-match> condition evaluates to false
1199  
1200 =item *
1201  
1202 C<x-amz-copy-source-if-modified-since> condition evaluates to true
1203  
1204 =back
1205  
1206 All headers with the C<x-amz-> prefix, including C<x-amz-copy-source>,
1207 must be signed.
1208  
1209 B<Server-side encryption>
1210  
1211 When you perform a CopyObject operation, you can optionally use the
1212 appropriate encryption-related headers to encrypt the object using
1213 server-side encryption with AWS managed encryption keys (SSE-S3 or
1214 SSE-KMS) or a customer-provided encryption key. With server-side
1215 encryption, Amazon S3 encrypts your data as it writes it to disks in
1216 its data centers and decrypts the data when you access it. For more
1217 information about server-side encryption, see Using Server-Side
1218 Encryption
1219 (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html).
1220  
1221 If a target object uses SSE-KMS, you can enable an S3 Bucket Key for
1222 the object. For more information, see Amazon S3 Bucket Keys
1223 (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in
1224 the I<Amazon S3 User Guide>.
1225  
1226 B<Access Control List (ACL)-Specific Request Headers>
1227  
1228 When copying an object, you can optionally use headers to grant
1229 ACL-based permissions. By default, all objects are private. Only the
1230 owner has full access control. When adding a new object, you can grant
1231 permissions to individual AWS accounts or to predefined groups defined
1232 by Amazon S3. These permissions are then added to the ACL on the
1233 object. For more information, see Access Control List (ACL) Overview
1234 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) and
1235 Managing ACLs Using the REST API
1236 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html).
1237  
1238 B<Storage Class Options>
1239  
1240 You can use the C<CopyObject> action to change the storage class of an
1241 object that is already stored in Amazon S3 using the C<StorageClass>
1242 parameter. For more information, see Storage Classes
1243 (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html)
1244 in the I<Amazon S3 User Guide>.
1245  
1246 B<Versioning>
1247  
1248 By default, C<x-amz-copy-source> identifies the current version of an
1249 object to copy. If the current version is a delete marker, Amazon S3
1250 behaves as if the object was deleted. To copy a different version, use
1251 the C<versionId> subresource.
1252  
1253 If you enable versioning on the target bucket, Amazon S3 generates a
1254 unique version ID for the object being copied. This version ID is
1255 different from the version ID of the source object. Amazon S3 returns
1256 the version ID of the copied object in the C<x-amz-version-id> response
1257 header in the response.
1258  
1259 If you do not enable versioning or suspend it on the target bucket, the
1260 version ID that Amazon S3 generates is always null.
1261  
1262 If the source object's storage class is GLACIER, you must restore a
1263 copy of this object before you can use it as a source object for the
1264 copy operation. For more information, see RestoreObject
1265 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html).
1266  
1267 The following operations are related to C<CopyObject>:
1268  
1269 =over
1270  
1271 =item *
1272  
1273 PutObject
1274 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
1275  
1276 =item *
1277  
1278 GetObject
1279 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
1280  
1281 =back
1282  
1283 For more information, see Copying Objects
1284 (https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html).
1285  
1286  
1287 =head2 CreateBucket
1288  
1289 =over
1290  
1291 =item Bucket => Str
1292  
1293 =item [ACL => Str]
1294  
1295 =item [ContentLength => Int]
1296  
1297 =item [CreateBucketConfiguration => L<Paws::S3::CreateBucketConfiguration>]
1298  
1299 =item [GrantFullControl => Str]
1300  
1301 =item [GrantRead => Str]
1302  
1303 =item [GrantReadACP => Str]
1304  
1305 =item [GrantWrite => Str]
1306  
1307 =item [GrantWriteACP => Str]
1308  
1309 =item [ObjectLockEnabledForBucket => Bool]
1310  
1311  
1312 =back
1313  
1314 Each argument is described in detail in: L<Paws::S3::CreateBucket>
1315  
1316 Returns: a L<Paws::S3::CreateBucketOutput> instance
1317  
1318 Creates a new S3 bucket. To create a bucket, you must register with
1319 Amazon S3 and have a valid AWS Access Key ID to authenticate requests.
1320 Anonymous requests are never allowed to create buckets. By creating the
1321 bucket, you become the bucket owner.
1322  
1323 Not every string is an acceptable bucket name. For information about
1324 bucket naming restrictions, see Bucket naming rules
1325 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html).
1326  
1327 If you want to create an Amazon S3 on Outposts bucket, see Create
1328 Bucket
1329 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html).
1330  
1331 By default, the bucket is created in the US East (N. Virginia) Region.
1332 You can optionally specify a Region in the request body. You might
1333 choose a Region to optimize latency, minimize costs, or address
1334 regulatory requirements. For example, if you reside in Europe, you will
1335 probably find it advantageous to create buckets in the Europe (Ireland)
1336 Region. For more information, see Accessing a bucket
1337 (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro).
1338  
1339 If you send your create bucket request to the C<s3.amazonaws.com>
1340 endpoint, the request goes to the us-east-1 Region. Accordingly, the
1341 signature calculations in Signature Version 4 must use us-east-1 as the
1342 Region, even if the location constraint in the request specifies
1343 another Region where the bucket is to be created. If you create a
1344 bucket in a Region other than US East (N. Virginia), your application
1345 must be able to handle 307 redirect. For more information, see Virtual
1346 hosting of buckets
1347 (https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html).
1348  
1349 When creating a bucket using this operation, you can optionally specify
1350 the accounts or groups that should be granted specific permissions on
1351 the bucket. There are two ways to grant the appropriate permissions
1352 using the request headers.
1353  
1354 =over
1355  
1356 =item *
1357  
1358 Specify a canned ACL using the C<x-amz-acl> request header. Amazon S3
1359 supports a set of predefined ACLs, known as I<canned ACLs>. Each canned
1360 ACL has a predefined set of grantees and permissions. For more
1361 information, see Canned ACL
1362 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
1363  
1364 =item *
1365  
1366 Specify access permissions explicitly using the C<x-amz-grant-read>,
1367 C<x-amz-grant-write>, C<x-amz-grant-read-acp>,
1368 C<x-amz-grant-write-acp>, and C<x-amz-grant-full-control> headers.
1369 These headers map to the set of permissions Amazon S3 supports in an
1370 ACL. For more information, see Access control list (ACL) overview
1371 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html).
1372  
1373 You specify each grantee as a type=value pair, where the type is one of
1374 the following:
1375  
1376 =over
1377  
1378 =item *
1379  
1380 C<id> E<ndash> if the value specified is the canonical user ID of an
1381 AWS account
1382  
1383 =item *
1384  
1385 C<uri> E<ndash> if you are granting permissions to a predefined group
1386  
1387 =item *
1388  
1389 C<emailAddress> E<ndash> if the value specified is the email address of
1390 an AWS account
1391  
1392 Using email addresses to specify a grantee is only supported in the
1393 following AWS Regions:
1394  
1395 =over
1396  
1397 =item *
1398  
1399 US East (N. Virginia)
1400  
1401 =item *
1402  
1403 US West (N. California)
1404  
1405 =item *
1406  
1407 US West (Oregon)
1408  
1409 =item *
1410  
1411 Asia Pacific (Singapore)
1412  
1413 =item *
1414  
1415 Asia Pacific (Sydney)
1416  
1417 =item *
1418  
1419 Asia Pacific (Tokyo)
1420  
1421 =item *
1422  
1423 Europe (Ireland)
1424  
1425 =item *
1426  
1427 South America (SE<atilde>o Paulo)
1428  
1429 =back
1430  
1431 For a list of all the Amazon S3 supported Regions and endpoints, see
1432 Regions and Endpoints
1433 (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in
1434 the AWS General Reference.
1435  
1436 =back
1437  
1438 For example, the following C<x-amz-grant-read> header grants the AWS
1439 accounts identified by account IDs permissions to read object data and
1440 its metadata:
1441  
1442 C<x-amz-grant-read: id="11112222333", id="444455556666">
1443  
1444 =back
1445  
1446 You can use either a canned ACL or specify access permissions
1447 explicitly. You cannot do both.
1448  
1449 The following operations are related to C<CreateBucket>:
1450  
1451 =over
1452  
1453 =item *
1454  
1455 PutObject
1456 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
1457  
1458 =item *
1459  
1460 DeleteBucket
1461 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
1462  
1463 =back
1464  
1465  
1466  
1467 =head2 CreateMultipartUpload
1468  
1469 =over
1470  
1471 =item Bucket => Str
1472  
1473 =item Key => Str
1474  
1475 =item [ACL => Str]
1476  
1477 =item [BucketKeyEnabled => Bool]
1478  
1479 =item [CacheControl => Str]
1480  
1481 =item [ContentDisposition => Str]
1482  
1483 =item [ContentEncoding => Str]
1484  
1485 =item [ContentLanguage => Str]
1486  
1487 =item [ContentType => Str]
1488  
1489 =item [ExpectedBucketOwner => Str]
1490  
1491 =item [Expires => Str]
1492  
1493 =item [GrantFullControl => Str]
1494  
1495 =item [GrantRead => Str]
1496  
1497 =item [GrantReadACP => Str]
1498  
1499 =item [GrantWriteACP => Str]
1500  
1501 =item [Metadata => L<Paws::S3::Metadata>]
1502  
1503 =item [ObjectLockLegalHoldStatus => Str]
1504  
1505 =item [ObjectLockMode => Str]
1506  
1507 =item [ObjectLockRetainUntilDate => Str]
1508  
1509 =item [RequestPayer => Str]
1510  
1511 =item [ServerSideEncryption => Str]
1512  
1513 =item [SSECustomerAlgorithm => Str]
1514  
1515 =item [SSECustomerKey => Str]
1516  
1517 =item [SSECustomerKeyMD5 => Str]
1518  
1519 =item [SSEKMSEncryptionContext => Str]
1520  
1521 =item [SSEKMSKeyId => Str]
1522  
1523 =item [StorageClass => Str]
1524  
1525 =item [Tagging => Str]
1526  
1527 =item [WebsiteRedirectLocation => Str]
1528  
1529  
1530 =back
1531  
1532 Each argument is described in detail in: L<Paws::S3::CreateMultipartUpload>
1533  
1534 Returns: a L<Paws::S3::CreateMultipartUploadOutput> instance
1535  
1536 This action initiates a multipart upload and returns an upload ID. This
1537 upload ID is used to associate all of the parts in the specific
1538 multipart upload. You specify this upload ID in each of your subsequent
1539 upload part requests (see UploadPart
1540 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)).
1541 You also include this upload ID in the final request to either complete
1542 or abort the multipart upload request.
1543  
1544 For more information about multipart uploads, see Multipart Upload
1545 Overview
1546 (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html).
1547  
1548 If you have configured a lifecycle rule to abort incomplete multipart
1549 uploads, the upload must complete within the number of days specified
1550 in the bucket lifecycle configuration. Otherwise, the incomplete
1551 multipart upload becomes eligible for an abort action and Amazon S3
1552 aborts the multipart upload. For more information, see Aborting
1553 Incomplete Multipart Uploads Using a Bucket Lifecycle Policy
1554 (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config).
1555  
1556 For information about the permissions required to use the multipart
1557 upload API, see Multipart Upload and Permissions
1558 (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html).
1559  
1560 For request signing, multipart upload is just a series of regular
1561 requests. You initiate a multipart upload, send one or more requests to
1562 upload parts, and then complete the multipart upload process. You sign
1563 each request individually. There is nothing special about signing
1564 multipart upload requests. For more information about signing, see
1565 Authenticating Requests (AWS Signature Version 4)
1566 (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html).
1567  
1568 After you initiate a multipart upload and upload one or more parts, to
1569 stop being charged for storing the uploaded parts, you must either
1570 complete or abort the multipart upload. Amazon S3 frees up the space
1571 used to store the parts and stop charging you for storing them only
1572 after you either complete or abort a multipart upload.
1573  
1574 You can optionally request server-side encryption. For server-side
1575 encryption, Amazon S3 encrypts your data as it writes it to disks in
1576 its data centers and decrypts it when you access it. You can provide
1577 your own encryption key, or use AWS Key Management Service (AWS KMS)
1578 customer master keys (CMKs) or Amazon S3-managed encryption keys. If
1579 you choose to provide your own encryption key, the request headers you
1580 provide in UploadPart
1581 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
1582 and UploadPartCopy
1583 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)
1584 requests must match the headers you used in the request to initiate the
1585 upload by using C<CreateMultipartUpload>.
1586  
1587 To perform a multipart upload with encryption using an AWS KMS CMK, the
1588 requester must have permission to the C<kms:Decrypt> and
1589 C<kms:GenerateDataKey*> actions on the key. These permissions are
1590 required because Amazon S3 must decrypt and read data from the
1591 encrypted file parts before it completes the multipart upload. For more
1592 information, see Multipart upload API and permissions
1593 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions)
1594 in the I<Amazon S3 User Guide>.
1595  
1596 If your AWS Identity and Access Management (IAM) user or role is in the
1597 same AWS account as the AWS KMS CMK, then you must have these
1598 permissions on the key policy. If your IAM user or role belongs to a
1599 different account than the key, then you must have the permissions on
1600 both the key policy and your IAM user or role.
1601  
1602 For more information, see Protecting Data Using Server-Side Encryption
1603 (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html).
1604  
1605 =over
1606  
1607 =item Access Permissions
1608  
1609 When copying an object, you can optionally specify the accounts or
1610 groups that should be granted specific permissions on the new object.
1611 There are two ways to grant the permissions using the request headers:
1612  
1613 =over
1614  
1615 =item *
1616  
1617 Specify a canned ACL with the C<x-amz-acl> request header. For more
1618 information, see Canned ACL
1619 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
1620  
1621 =item *
1622  
1623 Specify access permissions explicitly with the C<x-amz-grant-read>,
1624 C<x-amz-grant-read-acp>, C<x-amz-grant-write-acp>, and
1625 C<x-amz-grant-full-control> headers. These parameters map to the set of
1626 permissions that Amazon S3 supports in an ACL. For more information,
1627 see Access Control List (ACL) Overview
1628 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html).
1629  
1630 =back
1631  
1632 You can use either a canned ACL or specify access permissions
1633 explicitly. You cannot do both.
1634  
1635 =item Server-Side- Encryption-Specific Request Headers
1636  
1637 You can optionally tell Amazon S3 to encrypt data at rest using
1638 server-side encryption. Server-side encryption is for data encryption
1639 at rest. Amazon S3 encrypts your data as it writes it to disks in its
1640 data centers and decrypts it when you access it. The option you use
1641 depends on whether you want to use AWS managed encryption keys or
1642 provide your own encryption key.
1643  
1644 =over
1645  
1646 =item *
1647  
1648 Use encryption keys managed by Amazon S3 or customer master keys (CMKs)
1649 stored in AWS Key Management Service (AWS KMS) E<ndash> If you want AWS
1650 to manage the keys used to encrypt data, specify the following headers
1651 in the request.
1652  
1653 =over
1654  
1655 =item *
1656  
1657 x-amz-server-side-encryption
1658  
1659 =item *
1660  
1661 x-amz-server-side-encryption-aws-kms-key-id
1662  
1663 =item *
1664  
1665 x-amz-server-side-encryption-context
1666  
1667 =back
1668  
1669 If you specify C<x-amz-server-side-encryption:aws:kms>, but don't
1670 provide C<x-amz-server-side-encryption-aws-kms-key-id>, Amazon S3 uses
1671 the AWS managed CMK in AWS KMS to protect the data.
1672  
1673 All GET and PUT requests for an object protected by AWS KMS fail if you
1674 don't make them with SSL or by using SigV4.
1675  
1676 For more information about server-side encryption with CMKs stored in
1677 AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption
1678 with CMKs stored in AWS KMS
1679 (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html).
1680  
1681 =item *
1682  
1683 Use customer-provided encryption keys E<ndash> If you want to manage
1684 your own encryption keys, provide all the following headers in the
1685 request.
1686  
1687 =over
1688  
1689 =item *
1690  
1691 x-amz-server-side-encryption-customer-algorithm
1692  
1693 =item *
1694  
1695 x-amz-server-side-encryption-customer-key
1696  
1697 =item *
1698  
1699 x-amz-server-side-encryption-customer-key-MD5
1700  
1701 =back
1702  
1703 For more information about server-side encryption with CMKs stored in
1704 AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption
1705 with CMKs stored in AWS KMS
1706 (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html).
1707  
1708 =back
1709  
1710 =item Access-Control-List (ACL)-Specific Request Headers
1711  
1712 You also can use the following access controlE<ndash>related headers
1713 with this operation. By default, all objects are private. Only the
1714 owner has full access control. When adding a new object, you can grant
1715 permissions to individual AWS accounts or to predefined groups defined
1716 by Amazon S3. These permissions are then added to the access control
1717 list (ACL) on the object. For more information, see Using ACLs
1718 (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).
1719 With this operation, you can grant access permissions using one of the
1720 following two methods:
1721  
1722 =over
1723  
1724 =item *
1725  
1726 Specify a canned ACL (C<x-amz-acl>) E<mdash> Amazon S3 supports a set
1727 of predefined ACLs, known as I<canned ACLs>. Each canned ACL has a
1728 predefined set of grantees and permissions. For more information, see
1729 Canned ACL
1730 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
1731  
1732 =item *
1733  
1734 Specify access permissions explicitly E<mdash> To explicitly grant
1735 access permissions to specific AWS accounts or groups, use the
1736 following headers. Each header maps to specific permissions that Amazon
1737 S3 supports in an ACL. For more information, see Access Control List
1738 (ACL) Overview
1739 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). In
1740 the header, you specify a list of grantees who get the specific
1741 permission. To grant permissions explicitly, use:
1742  
1743 =over
1744  
1745 =item *
1746  
1747 x-amz-grant-read
1748  
1749 =item *
1750  
1751 x-amz-grant-write
1752  
1753 =item *
1754  
1755 x-amz-grant-read-acp
1756  
1757 =item *
1758  
1759 x-amz-grant-write-acp
1760  
1761 =item *
1762  
1763 x-amz-grant-full-control
1764  
1765 =back
1766  
1767 You specify each grantee as a type=value pair, where the type is one of
1768 the following:
1769  
1770 =over
1771  
1772 =item *
1773  
1774 C<id> E<ndash> if the value specified is the canonical user ID of an
1775 AWS account
1776  
1777 =item *
1778  
1779 C<uri> E<ndash> if you are granting permissions to a predefined group
1780  
1781 =item *
1782  
1783 C<emailAddress> E<ndash> if the value specified is the email address of
1784 an AWS account
1785  
1786 Using email addresses to specify a grantee is only supported in the
1787 following AWS Regions:
1788  
1789 =over
1790  
1791 =item *
1792  
1793 US East (N. Virginia)
1794  
1795 =item *
1796  
1797 US West (N. California)
1798  
1799 =item *
1800  
1801 US West (Oregon)
1802  
1803 =item *
1804  
1805 Asia Pacific (Singapore)
1806  
1807 =item *
1808  
1809 Asia Pacific (Sydney)
1810  
1811 =item *
1812  
1813 Asia Pacific (Tokyo)
1814  
1815 =item *
1816  
1817 Europe (Ireland)
1818  
1819 =item *
1820  
1821 South America (SE<atilde>o Paulo)
1822  
1823 =back
1824  
1825 For a list of all the Amazon S3 supported Regions and endpoints, see
1826 Regions and Endpoints
1827 (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in
1828 the AWS General Reference.
1829  
1830 =back
1831  
1832 For example, the following C<x-amz-grant-read> header grants the AWS
1833 accounts identified by account IDs permissions to read object data and
1834 its metadata:
1835  
1836 C<x-amz-grant-read: id="11112222333", id="444455556666">
1837  
1838 =back
1839  
1840 =back
1841  
1842 The following operations are related to C<CreateMultipartUpload>:
1843  
1844 =over
1845  
1846 =item *
1847  
1848 UploadPart
1849 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
1850  
1851 =item *
1852  
1853 CompleteMultipartUpload
1854 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
1855  
1856 =item *
1857  
1858 AbortMultipartUpload
1859 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
1860  
1861 =item *
1862  
1863 ListParts
1864 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
1865  
1866 =item *
1867  
1868 ListMultipartUploads
1869 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
1870  
1871 =back
1872  
1873  
1874  
1875 =head2 DeleteBucket
1876  
1877 =over
1878  
1879 =item Bucket => Str
1880  
1881 =item [ExpectedBucketOwner => Str]
1882  
1883  
1884 =back
1885  
1886 Each argument is described in detail in: L<Paws::S3::DeleteBucket>
1887  
1888 Returns: nothing
1889  
1890 Deletes the S3 bucket. All objects (including all object versions and
1891 delete markers) in the bucket must be deleted before the bucket itself
1892 can be deleted.
1893  
1894 B<Related Resources>
1895  
1896 =over
1897  
1898 =item *
1899  
1900 CreateBucket
1901 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
1902  
1903 =item *
1904  
1905 DeleteObject
1906 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
1907  
1908 =back
1909  
1910  
1911  
1912 =head2 DeleteBucketAnalyticsConfiguration
1913  
1914 =over
1915  
1916 =item Bucket => Str
1917  
1918 =item Id => Str
1919  
1920 =item [ExpectedBucketOwner => Str]
1921  
1922  
1923 =back
1924  
1925 Each argument is described in detail in: L<Paws::S3::DeleteBucketAnalyticsConfiguration>
1926  
1927 Returns: nothing
1928  
1929 Deletes an analytics configuration for the bucket (specified by the
1930 analytics configuration ID).
1931  
1932 To use this operation, you must have permissions to perform the
1933 C<s3:PutAnalyticsConfiguration> action. The bucket owner has this
1934 permission by default. The bucket owner can grant this permission to
1935 others. For more information about permissions, see Permissions Related
1936 to Bucket Subresource Operations
1937 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
1938 and Managing Access Permissions to Your Amazon S3 Resources
1939 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
1940  
1941 For information about the Amazon S3 analytics feature, see Amazon S3
1942 Analytics E<ndash> Storage Class Analysis
1943 (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html).
1944  
1945 The following operations are related to
1946 C<DeleteBucketAnalyticsConfiguration>:
1947  
1948 =over
1949  
1950 =item *
1951  
1952 GetBucketAnalyticsConfiguration
1953 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html)
1954  
1955 =item *
1956  
1957 ListBucketAnalyticsConfigurations
1958 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html)
1959  
1960 =item *
1961  
1962 PutBucketAnalyticsConfiguration
1963 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html)
1964  
1965 =back
1966  
1967  
1968  
1969 =head2 DeleteBucketCors
1970  
1971 =over
1972  
1973 =item Bucket => Str
1974  
1975 =item [ExpectedBucketOwner => Str]
1976  
1977  
1978 =back
1979  
1980 Each argument is described in detail in: L<Paws::S3::DeleteBucketCors>
1981  
1982 Returns: nothing
1983  
1984 Deletes the C<cors> configuration information set for the bucket.
1985  
1986 To use this operation, you must have permission to perform the
1987 C<s3:PutBucketCORS> action. The bucket owner has this permission by
1988 default and can grant this permission to others.
1989  
1990 For information about C<cors>, see Enabling Cross-Origin Resource
1991 Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in
1992 the I<Amazon S3 User Guide>.
1993  
1994 B<Related Resources:>
1995  
1996 =over
1997  
1998 =item *
1999  
2000 PutBucketCors
2001 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html)
2002  
2003 =item *
2004  
2005 RESTOPTIONSobject
2006 (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html)
2007  
2008 =back
2009  
2010  
2011  
2012 =head2 DeleteBucketEncryption
2013  
2014 =over
2015  
2016 =item Bucket => Str
2017  
2018 =item [ExpectedBucketOwner => Str]
2019  
2020  
2021 =back
2022  
2023 Each argument is described in detail in: L<Paws::S3::DeleteBucketEncryption>
2024  
2025 Returns: nothing
2026  
2027 This implementation of the DELETE action removes default encryption
2028 from the bucket. For information about the Amazon S3 default encryption
2029 feature, see Amazon S3 Default Bucket Encryption
2030 (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html)
2031 in the I<Amazon S3 User Guide>.
2032  
2033 To use this operation, you must have permissions to perform the
2034 C<s3:PutEncryptionConfiguration> action. The bucket owner has this
2035 permission by default. The bucket owner can grant this permission to
2036 others. For more information about permissions, see Permissions Related
2037 to Bucket Subresource Operations
2038 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
2039 and Managing Access Permissions to your Amazon S3 Resources
2040 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
2041 in the I<Amazon S3 User Guide>.
2042  
2043 B<Related Resources>
2044  
2045 =over
2046  
2047 =item *
2048  
2049 PutBucketEncryption
2050 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html)
2051  
2052 =item *
2053  
2054 GetBucketEncryption
2055 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html)
2056  
2057 =back
2058  
2059  
2060  
2061 =head2 DeleteBucketIntelligentTieringConfiguration
2062  
2063 =over
2064  
2065 =item Bucket => Str
2066  
2067 =item Id => Str
2068  
2069  
2070 =back
2071  
2072 Each argument is described in detail in: L<Paws::S3::DeleteBucketIntelligentTieringConfiguration>
2073  
2074 Returns: nothing
2075  
2076 Deletes the S3 Intelligent-Tiering configuration from the specified
2077 bucket.
2078  
2079 The S3 Intelligent-Tiering storage class is designed to optimize
2080 storage costs by automatically moving data to the most cost-effective
2081 storage access tier, without additional operational overhead. S3
2082 Intelligent-Tiering delivers automatic cost savings by moving data
2083 between access tiers, when access patterns change.
2084  
2085 The S3 Intelligent-Tiering storage class is suitable for objects larger
2086 than 128 KB that you plan to store for at least 30 days. If the size of
2087 an object is less than 128 KB, it is not eligible for auto-tiering.
2088 Smaller objects can be stored, but they are always charged at the
2089 frequent access tier rates in the S3 Intelligent-Tiering storage class.
2090  
2091 If you delete an object before the end of the 30-day minimum storage
2092 duration period, you are charged for 30 days. For more information, see
2093 Storage class for automatically optimizing frequently and infrequently
2094 accessed objects
2095 (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
2096  
2097 Operations related to C<DeleteBucketIntelligentTieringConfiguration>
2098 include:
2099  
2100 =over
2101  
2102 =item *
2103  
2104 GetBucketIntelligentTieringConfiguration
2105 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html)
2106  
2107 =item *
2108  
2109 PutBucketIntelligentTieringConfiguration
2110 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html)
2111  
2112 =item *
2113  
2114 ListBucketIntelligentTieringConfigurations
2115 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html)
2116  
2117 =back
2118  
2119  
2120  
2121 =head2 DeleteBucketInventoryConfiguration
2122  
2123 =over
2124  
2125 =item Bucket => Str
2126  
2127 =item Id => Str
2128  
2129 =item [ExpectedBucketOwner => Str]
2130  
2131  
2132 =back
2133  
2134 Each argument is described in detail in: L<Paws::S3::DeleteBucketInventoryConfiguration>
2135  
2136 Returns: nothing
2137  
2138 Deletes an inventory configuration (identified by the inventory ID)
2139 from the bucket.
2140  
2141 To use this operation, you must have permissions to perform the
2142 C<s3:PutInventoryConfiguration> action. The bucket owner has this
2143 permission by default. The bucket owner can grant this permission to
2144 others. For more information about permissions, see Permissions Related
2145 to Bucket Subresource Operations
2146 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
2147 and Managing Access Permissions to Your Amazon S3 Resources
2148 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
2149  
2150 For information about the Amazon S3 inventory feature, see Amazon S3
2151 Inventory
2152 (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html).
2153  
2154 Operations related to C<DeleteBucketInventoryConfiguration> include:
2155  
2156 =over
2157  
2158 =item *
2159  
2160 GetBucketInventoryConfiguration
2161 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html)
2162  
2163 =item *
2164  
2165 PutBucketInventoryConfiguration
2166 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html)
2167  
2168 =item *
2169  
2170 ListBucketInventoryConfigurations
2171 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html)
2172  
2173 =back
2174  
2175  
2176  
2177 =head2 DeleteBucketLifecycle
2178  
2179 =over
2180  
2181 =item Bucket => Str
2182  
2183 =item [ExpectedBucketOwner => Str]
2184  
2185  
2186 =back
2187  
2188 Each argument is described in detail in: L<Paws::S3::DeleteBucketLifecycle>
2189  
2190 Returns: nothing
2191  
2192 Deletes the lifecycle configuration from the specified bucket. Amazon
2193 S3 removes all the lifecycle configuration rules in the lifecycle
2194 subresource associated with the bucket. Your objects never expire, and
2195 Amazon S3 no longer automatically deletes any objects on the basis of
2196 rules contained in the deleted lifecycle configuration.
2197  
2198 To use this operation, you must have permission to perform the
2199 C<s3:PutLifecycleConfiguration> action. By default, the bucket owner
2200 has this permission and the bucket owner can grant this permission to
2201 others.
2202  
2203 There is usually some time lag before lifecycle configuration deletion
2204 is fully propagated to all the Amazon S3 systems.
2205  
2206 For more information about the object expiration, see Elements to
2207 Describe Lifecycle Actions
2208 (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions).
2209  
2210 Related actions include:
2211  
2212 =over
2213  
2214 =item *
2215  
2216 PutBucketLifecycleConfiguration
2217 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)
2218  
2219 =item *
2220  
2221 GetBucketLifecycleConfiguration
2222 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)
2223  
2224 =back
2225  
2226  
2227  
2228 =head2 DeleteBucketMetricsConfiguration
2229  
2230 =over
2231  
2232 =item Bucket => Str
2233  
2234 =item Id => Str
2235  
2236 =item [ExpectedBucketOwner => Str]
2237  
2238  
2239 =back
2240  
2241 Each argument is described in detail in: L<Paws::S3::DeleteBucketMetricsConfiguration>
2242  
2243 Returns: nothing
2244  
2245 Deletes a metrics configuration for the Amazon CloudWatch request
2246 metrics (specified by the metrics configuration ID) from the bucket.
2247 Note that this doesn't include the daily storage metrics.
2248  
2249 To use this operation, you must have permissions to perform the
2250 C<s3:PutMetricsConfiguration> action. The bucket owner has this
2251 permission by default. The bucket owner can grant this permission to
2252 others. For more information about permissions, see Permissions Related
2253 to Bucket Subresource Operations
2254 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
2255 and Managing Access Permissions to Your Amazon S3 Resources
2256 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
2257  
2258 For information about CloudWatch request metrics for Amazon S3, see
2259 Monitoring Metrics with Amazon CloudWatch
2260 (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).
2261  
2262 The following operations are related to
2263 C<DeleteBucketMetricsConfiguration>:
2264  
2265 =over
2266  
2267 =item *
2268  
2269 GetBucketMetricsConfiguration
2270 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html)
2271  
2272 =item *
2273  
2274 PutBucketMetricsConfiguration
2275 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html)
2276  
2277 =item *
2278  
2279 ListBucketMetricsConfigurations
2280 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html)
2281  
2282 =item *
2283  
2284 Monitoring Metrics with Amazon CloudWatch
2285 (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html)
2286  
2287 =back
2288  
2289  
2290  
2291 =head2 DeleteBucketOwnershipControls
2292  
2293 =over
2294  
2295 =item Bucket => Str
2296  
2297 =item [ExpectedBucketOwner => Str]
2298  
2299  
2300 =back
2301  
2302 Each argument is described in detail in: L<Paws::S3::DeleteBucketOwnershipControls>
2303  
2304 Returns: nothing
2305  
2306 Removes C<OwnershipControls> for an Amazon S3 bucket. To use this
2307 operation, you must have the C<s3:PutBucketOwnershipControls>
2308 permission. For more information about Amazon S3 permissions, see
2309 Specifying Permissions in a Policy
2310 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
2311  
2312 For information about Amazon S3 Object Ownership, see Using Object
2313 Ownership
2314 (https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html).
2315  
2316 The following operations are related to
2317 C<DeleteBucketOwnershipControls>:
2318  
2319 =over
2320  
2321 =item *
2322  
2323 GetBucketOwnershipControls
2324  
2325 =item *
2326  
2327 PutBucketOwnershipControls
2328  
2329 =back
2330  
2331  
2332  
2333 =head2 DeleteBucketPolicy
2334  
2335 =over
2336  
2337 =item Bucket => Str
2338  
2339 =item [ExpectedBucketOwner => Str]
2340  
2341  
2342 =back
2343  
2344 Each argument is described in detail in: L<Paws::S3::DeleteBucketPolicy>
2345  
2346 Returns: nothing
2347  
2348 This implementation of the DELETE action uses the policy subresource to
2349 delete the policy of a specified bucket. If you are using an identity
2350 other than the root user of the AWS account that owns the bucket, the
2351 calling identity must have the C<DeleteBucketPolicy> permissions on the
2352 specified bucket and belong to the bucket owner's account to use this
2353 operation.
2354  
2355 If you don't have C<DeleteBucketPolicy> permissions, Amazon S3 returns
2356 a C<403 Access Denied> error. If you have the correct permissions, but
2357 you're not using an identity that belongs to the bucket owner's
2358 account, Amazon S3 returns a C<405 Method Not Allowed> error.
2359  
2360 As a security precaution, the root user of the AWS account that owns a
2361 bucket can always use this operation, even if the policy explicitly
2362 denies the root user the ability to perform this action.
2363  
2364 For more information about bucket policies, see Using Bucket Policies
2365 and UserPolicies
2366 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).
2367  
2368 The following operations are related to C<DeleteBucketPolicy>
2369  
2370 =over
2371  
2372 =item *
2373  
2374 CreateBucket
2375 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
2376  
2377 =item *
2378  
2379 DeleteObject
2380 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
2381  
2382 =back
2383  
2384  
2385  
2386 =head2 DeleteBucketReplication
2387  
2388 =over
2389  
2390 =item Bucket => Str
2391  
2392 =item [ExpectedBucketOwner => Str]
2393  
2394  
2395 =back
2396  
2397 Each argument is described in detail in: L<Paws::S3::DeleteBucketReplication>
2398  
2399 Returns: nothing
2400  
2401 Deletes the replication configuration from the bucket.
2402  
2403 To use this operation, you must have permissions to perform the
2404 C<s3:PutReplicationConfiguration> action. The bucket owner has these
2405 permissions by default and can grant it to others. For more information
2406 about permissions, see Permissions Related to Bucket Subresource
2407 Operations
2408 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
2409 and Managing Access Permissions to Your Amazon S3 Resources
2410 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
2411  
2412 It can take a while for the deletion of a replication configuration to
2413 fully propagate.
2414  
2415 For information about replication configuration, see Replication
2416 (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in
2417 the I<Amazon S3 User Guide>.
2418  
2419 The following operations are related to C<DeleteBucketReplication>:
2420  
2421 =over
2422  
2423 =item *
2424  
2425 PutBucketReplication
2426 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html)
2427  
2428 =item *
2429  
2430 GetBucketReplication
2431 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html)
2432  
2433 =back
2434  
2435  
2436  
2437 =head2 DeleteBucketTagging
2438  
2439 =over
2440  
2441 =item Bucket => Str
2442  
2443 =item [ExpectedBucketOwner => Str]
2444  
2445  
2446 =back
2447  
2448 Each argument is described in detail in: L<Paws::S3::DeleteBucketTagging>
2449  
2450 Returns: nothing
2451  
2452 Deletes the tags from the bucket.
2453  
2454 To use this operation, you must have permission to perform the
2455 C<s3:PutBucketTagging> action. By default, the bucket owner has this
2456 permission and can grant this permission to others.
2457  
2458 The following operations are related to C<DeleteBucketTagging>:
2459  
2460 =over
2461  
2462 =item *
2463  
2464 GetBucketTagging
2465 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html)
2466  
2467 =item *
2468  
2469 PutBucketTagging
2470 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html)
2471  
2472 =back
2473  
2474  
2475  
2476 =head2 DeleteBucketWebsite
2477  
2478 =over
2479  
2480 =item Bucket => Str
2481  
2482 =item [ExpectedBucketOwner => Str]
2483  
2484  
2485 =back
2486  
2487 Each argument is described in detail in: L<Paws::S3::DeleteBucketWebsite>
2488  
2489 Returns: nothing
2490  
2491 This action removes the website configuration for a bucket. Amazon S3
2492 returns a C<200 OK> response upon successfully deleting a website
2493 configuration on the specified bucket. You will get a C<200 OK>
2494 response if the website configuration you are trying to delete does not
2495 exist on the bucket. Amazon S3 returns a C<404> response if the bucket
2496 specified in the request does not exist.
2497  
2498 This DELETE action requires the C<S3:DeleteBucketWebsite> permission.
2499 By default, only the bucket owner can delete the website configuration
2500 attached to a bucket. However, bucket owners can grant other users
2501 permission to delete the website configuration by writing a bucket
2502 policy granting them the C<S3:DeleteBucketWebsite> permission.
2503  
2504 For more information about hosting websites, see Hosting Websites on
2505 Amazon S3
2506 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
2507  
2508 The following operations are related to C<DeleteBucketWebsite>:
2509  
2510 =over
2511  
2512 =item *
2513  
2514 GetBucketWebsite
2515 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html)
2516  
2517 =item *
2518  
2519 PutBucketWebsite
2520 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html)
2521  
2522 =back
2523  
2524  
2525  
2526 =head2 DeleteObject
2527  
2528 =over
2529  
2530 =item Bucket => Str
2531  
2532 =item Key => Str
2533  
2534 =item [BypassGovernanceRetention => Bool]
2535  
2536 =item [ExpectedBucketOwner => Str]
2537  
2538 =item [MFA => Str]
2539  
2540 =item [RequestPayer => Str]
2541  
2542 =item [VersionId => Str]
2543  
2544  
2545 =back
2546  
2547 Each argument is described in detail in: L<Paws::S3::DeleteObject>
2548  
2549 Returns: a L<Paws::S3::DeleteObjectOutput> instance
2550  
2551 Removes the null version (if there is one) of an object and inserts a
2552 delete marker, which becomes the latest version of the object. If there
2553 isn't a null version, Amazon S3 does not remove any objects but will
2554 still respond that the command was successful.
2555  
2556 To remove a specific version, you must be the bucket owner and you must
2557 use the version Id subresource. Using this subresource permanently
2558 deletes the version. If the object deleted is a delete marker, Amazon
2559 S3 sets the response header, C<x-amz-delete-marker>, to true.
2560  
2561 If the object you want to delete is in a bucket where the bucket
2562 versioning configuration is MFA Delete enabled, you must include the
2563 C<x-amz-mfa> request header in the DELETE C<versionId> request.
2564 Requests that include C<x-amz-mfa> must use HTTPS.
2565  
2566 For more information about MFA Delete, see Using MFA Delete
2567 (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html).
2568 To see sample requests that use versioning, see Sample Request
2569 (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete).
2570  
2571 You can delete objects by explicitly calling DELETE Object or configure
2572 its lifecycle (PutBucketLifecycle
2573 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html))
2574 to enable Amazon S3 to remove them for you. If you want to block users
2575 or accounts from removing or deleting objects from your bucket, you
2576 must deny them the C<s3:DeleteObject>, C<s3:DeleteObjectVersion>, and
2577 C<s3:PutLifeCycleConfiguration> actions.
2578  
2579 The following action is related to C<DeleteObject>:
2580  
2581 =over
2582  
2583 =item *
2584  
2585 PutObject
2586 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
2587  
2588 =back
2589  
2590  
2591  
2592 =head2 DeleteObjects
2593  
2594 =over
2595  
2596 =item Bucket => Str
2597  
2598 =item Delete => L<Paws::S3::Delete>
2599  
2600 =item [BypassGovernanceRetention => Bool]
2601  
2602 =item [ContentLength => Int]
2603  
2604 =item [ContentMD5 => Str]
2605  
2606 =item [ExpectedBucketOwner => Str]
2607  
2608 =item [MFA => Str]
2609  
2610 =item [RequestPayer => Str]
2611  
2612  
2613 =back
2614  
2615 Each argument is described in detail in: L<Paws::S3::DeleteObjects>
2616  
2617 Returns: a L<Paws::S3::DeleteObjectsOutput> instance
2618  
2619 This action enables you to delete multiple objects from a bucket using
2620 a single HTTP request. If you know the object keys that you want to
2621 delete, then this action provides a suitable alternative to sending
2622 individual delete requests, reducing per-request overhead.
2623  
2624 The request contains a list of up to 1000 keys that you want to delete.
2625 In the XML, you provide the object key names, and optionally, version
2626 IDs if you want to delete a specific version of the object from a
2627 versioning-enabled bucket. For each key, Amazon S3 performs a delete
2628 action and returns the result of that delete, success, or failure, in
2629 the response. Note that if the object specified in the request is not
2630 found, Amazon S3 returns the result as deleted.
2631  
2632 The action supports two modes for the response: verbose and quiet. By
2633 default, the action uses verbose mode in which the response includes
2634 the result of deletion of each key in your request. In quiet mode the
2635 response includes only keys where the delete action encountered an
2636 error. For a successful deletion, the action does not return any
2637 information about the delete in the response body.
2638  
2639 When performing this action on an MFA Delete enabled bucket, that
2640 attempts to delete any versioned objects, you must include an MFA
2641 token. If you do not provide one, the entire request will fail, even if
2642 there are non-versioned objects you are trying to delete. If you
2643 provide an invalid token, whether there are versioned keys in the
2644 request or not, the entire Multi-Object Delete request will fail. For
2645 information about MFA Delete, see MFA Delete
2646 (https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete).
2647  
2648 Finally, the Content-MD5 header is required for all Multi-Object Delete
2649 requests. Amazon S3 uses the header value to ensure that your request
2650 body has not been altered in transit.
2651  
2652 The following operations are related to C<DeleteObjects>:
2653  
2654 =over
2655  
2656 =item *
2657  
2658 CreateMultipartUpload
2659 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
2660  
2661 =item *
2662  
2663 UploadPart
2664 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
2665  
2666 =item *
2667  
2668 CompleteMultipartUpload
2669 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
2670  
2671 =item *
2672  
2673 ListParts
2674 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
2675  
2676 =item *
2677  
2678 AbortMultipartUpload
2679 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
2680  
2681 =back
2682  
2683  
2684  
2685 =head2 DeleteObjectTagging
2686  
2687 =over
2688  
2689 =item Bucket => Str
2690  
2691 =item Key => Str
2692  
2693 =item [ExpectedBucketOwner => Str]
2694  
2695 =item [VersionId => Str]
2696  
2697  
2698 =back
2699  
2700 Each argument is described in detail in: L<Paws::S3::DeleteObjectTagging>
2701  
2702 Returns: a L<Paws::S3::DeleteObjectTaggingOutput> instance
2703  
2704 Removes the entire tag set from the specified object. For more
2705 information about managing object tags, see Object Tagging
2706 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html).
2707  
2708 To use this operation, you must have permission to perform the
2709 C<s3:DeleteObjectTagging> action.
2710  
2711 To delete tags of a specific object version, add the C<versionId> query
2712 parameter in the request. You will need permission for the
2713 C<s3:DeleteObjectVersionTagging> action.
2714  
2715 The following operations are related to
2716 C<DeleteBucketMetricsConfiguration>:
2717  
2718 =over
2719  
2720 =item *
2721  
2722 PutObjectTagging
2723 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html)
2724  
2725 =item *
2726  
2727 GetObjectTagging
2728 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html)
2729  
2730 =back
2731  
2732  
2733  
2734 =head2 DeletePublicAccessBlock
2735  
2736 =over
2737  
2738 =item Bucket => Str
2739  
2740 =item [ExpectedBucketOwner => Str]
2741  
2742  
2743 =back
2744  
2745 Each argument is described in detail in: L<Paws::S3::DeletePublicAccessBlock>
2746  
2747 Returns: nothing
2748  
2749 Removes the C<PublicAccessBlock> configuration for an Amazon S3 bucket.
2750 To use this operation, you must have the
2751 C<s3:PutBucketPublicAccessBlock> permission. For more information about
2752 permissions, see Permissions Related to Bucket Subresource Operations
2753 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
2754 and Managing Access Permissions to Your Amazon S3 Resources
2755 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
2756  
2757 The following operations are related to C<DeletePublicAccessBlock>:
2758  
2759 =over
2760  
2761 =item *
2762  
2763 Using Amazon S3 Block Public Access
2764 (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html)
2765  
2766 =item *
2767  
2768 GetPublicAccessBlock
2769 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html)
2770  
2771 =item *
2772  
2773 PutPublicAccessBlock
2774 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html)
2775  
2776 =item *
2777  
2778 GetBucketPolicyStatus
2779 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html)
2780  
2781 =back
2782  
2783  
2784  
2785 =head2 GetBucketAccelerateConfiguration
2786  
2787 =over
2788  
2789 =item Bucket => Str
2790  
2791 =item [ExpectedBucketOwner => Str]
2792  
2793  
2794 =back
2795  
2796 Each argument is described in detail in: L<Paws::S3::GetBucketAccelerateConfiguration>
2797  
2798 Returns: a L<Paws::S3::GetBucketAccelerateConfigurationOutput> instance
2799  
2800 This implementation of the GET action uses the C<accelerate>
2801 subresource to return the Transfer Acceleration state of a bucket,
2802 which is either C<Enabled> or C<Suspended>. Amazon S3 Transfer
2803 Acceleration is a bucket-level feature that enables you to perform
2804 faster data transfers to and from Amazon S3.
2805  
2806 To use this operation, you must have permission to perform the
2807 C<s3:GetAccelerateConfiguration> action. The bucket owner has this
2808 permission by default. The bucket owner can grant this permission to
2809 others. For more information about permissions, see Permissions Related
2810 to Bucket Subresource Operations
2811 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
2812 and Managing Access Permissions to your Amazon S3 Resources
2813 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
2814 in the I<Amazon S3 User Guide>.
2815  
2816 You set the Transfer Acceleration state of an existing bucket to
2817 C<Enabled> or C<Suspended> by using the
2818 PutBucketAccelerateConfiguration
2819 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html)
2820 operation.
2821  
2822 A GET C<accelerate> request does not return a state value for a bucket
2823 that has no transfer acceleration state. A bucket has no Transfer
2824 Acceleration state if a state has never been set on the bucket.
2825  
2826 For more information about transfer acceleration, see Transfer
2827 Acceleration
2828 (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html)
2829 in the Amazon S3 User Guide.
2830  
2831 B<Related Resources>
2832  
2833 =over
2834  
2835 =item *
2836  
2837 PutBucketAccelerateConfiguration
2838 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html)
2839  
2840 =back
2841  
2842  
2843  
2844 =head2 GetBucketAcl
2845  
2846 =over
2847  
2848 =item Bucket => Str
2849  
2850 =item [ExpectedBucketOwner => Str]
2851  
2852  
2853 =back
2854  
2855 Each argument is described in detail in: L<Paws::S3::GetBucketAcl>
2856  
2857 Returns: a L<Paws::S3::GetBucketAclOutput> instance
2858  
2859 This implementation of the C<GET> action uses the C<acl> subresource to
2860 return the access control list (ACL) of a bucket. To use C<GET> to
2861 return the ACL of the bucket, you must have C<READ_ACP> access to the
2862 bucket. If C<READ_ACP> permission is granted to the anonymous user, you
2863 can return the ACL of the bucket without using an authorization header.
2864  
2865 B<Related Resources>
2866  
2867 =over
2868  
2869 =item *
2870  
2871 ListObjects
2872 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html)
2873  
2874 =back
2875  
2876  
2877  
2878 =head2 GetBucketAnalyticsConfiguration
2879  
2880 =over
2881  
2882 =item Bucket => Str
2883  
2884 =item Id => Str
2885  
2886 =item [ExpectedBucketOwner => Str]
2887  
2888  
2889 =back
2890  
2891 Each argument is described in detail in: L<Paws::S3::GetBucketAnalyticsConfiguration>
2892  
2893 Returns: a L<Paws::S3::GetBucketAnalyticsConfigurationOutput> instance
2894  
2895 This implementation of the GET action returns an analytics
2896 configuration (identified by the analytics configuration ID) from the
2897 bucket.
2898  
2899 To use this operation, you must have permissions to perform the
2900 C<s3:GetAnalyticsConfiguration> action. The bucket owner has this
2901 permission by default. The bucket owner can grant this permission to
2902 others. For more information about permissions, see Permissions Related
2903 to Bucket Subresource Operations
2904 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
2905 and Managing Access Permissions to Your Amazon S3 Resources
2906 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
2907 in the I<Amazon S3 User Guide>.
2908  
2909 For information about Amazon S3 analytics feature, see Amazon S3
2910 Analytics E<ndash> Storage Class Analysis
2911 (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html)
2912 in the I<Amazon S3 User Guide>.
2913  
2914 B<Related Resources>
2915  
2916 =over
2917  
2918 =item *
2919  
2920 DeleteBucketAnalyticsConfiguration
2921 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html)
2922  
2923 =item *
2924  
2925 ListBucketAnalyticsConfigurations
2926 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html)
2927  
2928 =item *
2929  
2930 PutBucketAnalyticsConfiguration
2931 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html)
2932  
2933 =back
2934  
2935  
2936  
2937 =head2 GetBucketCors
2938  
2939 =over
2940  
2941 =item Bucket => Str
2942  
2943 =item [ExpectedBucketOwner => Str]
2944  
2945  
2946 =back
2947  
2948 Each argument is described in detail in: L<Paws::S3::GetBucketCors>
2949  
2950 Returns: a L<Paws::S3::GetBucketCorsOutput> instance
2951  
2952 Returns the cors configuration information set for the bucket.
2953  
2954 To use this operation, you must have permission to perform the
2955 s3:GetBucketCORS action. By default, the bucket owner has this
2956 permission and can grant it to others.
2957  
2958 For more information about cors, see Enabling Cross-Origin Resource
2959 Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html).
2960  
2961 The following operations are related to C<GetBucketCors>:
2962  
2963 =over
2964  
2965 =item *
2966  
2967 PutBucketCors
2968 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html)
2969  
2970 =item *
2971  
2972 DeleteBucketCors
2973 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html)
2974  
2975 =back
2976  
2977  
2978  
2979 =head2 GetBucketEncryption
2980  
2981 =over
2982  
2983 =item Bucket => Str
2984  
2985 =item [ExpectedBucketOwner => Str]
2986  
2987  
2988 =back
2989  
2990 Each argument is described in detail in: L<Paws::S3::GetBucketEncryption>
2991  
2992 Returns: a L<Paws::S3::GetBucketEncryptionOutput> instance
2993  
2994 Returns the default encryption configuration for an Amazon S3 bucket.
2995 If the bucket does not have a default encryption configuration,
2996 GetBucketEncryption returns
2997 C<ServerSideEncryptionConfigurationNotFoundError>.
2998  
2999 For information about the Amazon S3 default encryption feature, see
3000 Amazon S3 Default Bucket Encryption
3001 (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html).
3002  
3003 To use this operation, you must have permission to perform the
3004 C<s3:GetEncryptionConfiguration> action. The bucket owner has this
3005 permission by default. The bucket owner can grant this permission to
3006 others. For more information about permissions, see Permissions Related
3007 to Bucket Subresource Operations
3008 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
3009 and Managing Access Permissions to Your Amazon S3 Resources
3010 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
3011  
3012 The following operations are related to C<GetBucketEncryption>:
3013  
3014 =over
3015  
3016 =item *
3017  
3018 PutBucketEncryption
3019 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html)
3020  
3021 =item *
3022  
3023 DeleteBucketEncryption
3024 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html)
3025  
3026 =back
3027  
3028  
3029  
3030 =head2 GetBucketIntelligentTieringConfiguration
3031  
3032 =over
3033  
3034 =item Bucket => Str
3035  
3036 =item Id => Str
3037  
3038  
3039 =back
3040  
3041 Each argument is described in detail in: L<Paws::S3::GetBucketIntelligentTieringConfiguration>
3042  
3043 Returns: a L<Paws::S3::GetBucketIntelligentTieringConfigurationOutput> instance
3044  
3045 Gets the S3 Intelligent-Tiering configuration from the specified
3046 bucket.
3047  
3048 The S3 Intelligent-Tiering storage class is designed to optimize
3049 storage costs by automatically moving data to the most cost-effective
3050 storage access tier, without additional operational overhead. S3
3051 Intelligent-Tiering delivers automatic cost savings by moving data
3052 between access tiers, when access patterns change.
3053  
3054 The S3 Intelligent-Tiering storage class is suitable for objects larger
3055 than 128 KB that you plan to store for at least 30 days. If the size of
3056 an object is less than 128 KB, it is not eligible for auto-tiering.
3057 Smaller objects can be stored, but they are always charged at the
3058 frequent access tier rates in the S3 Intelligent-Tiering storage class.
3059  
3060 If you delete an object before the end of the 30-day minimum storage
3061 duration period, you are charged for 30 days. For more information, see
3062 Storage class for automatically optimizing frequently and infrequently
3063 accessed objects
3064 (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
3065  
3066 Operations related to C<GetBucketIntelligentTieringConfiguration>
3067 include:
3068  
3069 =over
3070  
3071 =item *
3072  
3073 DeleteBucketIntelligentTieringConfiguration
3074 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html)
3075  
3076 =item *
3077  
3078 PutBucketIntelligentTieringConfiguration
3079 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html)
3080  
3081 =item *
3082  
3083 ListBucketIntelligentTieringConfigurations
3084 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html)
3085  
3086 =back
3087  
3088  
3089  
3090 =head2 GetBucketInventoryConfiguration
3091  
3092 =over
3093  
3094 =item Bucket => Str
3095  
3096 =item Id => Str
3097  
3098 =item [ExpectedBucketOwner => Str]
3099  
3100  
3101 =back
3102  
3103 Each argument is described in detail in: L<Paws::S3::GetBucketInventoryConfiguration>
3104  
3105 Returns: a L<Paws::S3::GetBucketInventoryConfigurationOutput> instance
3106  
3107 Returns an inventory configuration (identified by the inventory
3108 configuration ID) from the bucket.
3109  
3110 To use this operation, you must have permissions to perform the
3111 C<s3:GetInventoryConfiguration> action. The bucket owner has this
3112 permission by default and can grant this permission to others. For more
3113 information about permissions, see Permissions Related to Bucket
3114 Subresource Operations
3115 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
3116 and Managing Access Permissions to Your Amazon S3 Resources
3117 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
3118  
3119 For information about the Amazon S3 inventory feature, see Amazon S3
3120 Inventory
3121 (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html).
3122  
3123 The following operations are related to
3124 C<GetBucketInventoryConfiguration>:
3125  
3126 =over
3127  
3128 =item *
3129  
3130 DeleteBucketInventoryConfiguration
3131 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html)
3132  
3133 =item *
3134  
3135 ListBucketInventoryConfigurations
3136 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html)
3137  
3138 =item *
3139  
3140 PutBucketInventoryConfiguration
3141 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html)
3142  
3143 =back
3144  
3145  
3146  
3147 =head2 GetBucketLifecycle
3148  
3149 =over
3150  
3151 =item Bucket => Str
3152  
3153 =item [ExpectedBucketOwner => Str]
3154  
3155  
3156 =back
3157  
3158 Each argument is described in detail in: L<Paws::S3::GetBucketLifecycle>
3159  
3160 Returns: a L<Paws::S3::GetBucketLifecycleOutput> instance
3161  
3162 For an updated version of this API, see GetBucketLifecycleConfiguration
3163 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html).
3164 If you configured a bucket lifecycle using the C<filter> element, you
3165 should see the updated version of this topic. This topic is provided
3166 for backward compatibility.
3167  
3168 Returns the lifecycle configuration information set on the bucket. For
3169 information about lifecycle configuration, see Object Lifecycle
3170 Management
3171 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html).
3172  
3173 To use this operation, you must have permission to perform the
3174 C<s3:GetLifecycleConfiguration> action. The bucket owner has this
3175 permission by default. The bucket owner can grant this permission to
3176 others. For more information about permissions, see Permissions Related
3177 to Bucket Subresource Operations
3178 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
3179 and Managing Access Permissions to Your Amazon S3 Resources
3180 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
3181  
3182 C<GetBucketLifecycle> has the following special error:
3183  
3184 =over
3185  
3186 =item *
3187  
3188 Error code: C<NoSuchLifecycleConfiguration>
3189  
3190 =over
3191  
3192 =item *
3193  
3194 Description: The lifecycle configuration does not exist.
3195  
3196 =item *
3197  
3198 HTTP Status Code: 404 Not Found
3199  
3200 =item *
3201  
3202 SOAP Fault Code Prefix: Client
3203  
3204 =back
3205  
3206 =back
3207  
3208 The following operations are related to C<GetBucketLifecycle>:
3209  
3210 =over
3211  
3212 =item *
3213  
3214 GetBucketLifecycleConfiguration
3215 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)
3216  
3217 =item *
3218  
3219 PutBucketLifecycle
3220 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html)
3221  
3222 =item *
3223  
3224 DeleteBucketLifecycle
3225 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html)
3226  
3227 =back
3228  
3229  
3230  
3231 =head2 GetBucketLifecycleConfiguration
3232  
3233 =over
3234  
3235 =item Bucket => Str
3236  
3237 =item [ExpectedBucketOwner => Str]
3238  
3239  
3240 =back
3241  
3242 Each argument is described in detail in: L<Paws::S3::GetBucketLifecycleConfiguration>
3243  
3244 Returns: a L<Paws::S3::GetBucketLifecycleConfigurationOutput> instance
3245  
3246 Bucket lifecycle configuration now supports specifying a lifecycle rule
3247 using an object key name prefix, one or more object tags, or a
3248 combination of both. Accordingly, this section describes the latest
3249 API. The response describes the new filter element that you can use to
3250 specify a filter to select a subset of objects to which the rule
3251 applies. If you are using a previous version of the lifecycle
3252 configuration, it still works. For the earlier action, see
3253 GetBucketLifecycle
3254 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html).
3255  
3256 Returns the lifecycle configuration information set on the bucket. For
3257 information about lifecycle configuration, see Object Lifecycle
3258 Management
3259 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html).
3260  
3261 To use this operation, you must have permission to perform the
3262 C<s3:GetLifecycleConfiguration> action. The bucket owner has this
3263 permission, by default. The bucket owner can grant this permission to
3264 others. For more information about permissions, see Permissions Related
3265 to Bucket Subresource Operations
3266 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
3267 and Managing Access Permissions to Your Amazon S3 Resources
3268 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
3269  
3270 C<GetBucketLifecycleConfiguration> has the following special error:
3271  
3272 =over
3273  
3274 =item *
3275  
3276 Error code: C<NoSuchLifecycleConfiguration>
3277  
3278 =over
3279  
3280 =item *
3281  
3282 Description: The lifecycle configuration does not exist.
3283  
3284 =item *
3285  
3286 HTTP Status Code: 404 Not Found
3287  
3288 =item *
3289  
3290 SOAP Fault Code Prefix: Client
3291  
3292 =back
3293  
3294 =back
3295  
3296 The following operations are related to
3297 C<GetBucketLifecycleConfiguration>:
3298  
3299 =over
3300  
3301 =item *
3302  
3303 GetBucketLifecycle
3304 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html)
3305  
3306 =item *
3307  
3308 PutBucketLifecycle
3309 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html)
3310  
3311 =item *
3312  
3313 DeleteBucketLifecycle
3314 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html)
3315  
3316 =back
3317  
3318  
3319  
3320 =head2 GetBucketLocation
3321  
3322 =over
3323  
3324 =item Bucket => Str
3325  
3326 =item [ExpectedBucketOwner => Str]
3327  
3328  
3329 =back
3330  
3331 Each argument is described in detail in: L<Paws::S3::GetBucketLocation>
3332  
3333 Returns: a L<Paws::S3::GetBucketLocationOutput> instance
3334  
3335 Returns the Region the bucket resides in. You set the bucket's Region
3336 using the C<LocationConstraint> request parameter in a C<CreateBucket>
3337 request. For more information, see CreateBucket
3338 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html).
3339  
3340 To use this implementation of the operation, you must be the bucket
3341 owner.
3342  
3343 The following operations are related to C<GetBucketLocation>:
3344  
3345 =over
3346  
3347 =item *
3348  
3349 GetObject
3350 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
3351  
3352 =item *
3353  
3354 CreateBucket
3355 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
3356  
3357 =back
3358  
3359  
3360  
3361 =head2 GetBucketLogging
3362  
3363 =over
3364  
3365 =item Bucket => Str
3366  
3367 =item [ExpectedBucketOwner => Str]
3368  
3369  
3370 =back
3371  
3372 Each argument is described in detail in: L<Paws::S3::GetBucketLogging>
3373  
3374 Returns: a L<Paws::S3::GetBucketLoggingOutput> instance
3375  
3376 Returns the logging status of a bucket and the permissions users have
3377 to view and modify that status. To use GET, you must be the bucket
3378 owner.
3379  
3380 The following operations are related to C<GetBucketLogging>:
3381  
3382 =over
3383  
3384 =item *
3385  
3386 CreateBucket
3387 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
3388  
3389 =item *
3390  
3391 PutBucketLogging
3392 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html)
3393  
3394 =back
3395  
3396  
3397  
3398 =head2 GetBucketMetricsConfiguration
3399  
3400 =over
3401  
3402 =item Bucket => Str
3403  
3404 =item Id => Str
3405  
3406 =item [ExpectedBucketOwner => Str]
3407  
3408  
3409 =back
3410  
3411 Each argument is described in detail in: L<Paws::S3::GetBucketMetricsConfiguration>
3412  
3413 Returns: a L<Paws::S3::GetBucketMetricsConfigurationOutput> instance
3414  
3415 Gets a metrics configuration (specified by the metrics configuration
3416 ID) from the bucket. Note that this doesn't include the daily storage
3417 metrics.
3418  
3419 To use this operation, you must have permissions to perform the
3420 C<s3:GetMetricsConfiguration> action. The bucket owner has this
3421 permission by default. The bucket owner can grant this permission to
3422 others. For more information about permissions, see Permissions Related
3423 to Bucket Subresource Operations
3424 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
3425 and Managing Access Permissions to Your Amazon S3 Resources
3426 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
3427  
3428 For information about CloudWatch request metrics for Amazon S3, see
3429 Monitoring Metrics with Amazon CloudWatch
3430 (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).
3431  
3432 The following operations are related to
3433 C<GetBucketMetricsConfiguration>:
3434  
3435 =over
3436  
3437 =item *
3438  
3439 PutBucketMetricsConfiguration
3440 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html)
3441  
3442 =item *
3443  
3444 DeleteBucketMetricsConfiguration
3445 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html)
3446  
3447 =item *
3448  
3449 ListBucketMetricsConfigurations
3450 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html)
3451  
3452 =item *
3453  
3454 Monitoring Metrics with Amazon CloudWatch
3455 (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html)
3456  
3457 =back
3458  
3459  
3460  
3461 =head2 GetBucketNotification
3462  
3463 =over
3464  
3465 =item Bucket => Str
3466  
3467 =item [ExpectedBucketOwner => Str]
3468  
3469  
3470 =back
3471  
3472 Each argument is described in detail in: L<Paws::S3::GetBucketNotification>
3473  
3474 Returns: a L<Paws::S3::NotificationConfigurationDeprecated> instance
3475  
3476 No longer used, see GetBucketNotificationConfiguration
3477 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html).
3478  
3479  
3480 =head2 GetBucketNotificationConfiguration
3481  
3482 =over
3483  
3484 =item Bucket => Str
3485  
3486 =item [ExpectedBucketOwner => Str]
3487  
3488  
3489 =back
3490  
3491 Each argument is described in detail in: L<Paws::S3::GetBucketNotificationConfiguration>
3492  
3493 Returns: a L<Paws::S3::NotificationConfiguration> instance
3494  
3495 Returns the notification configuration of a bucket.
3496  
3497 If notifications are not enabled on the bucket, the action returns an
3498 empty C<NotificationConfiguration> element.
3499  
3500 By default, you must be the bucket owner to read the notification
3501 configuration of a bucket. However, the bucket owner can use a bucket
3502 policy to grant permission to other users to read this configuration
3503 with the C<s3:GetBucketNotification> permission.
3504  
3505 For more information about setting and reading the notification
3506 configuration on a bucket, see Setting Up Notification of Bucket Events
3507 (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html).
3508 For more information about bucket policies, see Using Bucket Policies
3509 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).
3510  
3511 The following action is related to C<GetBucketNotification>:
3512  
3513 =over
3514  
3515 =item *
3516  
3517 PutBucketNotification
3518 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html)
3519  
3520 =back
3521  
3522  
3523  
3524 =head2 GetBucketOwnershipControls
3525  
3526 =over
3527  
3528 =item Bucket => Str
3529  
3530 =item [ExpectedBucketOwner => Str]
3531  
3532  
3533 =back
3534  
3535 Each argument is described in detail in: L<Paws::S3::GetBucketOwnershipControls>
3536  
3537 Returns: a L<Paws::S3::GetBucketOwnershipControlsOutput> instance
3538  
3539 Retrieves C<OwnershipControls> for an Amazon S3 bucket. To use this
3540 operation, you must have the C<s3:GetBucketOwnershipControls>
3541 permission. For more information about Amazon S3 permissions, see
3542 Specifying Permissions in a Policy
3543 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
3544  
3545 For information about Amazon S3 Object Ownership, see Using Object
3546 Ownership
3547 (https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html).
3548  
3549 The following operations are related to C<GetBucketOwnershipControls>:
3550  
3551 =over
3552  
3553 =item *
3554  
3555 PutBucketOwnershipControls
3556  
3557 =item *
3558  
3559 DeleteBucketOwnershipControls
3560  
3561 =back
3562  
3563  
3564  
3565 =head2 GetBucketPolicy
3566  
3567 =over
3568  
3569 =item Bucket => Str
3570  
3571 =item [ExpectedBucketOwner => Str]
3572  
3573  
3574 =back
3575  
3576 Each argument is described in detail in: L<Paws::S3::GetBucketPolicy>
3577  
3578 Returns: a L<Paws::S3::GetBucketPolicyOutput> instance
3579  
3580 Returns the policy of a specified bucket. If you are using an identity
3581 other than the root user of the AWS account that owns the bucket, the
3582 calling identity must have the C<GetBucketPolicy> permissions on the
3583 specified bucket and belong to the bucket owner's account in order to
3584 use this operation.
3585  
3586 If you don't have C<GetBucketPolicy> permissions, Amazon S3 returns a
3587 C<403 Access Denied> error. If you have the correct permissions, but
3588 you're not using an identity that belongs to the bucket owner's
3589 account, Amazon S3 returns a C<405 Method Not Allowed> error.
3590  
3591 As a security precaution, the root user of the AWS account that owns a
3592 bucket can always use this operation, even if the policy explicitly
3593 denies the root user the ability to perform this action.
3594  
3595 For more information about bucket policies, see Using Bucket Policies
3596 and User Policies
3597 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).
3598  
3599 The following action is related to C<GetBucketPolicy>:
3600  
3601 =over
3602  
3603 =item *
3604  
3605 GetObject
3606 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
3607  
3608 =back
3609  
3610  
3611  
3612 =head2 GetBucketPolicyStatus
3613  
3614 =over
3615  
3616 =item Bucket => Str
3617  
3618 =item [ExpectedBucketOwner => Str]
3619  
3620  
3621 =back
3622  
3623 Each argument is described in detail in: L<Paws::S3::GetBucketPolicyStatus>
3624  
3625 Returns: a L<Paws::S3::GetBucketPolicyStatusOutput> instance
3626  
3627 Retrieves the policy status for an Amazon S3 bucket, indicating whether
3628 the bucket is public. In order to use this operation, you must have the
3629 C<s3:GetBucketPolicyStatus> permission. For more information about
3630 Amazon S3 permissions, see Specifying Permissions in a Policy
3631 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
3632  
3633 For more information about when Amazon S3 considers a bucket public,
3634 see The Meaning of "Public"
3635 (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status).
3636  
3637 The following operations are related to C<GetBucketPolicyStatus>:
3638  
3639 =over
3640  
3641 =item *
3642  
3643 Using Amazon S3 Block Public Access
3644 (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html)
3645  
3646 =item *
3647  
3648 GetPublicAccessBlock
3649 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html)
3650  
3651 =item *
3652  
3653 PutPublicAccessBlock
3654 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html)
3655  
3656 =item *
3657  
3658 DeletePublicAccessBlock
3659 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html)
3660  
3661 =back
3662  
3663  
3664  
3665 =head2 GetBucketReplication
3666  
3667 =over
3668  
3669 =item Bucket => Str
3670  
3671 =item [ExpectedBucketOwner => Str]
3672  
3673  
3674 =back
3675  
3676 Each argument is described in detail in: L<Paws::S3::GetBucketReplication>
3677  
3678 Returns: a L<Paws::S3::GetBucketReplicationOutput> instance
3679  
3680 Returns the replication configuration of a bucket.
3681  
3682 It can take a while to propagate the put or delete a replication
3683 configuration to all Amazon S3 systems. Therefore, a get request soon
3684 after put or delete can return a wrong result.
3685  
3686 For information about replication configuration, see Replication
3687 (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in
3688 the I<Amazon S3 User Guide>.
3689  
3690 This action requires permissions for the
3691 C<s3:GetReplicationConfiguration> action. For more information about
3692 permissions, see Using Bucket Policies and User Policies
3693 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).
3694  
3695 If you include the C<Filter> element in a replication configuration,
3696 you must also include the C<DeleteMarkerReplication> and C<Priority>
3697 elements. The response also returns those elements.
3698  
3699 For information about C<GetBucketReplication> errors, see List of
3700 replication-related error codes
3701 (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList)
3702  
3703 The following operations are related to C<GetBucketReplication>:
3704  
3705 =over
3706  
3707 =item *
3708  
3709 PutBucketReplication
3710 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html)
3711  
3712 =item *
3713  
3714 DeleteBucketReplication
3715 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html)
3716  
3717 =back
3718  
3719  
3720  
3721 =head2 GetBucketRequestPayment
3722  
3723 =over
3724  
3725 =item Bucket => Str
3726  
3727 =item [ExpectedBucketOwner => Str]
3728  
3729  
3730 =back
3731  
3732 Each argument is described in detail in: L<Paws::S3::GetBucketRequestPayment>
3733  
3734 Returns: a L<Paws::S3::GetBucketRequestPaymentOutput> instance
3735  
3736 Returns the request payment configuration of a bucket. To use this
3737 version of the operation, you must be the bucket owner. For more
3738 information, see Requester Pays Buckets
3739 (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html).
3740  
3741 The following operations are related to C<GetBucketRequestPayment>:
3742  
3743 =over
3744  
3745 =item *
3746  
3747 ListObjects
3748 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html)
3749  
3750 =back
3751  
3752  
3753  
3754 =head2 GetBucketTagging
3755  
3756 =over
3757  
3758 =item Bucket => Str
3759  
3760 =item [ExpectedBucketOwner => Str]
3761  
3762  
3763 =back
3764  
3765 Each argument is described in detail in: L<Paws::S3::GetBucketTagging>
3766  
3767 Returns: a L<Paws::S3::GetBucketTaggingOutput> instance
3768  
3769 Returns the tag set associated with the bucket.
3770  
3771 To use this operation, you must have permission to perform the
3772 C<s3:GetBucketTagging> action. By default, the bucket owner has this
3773 permission and can grant this permission to others.
3774  
3775 C<GetBucketTagging> has the following special error:
3776  
3777 =over
3778  
3779 =item *
3780  
3781 Error code: C<NoSuchTagSetError>
3782  
3783 =over
3784  
3785 =item *
3786  
3787 Description: There is no tag set associated with the bucket.
3788  
3789 =back
3790  
3791 =back
3792  
3793 The following operations are related to C<GetBucketTagging>:
3794  
3795 =over
3796  
3797 =item *
3798  
3799 PutBucketTagging
3800 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html)
3801  
3802 =item *
3803  
3804 DeleteBucketTagging
3805 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html)
3806  
3807 =back
3808  
3809  
3810  
3811 =head2 GetBucketVersioning
3812  
3813 =over
3814  
3815 =item Bucket => Str
3816  
3817 =item [ExpectedBucketOwner => Str]
3818  
3819  
3820 =back
3821  
3822 Each argument is described in detail in: L<Paws::S3::GetBucketVersioning>
3823  
3824 Returns: a L<Paws::S3::GetBucketVersioningOutput> instance
3825  
3826 Returns the versioning state of a bucket.
3827  
3828 To retrieve the versioning state of a bucket, you must be the bucket
3829 owner.
3830  
3831 This implementation also returns the MFA Delete status of the
3832 versioning state. If the MFA Delete status is C<enabled>, the bucket
3833 owner must use an authentication device to change the versioning state
3834 of the bucket.
3835  
3836 The following operations are related to C<GetBucketVersioning>:
3837  
3838 =over
3839  
3840 =item *
3841  
3842 GetObject
3843 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
3844  
3845 =item *
3846  
3847 PutObject
3848 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
3849  
3850 =item *
3851  
3852 DeleteObject
3853 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
3854  
3855 =back
3856  
3857  
3858  
3859 =head2 GetBucketWebsite
3860  
3861 =over
3862  
3863 =item Bucket => Str
3864  
3865 =item [ExpectedBucketOwner => Str]
3866  
3867  
3868 =back
3869  
3870 Each argument is described in detail in: L<Paws::S3::GetBucketWebsite>
3871  
3872 Returns: a L<Paws::S3::GetBucketWebsiteOutput> instance
3873  
3874 Returns the website configuration for a bucket. To host website on
3875 Amazon S3, you can configure a bucket as website by adding a website
3876 configuration. For more information about hosting websites, see Hosting
3877 Websites on Amazon S3
3878 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
3879  
3880 This GET action requires the C<S3:GetBucketWebsite> permission. By
3881 default, only the bucket owner can read the bucket website
3882 configuration. However, bucket owners can allow other users to read the
3883 website configuration by writing a bucket policy granting them the
3884 C<S3:GetBucketWebsite> permission.
3885  
3886 The following operations are related to C<DeleteBucketWebsite>:
3887  
3888 =over
3889  
3890 =item *
3891  
3892 DeleteBucketWebsite
3893 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html)
3894  
3895 =item *
3896  
3897 PutBucketWebsite
3898 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html)
3899  
3900 =back
3901  
3902  
3903  
3904 =head2 GetObject
3905  
3906 =over
3907  
3908 =item Bucket => Str
3909  
3910 =item Key => Str
3911  
3912 =item [ExpectedBucketOwner => Str]
3913  
3914 =item [IfMatch => Str]
3915  
3916 =item [IfModifiedSince => Str]
3917  
3918 =item [IfNoneMatch => Str]
3919  
3920 =item [IfUnmodifiedSince => Str]
3921  
3922 =item [PartNumber => Int]
3923  
3924 =item [Range => Str]
3925  
3926 =item [RequestPayer => Str]
3927  
3928 =item [ResponseCacheControl => Str]
3929  
3930 =item [ResponseContentDisposition => Str]
3931  
3932 =item [ResponseContentEncoding => Str]
3933  
3934 =item [ResponseContentLanguage => Str]
3935  
3936 =item [ResponseContentType => Str]
3937  
3938 =item [ResponseExpires => Str]
3939  
3940 =item [SSECustomerAlgorithm => Str]
3941  
3942 =item [SSECustomerKey => Str]
3943  
3944 =item [SSECustomerKeyMD5 => Str]
3945  
3946 =item [VersionId => Str]
3947  
3948  
3949 =back
3950  
3951 Each argument is described in detail in: L<Paws::S3::GetObject>
3952  
3953 Returns: a L<Paws::S3::GetObjectOutput> instance
3954  
3955 Retrieves objects from Amazon S3. To use C<GET>, you must have C<READ>
3956 access to the object. If you grant C<READ> access to the anonymous
3957 user, you can return the object without using an authorization header.
3958  
3959 An Amazon S3 bucket has no directory hierarchy such as you would find
3960 in a typical computer file system. You can, however, create a logical
3961 hierarchy by using object key names that imply a folder structure. For
3962 example, instead of naming an object C<sample.jpg>, you can name it
3963 C<photos/2006/February/sample.jpg>.
3964  
3965 To get an object from such a logical hierarchy, specify the full key
3966 name for the object in the C<GET> operation. For a virtual hosted-style
3967 request example, if you have the object
3968 C<photos/2006/February/sample.jpg>, specify the resource as
3969 C</photos/2006/February/sample.jpg>. For a path-style request example,
3970 if you have the object C<photos/2006/February/sample.jpg> in the bucket
3971 named C<examplebucket>, specify the resource as
3972 C</examplebucket/photos/2006/February/sample.jpg>. For more information
3973 about request types, see HTTP Host Header Bucket Specification
3974 (https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket).
3975  
3976 To distribute large files to many people, you can save bandwidth costs
3977 by using BitTorrent. For more information, see Amazon S3 Torrent
3978 (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html). For
3979 more information about returning the ACL of an object, see GetObjectAcl
3980 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html).
3981  
3982 If the object you are retrieving is stored in the S3 Glacier or S3
3983 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive
3984 or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve
3985 the object you must first restore a copy using RestoreObject
3986 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html).
3987 Otherwise, this action returns an C<InvalidObjectStateError> error. For
3988 information about restoring archived objects, see Restoring Archived
3989 Objects
3990 (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html).
3991  
3992 Encryption request headers, like C<x-amz-server-side-encryption>,
3993 should not be sent for GET requests if your object uses server-side
3994 encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side
3995 encryption with Amazon S3E<ndash>managed encryption keys (SSE-S3). If
3996 your object does use these types of keys, youE<rsquo>ll get an HTTP 400
3997 BadRequest error.
3998  
3999 If you encrypt an object by using server-side encryption with
4000 customer-provided encryption keys (SSE-C) when you store the object in
4001 Amazon S3, then when you GET the object, you must use the following
4002 headers:
4003  
4004 =over
4005  
4006 =item *
4007  
4008 x-amz-server-side-encryption-customer-algorithm
4009  
4010 =item *
4011  
4012 x-amz-server-side-encryption-customer-key
4013  
4014 =item *
4015  
4016 x-amz-server-side-encryption-customer-key-MD5
4017  
4018 =back
4019  
4020 For more information about SSE-C, see Server-Side Encryption (Using
4021 Customer-Provided Encryption Keys)
4022 (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html).
4023  
4024 Assuming you have permission to read object tags (permission for the
4025 C<s3:GetObjectVersionTagging> action), the response also returns the
4026 C<x-amz-tagging-count> header that provides the count of number of tags
4027 associated with the object. You can use GetObjectTagging
4028 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html)
4029 to retrieve the tag set associated with an object.
4030  
4031 B<Permissions>
4032  
4033 You need the C<s3:GetObject> permission for this operation. For more
4034 information, see Specifying Permissions in a Policy
4035 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
4036 If the object you request does not exist, the error Amazon S3 returns
4037 depends on whether you also have the C<s3:ListBucket> permission.
4038  
4039 =over
4040  
4041 =item *
4042  
4043 If you have the C<s3:ListBucket> permission on the bucket, Amazon S3
4044 will return an HTTP status code 404 ("no such key") error.
4045  
4046 =item *
4047  
4048 If you donE<rsquo>t have the C<s3:ListBucket> permission, Amazon S3
4049 will return an HTTP status code 403 ("access denied") error.
4050  
4051 =back
4052  
4053 B<Versioning>
4054  
4055 By default, the GET action returns the current version of an object. To
4056 return a different version, use the C<versionId> subresource.
4057  
4058 If the current version of the object is a delete marker, Amazon S3
4059 behaves as if the object was deleted and includes
4060 C<x-amz-delete-marker: true> in the response.
4061  
4062 For more information about versioning, see PutBucketVersioning
4063 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html).
4064  
4065 B<Overriding Response Header Values>
4066  
4067 There are times when you want to override certain response header
4068 values in a GET response. For example, you might override the
4069 Content-Disposition response header value in your GET request.
4070  
4071 You can override values for a set of response headers using the
4072 following query parameters. These response header values are sent only
4073 on a successful request, that is, when status code 200 OK is returned.
4074 The set of headers you can override using these parameters is a subset
4075 of the headers that Amazon S3 accepts when you create an object. The
4076 response headers that you can override for the GET response are
4077 C<Content-Type>, C<Content-Language>, C<Expires>, C<Cache-Control>,
4078 C<Content-Disposition>, and C<Content-Encoding>. To override these
4079 header values in the GET response, you use the following request
4080 parameters.
4081  
4082 You must sign the request, either using an Authorization header or a
4083 presigned URL, when using these parameters. They cannot be used with an
4084 unsigned (anonymous) request.
4085  
4086 =over
4087  
4088 =item *
4089  
4090 C<response-content-type>
4091  
4092 =item *
4093  
4094 C<response-content-language>
4095  
4096 =item *
4097  
4098 C<response-expires>
4099  
4100 =item *
4101  
4102 C<response-cache-control>
4103  
4104 =item *
4105  
4106 C<response-content-disposition>
4107  
4108 =item *
4109  
4110 C<response-content-encoding>
4111  
4112 =back
4113  
4114 B<Additional Considerations about Request Headers>
4115  
4116 If both of the C<If-Match> and C<If-Unmodified-Since> headers are
4117 present in the request as follows: C<If-Match> condition evaluates to
4118 C<true>, and; C<If-Unmodified-Since> condition evaluates to C<false>;
4119 then, S3 returns 200 OK and the data requested.
4120  
4121 If both of the C<If-None-Match> and C<If-Modified-Since> headers are
4122 present in the request as follows:C< If-None-Match> condition evaluates
4123 to C<false>, and; C<If-Modified-Since> condition evaluates to C<true>;
4124 then, S3 returns 304 Not Modified response code.
4125  
4126 For more information about conditional requests, see RFC 7232
4127 (https://tools.ietf.org/html/rfc7232).
4128  
4129 The following operations are related to C<GetObject>:
4130  
4131 =over
4132  
4133 =item *
4134  
4135 ListBuckets
4136 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html)
4137  
4138 =item *
4139  
4140 GetObjectAcl
4141 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html)
4142  
4143 =back
4144  
4145  
4146  
4147 =head2 GetObjectAcl
4148  
4149 =over
4150  
4151 =item Bucket => Str
4152  
4153 =item Key => Str
4154  
4155 =item [ExpectedBucketOwner => Str]
4156  
4157 =item [RequestPayer => Str]
4158  
4159 =item [VersionId => Str]
4160  
4161  
4162 =back
4163  
4164 Each argument is described in detail in: L<Paws::S3::GetObjectAcl>
4165  
4166 Returns: a L<Paws::S3::GetObjectAclOutput> instance
4167  
4168 Returns the access control list (ACL) of an object. To use this
4169 operation, you must have C<READ_ACP> access to the object.
4170  
4171 This action is not supported by Amazon S3 on Outposts.
4172  
4173 B<Versioning>
4174  
4175 By default, GET returns ACL information about the current version of an
4176 object. To return ACL information about a different version, use the
4177 versionId subresource.
4178  
4179 The following operations are related to C<GetObjectAcl>:
4180  
4181 =over
4182  
4183 =item *
4184  
4185 GetObject
4186 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
4187  
4188 =item *
4189  
4190 DeleteObject
4191 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
4192  
4193 =item *
4194  
4195 PutObject
4196 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
4197  
4198 =back
4199  
4200  
4201  
4202 =head2 GetObjectLegalHold
4203  
4204 =over
4205  
4206 =item Bucket => Str
4207  
4208 =item Key => Str
4209  
4210 =item [ExpectedBucketOwner => Str]
4211  
4212 =item [RequestPayer => Str]
4213  
4214 =item [VersionId => Str]
4215  
4216  
4217 =back
4218  
4219 Each argument is described in detail in: L<Paws::S3::GetObjectLegalHold>
4220  
4221 Returns: a L<Paws::S3::GetObjectLegalHoldOutput> instance
4222  
4223 Gets an object's current Legal Hold status. For more information, see
4224 Locking Objects
4225 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
4226  
4227 This action is not supported by Amazon S3 on Outposts.
4228  
4229  
4230 =head2 GetObjectLockConfiguration
4231  
4232 =over
4233  
4234 =item Bucket => Str
4235  
4236 =item [ExpectedBucketOwner => Str]
4237  
4238  
4239 =back
4240  
4241 Each argument is described in detail in: L<Paws::S3::GetObjectLockConfiguration>
4242  
4243 Returns: a L<Paws::S3::GetObjectLockConfigurationOutput> instance
4244  
4245 Gets the Object Lock configuration for a bucket. The rule specified in
4246 the Object Lock configuration will be applied by default to every new
4247 object placed in the specified bucket. For more information, see
4248 Locking Objects
4249 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
4250  
4251  
4252 =head2 GetObjectRetention
4253  
4254 =over
4255  
4256 =item Bucket => Str
4257  
4258 =item Key => Str
4259  
4260 =item [ExpectedBucketOwner => Str]
4261  
4262 =item [RequestPayer => Str]
4263  
4264 =item [VersionId => Str]
4265  
4266  
4267 =back
4268  
4269 Each argument is described in detail in: L<Paws::S3::GetObjectRetention>
4270  
4271 Returns: a L<Paws::S3::GetObjectRetentionOutput> instance
4272  
4273 Retrieves an object's retention settings. For more information, see
4274 Locking Objects
4275 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
4276  
4277 This action is not supported by Amazon S3 on Outposts.
4278  
4279  
4280 =head2 GetObjectTagging
4281  
4282 =over
4283  
4284 =item Bucket => Str
4285  
4286 =item Key => Str
4287  
4288 =item [ExpectedBucketOwner => Str]
4289  
4290 =item [RequestPayer => Str]
4291  
4292 =item [VersionId => Str]
4293  
4294  
4295 =back
4296  
4297 Each argument is described in detail in: L<Paws::S3::GetObjectTagging>
4298  
4299 Returns: a L<Paws::S3::GetObjectTaggingOutput> instance
4300  
4301 Returns the tag-set of an object. You send the GET request against the
4302 tagging subresource associated with the object.
4303  
4304 To use this operation, you must have permission to perform the
4305 C<s3:GetObjectTagging> action. By default, the GET action returns
4306 information about current version of an object. For a versioned bucket,
4307 you can have multiple versions of an object in your bucket. To retrieve
4308 tags of any other version, use the versionId query parameter. You also
4309 need permission for the C<s3:GetObjectVersionTagging> action.
4310  
4311 By default, the bucket owner has this permission and can grant this
4312 permission to others.
4313  
4314 For information about the Amazon S3 object tagging feature, see Object
4315 Tagging
4316 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html).
4317  
4318 The following action is related to C<GetObjectTagging>:
4319  
4320 =over
4321  
4322 =item *
4323  
4324 PutObjectTagging
4325 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html)
4326  
4327 =item *
4328  
4329 DeleteObjectTagging
4330 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html)
4331  
4332 =back
4333  
4334  
4335  
4336 =head2 GetObjectTorrent
4337  
4338 =over
4339  
4340 =item Bucket => Str
4341  
4342 =item Key => Str
4343  
4344 =item [ExpectedBucketOwner => Str]
4345  
4346 =item [RequestPayer => Str]
4347  
4348  
4349 =back
4350  
4351 Each argument is described in detail in: L<Paws::S3::GetObjectTorrent>
4352  
4353 Returns: a L<Paws::S3::GetObjectTorrentOutput> instance
4354  
4355 Returns torrent files from a bucket. BitTorrent can save you bandwidth
4356 when you're distributing large files. For more information about
4357 BitTorrent, see Using BitTorrent with Amazon S3
4358 (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html).
4359  
4360 You can get torrent only for objects that are less than 5 GB in size,
4361 and that are not encrypted using server-side encryption with a
4362 customer-provided encryption key.
4363  
4364 To use GET, you must have READ access to the object.
4365  
4366 This action is not supported by Amazon S3 on Outposts.
4367  
4368 The following action is related to C<GetObjectTorrent>:
4369  
4370 =over
4371  
4372 =item *
4373  
4374 GetObject
4375 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
4376  
4377 =back
4378  
4379  
4380  
4381 =head2 GetPublicAccessBlock
4382  
4383 =over
4384  
4385 =item Bucket => Str
4386  
4387 =item [ExpectedBucketOwner => Str]
4388  
4389  
4390 =back
4391  
4392 Each argument is described in detail in: L<Paws::S3::GetPublicAccessBlock>
4393  
4394 Returns: a L<Paws::S3::GetPublicAccessBlockOutput> instance
4395  
4396 Retrieves the C<PublicAccessBlock> configuration for an Amazon S3
4397 bucket. To use this operation, you must have the
4398 C<s3:GetBucketPublicAccessBlock> permission. For more information about
4399 Amazon S3 permissions, see Specifying Permissions in a Policy
4400 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
4401  
4402 When Amazon S3 evaluates the C<PublicAccessBlock> configuration for a
4403 bucket or an object, it checks the C<PublicAccessBlock> configuration
4404 for both the bucket (or the bucket that contains the object) and the
4405 bucket owner's account. If the C<PublicAccessBlock> settings are
4406 different between the bucket and the account, Amazon S3 uses the most
4407 restrictive combination of the bucket-level and account-level settings.
4408  
4409 For more information about when Amazon S3 considers a bucket or an
4410 object public, see The Meaning of "Public"
4411 (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status).
4412  
4413 The following operations are related to C<GetPublicAccessBlock>:
4414  
4415 =over
4416  
4417 =item *
4418  
4419 Using Amazon S3 Block Public Access
4420 (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html)
4421  
4422 =item *
4423  
4424 PutPublicAccessBlock
4425 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html)
4426  
4427 =item *
4428  
4429 GetPublicAccessBlock
4430 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html)
4431  
4432 =item *
4433  
4434 DeletePublicAccessBlock
4435 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html)
4436  
4437 =back
4438  
4439  
4440  
4441 =head2 HeadBucket
4442  
4443 =over
4444  
4445 =item Bucket => Str
4446  
4447 =item [ExpectedBucketOwner => Str]
4448  
4449  
4450 =back
4451  
4452 Each argument is described in detail in: L<Paws::S3::HeadBucket>
4453  
4454 Returns: nothing
4455  
4456 This action is useful to determine if a bucket exists and you have
4457 permission to access it. The action returns a C<200 OK> if the bucket
4458 exists and you have permission to access it.
4459  
4460 If the bucket does not exist or you do not have permission to access
4461 it, the C<HEAD> request returns a generic C<404 Not Found> or C<403
4462 Forbidden> code. A message body is not included, so you cannot
4463 determine the exception beyond these error codes.
4464  
4465 To use this operation, you must have permissions to perform the
4466 C<s3:ListBucket> action. The bucket owner has this permission by
4467 default and can grant this permission to others. For more information
4468 about permissions, see Permissions Related to Bucket Subresource
4469 Operations
4470 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
4471 and Managing Access Permissions to Your Amazon S3 Resources
4472 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
4473  
4474  
4475 =head2 HeadObject
4476  
4477 =over
4478  
4479 =item Bucket => Str
4480  
4481 =item Key => Str
4482  
4483 =item [ExpectedBucketOwner => Str]
4484  
4485 =item [IfMatch => Str]
4486  
4487 =item [IfModifiedSince => Str]
4488  
4489 =item [IfNoneMatch => Str]
4490  
4491 =item [IfUnmodifiedSince => Str]
4492  
4493 =item [PartNumber => Int]
4494  
4495 =item [Range => Str]
4496  
4497 =item [RequestPayer => Str]
4498  
4499 =item [SSECustomerAlgorithm => Str]
4500  
4501 =item [SSECustomerKey => Str]
4502  
4503 =item [SSECustomerKeyMD5 => Str]
4504  
4505 =item [VersionId => Str]
4506  
4507  
4508 =back
4509  
4510 Each argument is described in detail in: L<Paws::S3::HeadObject>
4511  
4512 Returns: a L<Paws::S3::HeadObjectOutput> instance
4513  
4514 The HEAD action retrieves metadata from an object without returning the
4515 object itself. This action is useful if you're only interested in an
4516 object's metadata. To use HEAD, you must have READ access to the
4517 object.
4518  
4519 A C<HEAD> request has the same options as a C<GET> action on an object.
4520 The response is identical to the C<GET> response except that there is
4521 no response body. Because of this, if the C<HEAD> request generates an
4522 error, it returns a generic C<404 Not Found> or C<403 Forbidden> code.
4523 It is not possible to retrieve the exact exception beyond these error
4524 codes.
4525  
4526 If you encrypt an object by using server-side encryption with
4527 customer-provided encryption keys (SSE-C) when you store the object in
4528 Amazon S3, then when you retrieve the metadata from the object, you
4529 must use the following headers:
4530  
4531 =over
4532  
4533 =item *
4534  
4535 x-amz-server-side-encryption-customer-algorithm
4536  
4537 =item *
4538  
4539 x-amz-server-side-encryption-customer-key
4540  
4541 =item *
4542  
4543 x-amz-server-side-encryption-customer-key-MD5
4544  
4545 =back
4546  
4547 For more information about SSE-C, see Server-Side Encryption (Using
4548 Customer-Provided Encryption Keys)
4549 (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html).
4550  
4551 =over
4552  
4553 =item *
4554  
4555 Encryption request headers, like C<x-amz-server-side-encryption>,
4556 should not be sent for GET requests if your object uses server-side
4557 encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side
4558 encryption with Amazon S3E<ndash>managed encryption keys (SSE-S3). If
4559 your object does use these types of keys, youE<rsquo>ll get an HTTP 400
4560 BadRequest error.
4561  
4562 =item *
4563  
4564 The last modified property in this case is the creation date of the
4565 object.
4566  
4567 =back
4568  
4569 Request headers are limited to 8 KB in size. For more information, see
4570 Common Request Headers
4571 (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html).
4572  
4573 Consider the following when using request headers:
4574  
4575 =over
4576  
4577 =item *
4578  
4579 Consideration 1 E<ndash> If both of the C<If-Match> and
4580 C<If-Unmodified-Since> headers are present in the request as follows:
4581  
4582 =over
4583  
4584 =item *
4585  
4586 C<If-Match> condition evaluates to C<true>, and;
4587  
4588 =item *
4589  
4590 C<If-Unmodified-Since> condition evaluates to C<false>;
4591  
4592 =back
4593  
4594 Then Amazon S3 returns C<200 OK> and the data requested.
4595  
4596 =item *
4597  
4598 Consideration 2 E<ndash> If both of the C<If-None-Match> and
4599 C<If-Modified-Since> headers are present in the request as follows:
4600  
4601 =over
4602  
4603 =item *
4604  
4605 C<If-None-Match> condition evaluates to C<false>, and;
4606  
4607 =item *
4608  
4609 C<If-Modified-Since> condition evaluates to C<true>;
4610  
4611 =back
4612  
4613 Then Amazon S3 returns the C<304 Not Modified> response code.
4614  
4615 =back
4616  
4617 For more information about conditional requests, see RFC 7232
4618 (https://tools.ietf.org/html/rfc7232).
4619  
4620 B<Permissions>
4621  
4622 You need the C<s3:GetObject> permission for this operation. For more
4623 information, see Specifying Permissions in a Policy
4624 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
4625 If the object you request does not exist, the error Amazon S3 returns
4626 depends on whether you also have the s3:ListBucket permission.
4627  
4628 =over
4629  
4630 =item *
4631  
4632 If you have the C<s3:ListBucket> permission on the bucket, Amazon S3
4633 returns an HTTP status code 404 ("no such key") error.
4634  
4635 =item *
4636  
4637 If you donE<rsquo>t have the C<s3:ListBucket> permission, Amazon S3
4638 returns an HTTP status code 403 ("access denied") error.
4639  
4640 =back
4641  
4642 The following action is related to C<HeadObject>:
4643  
4644 =over
4645  
4646 =item *
4647  
4648 GetObject
4649 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
4650  
4651 =back
4652  
4653  
4654  
4655 =head2 ListBucketAnalyticsConfigurations
4656  
4657 =over
4658  
4659 =item Bucket => Str
4660  
4661 =item [ContinuationToken => Str]
4662  
4663 =item [ExpectedBucketOwner => Str]
4664  
4665  
4666 =back
4667  
4668 Each argument is described in detail in: L<Paws::S3::ListBucketAnalyticsConfigurations>
4669  
4670 Returns: a L<Paws::S3::ListBucketAnalyticsConfigurationsOutput> instance
4671  
4672 Lists the analytics configurations for the bucket. You can have up to
4673 1,000 analytics configurations per bucket.
4674  
4675 This action supports list pagination and does not return more than 100
4676 configurations at a time. You should always check the C<IsTruncated>
4677 element in the response. If there are no more configurations to list,
4678 C<IsTruncated> is set to false. If there are more configurations to
4679 list, C<IsTruncated> is set to true, and there will be a value in
4680 C<NextContinuationToken>. You use the C<NextContinuationToken> value to
4681 continue the pagination of the list by passing the value in
4682 continuation-token in the request to C<GET> the next page.
4683  
4684 To use this operation, you must have permissions to perform the
4685 C<s3:GetAnalyticsConfiguration> action. The bucket owner has this
4686 permission by default. The bucket owner can grant this permission to
4687 others. For more information about permissions, see Permissions Related
4688 to Bucket Subresource Operations
4689 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
4690 and Managing Access Permissions to Your Amazon S3 Resources
4691 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
4692  
4693 For information about Amazon S3 analytics feature, see Amazon S3
4694 Analytics E<ndash> Storage Class Analysis
4695 (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html).
4696  
4697 The following operations are related to
4698 C<ListBucketAnalyticsConfigurations>:
4699  
4700 =over
4701  
4702 =item *
4703  
4704 GetBucketAnalyticsConfiguration
4705 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html)
4706  
4707 =item *
4708  
4709 DeleteBucketAnalyticsConfiguration
4710 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html)
4711  
4712 =item *
4713  
4714 PutBucketAnalyticsConfiguration
4715 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html)
4716  
4717 =back
4718  
4719  
4720  
4721 =head2 ListBucketIntelligentTieringConfigurations
4722  
4723 =over
4724  
4725 =item Bucket => Str
4726  
4727 =item [ContinuationToken => Str]
4728  
4729  
4730 =back
4731  
4732 Each argument is described in detail in: L<Paws::S3::ListBucketIntelligentTieringConfigurations>
4733  
4734 Returns: a L<Paws::S3::ListBucketIntelligentTieringConfigurationsOutput> instance
4735  
4736 Lists the S3 Intelligent-Tiering configuration from the specified
4737 bucket.
4738  
4739 The S3 Intelligent-Tiering storage class is designed to optimize
4740 storage costs by automatically moving data to the most cost-effective
4741 storage access tier, without additional operational overhead. S3
4742 Intelligent-Tiering delivers automatic cost savings by moving data
4743 between access tiers, when access patterns change.
4744  
4745 The S3 Intelligent-Tiering storage class is suitable for objects larger
4746 than 128 KB that you plan to store for at least 30 days. If the size of
4747 an object is less than 128 KB, it is not eligible for auto-tiering.
4748 Smaller objects can be stored, but they are always charged at the
4749 frequent access tier rates in the S3 Intelligent-Tiering storage class.
4750  
4751 If you delete an object before the end of the 30-day minimum storage
4752 duration period, you are charged for 30 days. For more information, see
4753 Storage class for automatically optimizing frequently and infrequently
4754 accessed objects
4755 (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
4756  
4757 Operations related to C<ListBucketIntelligentTieringConfigurations>
4758 include:
4759  
4760 =over
4761  
4762 =item *
4763  
4764 DeleteBucketIntelligentTieringConfiguration
4765 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html)
4766  
4767 =item *
4768  
4769 PutBucketIntelligentTieringConfiguration
4770 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html)
4771  
4772 =item *
4773  
4774 GetBucketIntelligentTieringConfiguration
4775 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html)
4776  
4777 =back
4778  
4779  
4780  
4781 =head2 ListBucketInventoryConfigurations
4782  
4783 =over
4784  
4785 =item Bucket => Str
4786  
4787 =item [ContinuationToken => Str]
4788  
4789 =item [ExpectedBucketOwner => Str]
4790  
4791  
4792 =back
4793  
4794 Each argument is described in detail in: L<Paws::S3::ListBucketInventoryConfigurations>
4795  
4796 Returns: a L<Paws::S3::ListBucketInventoryConfigurationsOutput> instance
4797  
4798 Returns a list of inventory configurations for the bucket. You can have
4799 up to 1,000 analytics configurations per bucket.
4800  
4801 This action supports list pagination and does not return more than 100
4802 configurations at a time. Always check the C<IsTruncated> element in
4803 the response. If there are no more configurations to list,
4804 C<IsTruncated> is set to false. If there are more configurations to
4805 list, C<IsTruncated> is set to true, and there is a value in
4806 C<NextContinuationToken>. You use the C<NextContinuationToken> value to
4807 continue the pagination of the list by passing the value in
4808 continuation-token in the request to C<GET> the next page.
4809  
4810 To use this operation, you must have permissions to perform the
4811 C<s3:GetInventoryConfiguration> action. The bucket owner has this
4812 permission by default. The bucket owner can grant this permission to
4813 others. For more information about permissions, see Permissions Related
4814 to Bucket Subresource Operations
4815 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
4816 and Managing Access Permissions to Your Amazon S3 Resources
4817 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
4818  
4819 For information about the Amazon S3 inventory feature, see Amazon S3
4820 Inventory
4821 (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html)
4822  
4823 The following operations are related to
4824 C<ListBucketInventoryConfigurations>:
4825  
4826 =over
4827  
4828 =item *
4829  
4830 GetBucketInventoryConfiguration
4831 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html)
4832  
4833 =item *
4834  
4835 DeleteBucketInventoryConfiguration
4836 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html)
4837  
4838 =item *
4839  
4840 PutBucketInventoryConfiguration
4841 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html)
4842  
4843 =back
4844  
4845  
4846  
4847 =head2 ListBucketMetricsConfigurations
4848  
4849 =over
4850  
4851 =item Bucket => Str
4852  
4853 =item [ContinuationToken => Str]
4854  
4855 =item [ExpectedBucketOwner => Str]
4856  
4857  
4858 =back
4859  
4860 Each argument is described in detail in: L<Paws::S3::ListBucketMetricsConfigurations>
4861  
4862 Returns: a L<Paws::S3::ListBucketMetricsConfigurationsOutput> instance
4863  
4864 Lists the metrics configurations for the bucket. The metrics
4865 configurations are only for the request metrics of the bucket and do
4866 not provide information on daily storage metrics. You can have up to
4867 1,000 configurations per bucket.
4868  
4869 This action supports list pagination and does not return more than 100
4870 configurations at a time. Always check the C<IsTruncated> element in
4871 the response. If there are no more configurations to list,
4872 C<IsTruncated> is set to false. If there are more configurations to
4873 list, C<IsTruncated> is set to true, and there is a value in
4874 C<NextContinuationToken>. You use the C<NextContinuationToken> value to
4875 continue the pagination of the list by passing the value in
4876 C<continuation-token> in the request to C<GET> the next page.
4877  
4878 To use this operation, you must have permissions to perform the
4879 C<s3:GetMetricsConfiguration> action. The bucket owner has this
4880 permission by default. The bucket owner can grant this permission to
4881 others. For more information about permissions, see Permissions Related
4882 to Bucket Subresource Operations
4883 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
4884 and Managing Access Permissions to Your Amazon S3 Resources
4885 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
4886  
4887 For more information about metrics configurations and CloudWatch
4888 request metrics, see Monitoring Metrics with Amazon CloudWatch
4889 (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).
4890  
4891 The following operations are related to
4892 C<ListBucketMetricsConfigurations>:
4893  
4894 =over
4895  
4896 =item *
4897  
4898 PutBucketMetricsConfiguration
4899 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html)
4900  
4901 =item *
4902  
4903 GetBucketMetricsConfiguration
4904 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html)
4905  
4906 =item *
4907  
4908 DeleteBucketMetricsConfiguration
4909 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html)
4910  
4911 =back
4912  
4913  
4914  
4915 =head2 ListBuckets
4916  
4917 =over
4918  
4919 =item =>
4920  
4921  
4922 =back
4923  
4924 Each argument is described in detail in: L<Paws::S3::ListBuckets>
4925  
4926 Returns: a L<Paws::S3::ListBucketsOutput> instance
4927  
4928 Returns a list of all buckets owned by the authenticated sender of the
4929 request.
4930  
4931  
4932 =head2 ListMultipartUploads
4933  
4934 =over
4935  
4936 =item Bucket => Str
4937  
4938 =item [Delimiter => Str]
4939  
4940 =item [EncodingType => Str]
4941  
4942 =item [ExpectedBucketOwner => Str]
4943  
4944 =item [KeyMarker => Str]
4945  
4946 =item [MaxUploads => Int]
4947  
4948 =item [Prefix => Str]
4949  
4950 =item [UploadIdMarker => Str]
4951  
4952  
4953 =back
4954  
4955 Each argument is described in detail in: L<Paws::S3::ListMultipartUploads>
4956  
4957 Returns: a L<Paws::S3::ListMultipartUploadsOutput> instance
4958  
4959 This action lists in-progress multipart uploads. An in-progress
4960 multipart upload is a multipart upload that has been initiated using
4961 the Initiate Multipart Upload request, but has not yet been completed
4962 or aborted.
4963  
4964 This action returns at most 1,000 multipart uploads in the response.
4965 1,000 multipart uploads is the maximum number of uploads a response can
4966 include, which is also the default value. You can further limit the
4967 number of uploads in a response by specifying the C<max-uploads>
4968 parameter in the response. If additional multipart uploads satisfy the
4969 list criteria, the response will contain an C<IsTruncated> element with
4970 the value true. To list the additional multipart uploads, use the
4971 C<key-marker> and C<upload-id-marker> request parameters.
4972  
4973 In the response, the uploads are sorted by key. If your application has
4974 initiated more than one multipart upload using the same object key,
4975 then uploads in the response are first sorted by key. Additionally,
4976 uploads are sorted in ascending order within each key by the upload
4977 initiation time.
4978  
4979 For more information on multipart uploads, see Uploading Objects Using
4980 Multipart Upload
4981 (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html).
4982  
4983 For information on permissions required to use the multipart upload
4984 API, see Multipart Upload and Permissions
4985 (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html).
4986  
4987 The following operations are related to C<ListMultipartUploads>:
4988  
4989 =over
4990  
4991 =item *
4992  
4993 CreateMultipartUpload
4994 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
4995  
4996 =item *
4997  
4998 UploadPart
4999 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
5000  
5001 =item *
5002  
5003 CompleteMultipartUpload
5004 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
5005  
5006 =item *
5007  
5008 ListParts
5009 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
5010  
5011 =item *
5012  
5013 AbortMultipartUpload
5014 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
5015  
5016 =back
5017  
5018  
5019  
5020 =head2 ListObjects
5021  
5022 =over
5023  
5024 =item Bucket => Str
5025  
5026 =item [Delimiter => Str]
5027  
5028 =item [EncodingType => Str]
5029  
5030 =item [ExpectedBucketOwner => Str]
5031  
5032 =item [Marker => Str]
5033  
5034 =item [MaxKeys => Int]
5035  
5036 =item [Prefix => Str]
5037  
5038 =item [RequestPayer => Str]
5039  
5040  
5041 =back
5042  
5043 Each argument is described in detail in: L<Paws::S3::ListObjects>
5044  
5045 Returns: a L<Paws::S3::ListObjectsOutput> instance
5046  
5047 Returns some or all (up to 1,000) of the objects in a bucket. You can
5048 use the request parameters as selection criteria to return a subset of
5049 the objects in a bucket. A 200 OK response can contain valid or invalid
5050 XML. Be sure to design your application to parse the contents of the
5051 response and handle it appropriately.
5052  
5053 This action has been revised. We recommend that you use the newer
5054 version, ListObjectsV2
5055 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html),
5056 when developing applications. For backward compatibility, Amazon S3
5057 continues to support C<ListObjects>.
5058  
5059 The following operations are related to C<ListObjects>:
5060  
5061 =over
5062  
5063 =item *
5064  
5065 ListObjectsV2
5066 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html)
5067  
5068 =item *
5069  
5070 GetObject
5071 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
5072  
5073 =item *
5074  
5075 PutObject
5076 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
5077  
5078 =item *
5079  
5080 CreateBucket
5081 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
5082  
5083 =item *
5084  
5085 ListBuckets
5086 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html)
5087  
5088 =back
5089  
5090  
5091  
5092 =head2 ListObjectsV2
5093  
5094 =over
5095  
5096 =item Bucket => Str
5097  
5098 =item [ContinuationToken => Str]
5099  
5100 =item [Delimiter => Str]
5101  
5102 =item [EncodingType => Str]
5103  
5104 =item [ExpectedBucketOwner => Str]
5105  
5106 =item [FetchOwner => Bool]
5107  
5108 =item [MaxKeys => Int]
5109  
5110 =item [Prefix => Str]
5111  
5112 =item [RequestPayer => Str]
5113  
5114 =item [StartAfter => Str]
5115  
5116  
5117 =back
5118  
5119 Each argument is described in detail in: L<Paws::S3::ListObjectsV2>
5120  
5121 Returns: a L<Paws::S3::ListObjectsV2Output> instance
5122  
5123 Returns some or all (up to 1,000) of the objects in a bucket with each
5124 request. You can use the request parameters as selection criteria to
5125 return a subset of the objects in a bucket. A C<200 OK> response can
5126 contain valid or invalid XML. Make sure to design your application to
5127 parse the contents of the response and handle it appropriately. Objects
5128 are returned sorted in an ascending order of the respective key names
5129 in the list. For more information about listing objects, see Listing
5130 object keys programmatically
5131 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html)
5132  
5133 To use this operation, you must have READ access to the bucket.
5134  
5135 To use this action in an AWS Identity and Access Management (IAM)
5136 policy, you must have permissions to perform the C<s3:ListBucket>
5137 action. The bucket owner has this permission by default and can grant
5138 this permission to others. For more information about permissions, see
5139 Permissions Related to Bucket Subresource Operations
5140 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
5141 and Managing Access Permissions to Your Amazon S3 Resources
5142 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
5143  
5144 This section describes the latest revision of this action. We recommend
5145 that you use this revised API for application development. For backward
5146 compatibility, Amazon S3 continues to support the prior version of this
5147 API, ListObjects
5148 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html).
5149  
5150 To get a list of your buckets, see ListBuckets
5151 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html).
5152  
5153 The following operations are related to C<ListObjectsV2>:
5154  
5155 =over
5156  
5157 =item *
5158  
5159 GetObject
5160 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
5161  
5162 =item *
5163  
5164 PutObject
5165 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
5166  
5167 =item *
5168  
5169 CreateBucket
5170 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
5171  
5172 =back
5173  
5174  
5175  
5176 =head2 ListObjectVersions
5177  
5178 =over
5179  
5180 =item Bucket => Str
5181  
5182 =item [Delimiter => Str]
5183  
5184 =item [EncodingType => Str]
5185  
5186 =item [ExpectedBucketOwner => Str]
5187  
5188 =item [KeyMarker => Str]
5189  
5190 =item [MaxKeys => Int]
5191  
5192 =item [Prefix => Str]
5193  
5194 =item [VersionIdMarker => Str]
5195  
5196  
5197 =back
5198  
5199 Each argument is described in detail in: L<Paws::S3::ListObjectVersions>
5200  
5201 Returns: a L<Paws::S3::ListObjectVersionsOutput> instance
5202  
5203 Returns metadata about all versions of the objects in a bucket. You can
5204 also use request parameters as selection criteria to return metadata
5205 about a subset of all the object versions.
5206  
5207 To use this operation, you must have permissions to perform the
5208 C<s3:ListBucketVersions> action. Be aware of the name difference.
5209  
5210 A 200 OK response can contain valid or invalid XML. Make sure to design
5211 your application to parse the contents of the response and handle it
5212 appropriately.
5213  
5214 To use this operation, you must have READ access to the bucket.
5215  
5216 This action is not supported by Amazon S3 on Outposts.
5217  
5218 The following operations are related to C<ListObjectVersions>:
5219  
5220 =over
5221  
5222 =item *
5223  
5224 ListObjectsV2
5225 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html)
5226  
5227 =item *
5228  
5229 GetObject
5230 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
5231  
5232 =item *
5233  
5234 PutObject
5235 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
5236  
5237 =item *
5238  
5239 DeleteObject
5240 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
5241  
5242 =back
5243  
5244  
5245  
5246 =head2 ListParts
5247  
5248 =over
5249  
5250 =item Bucket => Str
5251  
5252 =item Key => Str
5253  
5254 =item UploadId => Str
5255  
5256 =item [ExpectedBucketOwner => Str]
5257  
5258 =item [MaxParts => Int]
5259  
5260 =item [PartNumberMarker => Int]
5261  
5262 =item [RequestPayer => Str]
5263  
5264  
5265 =back
5266  
5267 Each argument is described in detail in: L<Paws::S3::ListParts>
5268  
5269 Returns: a L<Paws::S3::ListPartsOutput> instance
5270  
5271 Lists the parts that have been uploaded for a specific multipart
5272 upload. This operation must include the upload ID, which you obtain by
5273 sending the initiate multipart upload request (see
5274 CreateMultipartUpload
5275 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)).
5276 This request returns a maximum of 1,000 uploaded parts. The default
5277 number of parts returned is 1,000 parts. You can restrict the number of
5278 parts returned by specifying the C<max-parts> request parameter. If
5279 your multipart upload consists of more than 1,000 parts, the response
5280 returns an C<IsTruncated> field with the value of true, and a
5281 C<NextPartNumberMarker> element. In subsequent C<ListParts> requests
5282 you can include the part-number-marker query string parameter and set
5283 its value to the C<NextPartNumberMarker> field value from the previous
5284 response.
5285  
5286 For more information on multipart uploads, see Uploading Objects Using
5287 Multipart Upload
5288 (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html).
5289  
5290 For information on permissions required to use the multipart upload
5291 API, see Multipart Upload and Permissions
5292 (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html).
5293  
5294 The following operations are related to C<ListParts>:
5295  
5296 =over
5297  
5298 =item *
5299  
5300 CreateMultipartUpload
5301 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
5302  
5303 =item *
5304  
5305 UploadPart
5306 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
5307  
5308 =item *
5309  
5310 CompleteMultipartUpload
5311 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
5312  
5313 =item *
5314  
5315 AbortMultipartUpload
5316 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
5317  
5318 =item *
5319  
5320 ListMultipartUploads
5321 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
5322  
5323 =back
5324  
5325  
5326  
5327 =head2 PutBucketAccelerateConfiguration
5328  
5329 =over
5330  
5331 =item AccelerateConfiguration => L<Paws::S3::AccelerateConfiguration>
5332  
5333 =item Bucket => Str
5334  
5335 =item [ContentLength => Int]
5336  
5337 =item [ExpectedBucketOwner => Str]
5338  
5339  
5340 =back
5341  
5342 Each argument is described in detail in: L<Paws::S3::PutBucketAccelerateConfiguration>
5343  
5344 Returns: nothing
5345  
5346 Sets the accelerate configuration of an existing bucket. Amazon S3
5347 Transfer Acceleration is a bucket-level feature that enables you to
5348 perform faster data transfers to Amazon S3.
5349  
5350 To use this operation, you must have permission to perform the
5351 s3:PutAccelerateConfiguration action. The bucket owner has this
5352 permission by default. The bucket owner can grant this permission to
5353 others. For more information about permissions, see Permissions Related
5354 to Bucket Subresource Operations
5355 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
5356 and Managing Access Permissions to Your Amazon S3 Resources
5357 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
5358  
5359 The Transfer Acceleration state of a bucket can be set to one of the
5360 following two values:
5361  
5362 =over
5363  
5364 =item *
5365  
5366 Enabled E<ndash> Enables accelerated data transfers to the bucket.
5367  
5368 =item *
5369  
5370 Suspended E<ndash> Disables accelerated data transfers to the bucket.
5371  
5372 =back
5373  
5374 The GetBucketAccelerateConfiguration
5375 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html)
5376 action returns the transfer acceleration state of a bucket.
5377  
5378 After setting the Transfer Acceleration state of a bucket to Enabled,
5379 it might take up to thirty minutes before the data transfer rates to
5380 the bucket increase.
5381  
5382 The name of the bucket used for Transfer Acceleration must be
5383 DNS-compliant and must not contain periods (".").
5384  
5385 For more information about transfer acceleration, see Transfer
5386 Acceleration
5387 (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html).
5388  
5389 The following operations are related to
5390 C<PutBucketAccelerateConfiguration>:
5391  
5392 =over
5393  
5394 =item *
5395  
5396 GetBucketAccelerateConfiguration
5397 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html)
5398  
5399 =item *
5400  
5401 CreateBucket
5402 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
5403  
5404 =back
5405  
5406  
5407  
5408 =head2 PutBucketAcl
5409  
5410 =over
5411  
5412 =item Bucket => Str
5413  
5414 =item [AccessControlPolicy => L<Paws::S3::AccessControlPolicy>]
5415  
5416 =item [ACL => Str]
5417  
5418 =item [ContentLength => Int]
5419  
5420 =item [ContentMD5 => Str]
5421  
5422 =item [ExpectedBucketOwner => Str]
5423  
5424 =item [GrantFullControl => Str]
5425  
5426 =item [GrantRead => Str]
5427  
5428 =item [GrantReadACP => Str]
5429  
5430 =item [GrantWrite => Str]
5431  
5432 =item [GrantWriteACP => Str]
5433  
5434  
5435 =back
5436  
5437 Each argument is described in detail in: L<Paws::S3::PutBucketAcl>
5438  
5439 Returns: nothing
5440  
5441 Sets the permissions on an existing bucket using access control lists
5442 (ACL). For more information, see Using ACLs
5443 (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html).
5444 To set the ACL of a bucket, you must have C<WRITE_ACP> permission.
5445  
5446 You can use one of the following two ways to set a bucket's
5447 permissions:
5448  
5449 =over
5450  
5451 =item *
5452  
5453 Specify the ACL in the request body
5454  
5455 =item *
5456  
5457 Specify permissions using request headers
5458  
5459 =back
5460  
5461 You cannot specify access permission using both the body and the
5462 request headers.
5463  
5464 Depending on your application needs, you may choose to set the ACL on a
5465 bucket using either the request body or the headers. For example, if
5466 you have an existing application that updates a bucket ACL using the
5467 request body, then you can continue to use that approach.
5468  
5469 B<Access Permissions>
5470  
5471 You can set access permissions using one of the following methods:
5472  
5473 =over
5474  
5475 =item *
5476  
5477 Specify a canned ACL with the C<x-amz-acl> request header. Amazon S3
5478 supports a set of predefined ACLs, known as I<canned ACLs>. Each canned
5479 ACL has a predefined set of grantees and permissions. Specify the
5480 canned ACL name as the value of C<x-amz-acl>. If you use this header,
5481 you cannot use other access control-specific headers in your request.
5482 For more information, see Canned ACL
5483 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
5484  
5485 =item *
5486  
5487 Specify access permissions explicitly with the C<x-amz-grant-read>,
5488 C<x-amz-grant-read-acp>, C<x-amz-grant-write-acp>, and
5489 C<x-amz-grant-full-control> headers. When using these headers, you
5490 specify explicit access permissions and grantees (AWS accounts or
5491 Amazon S3 groups) who will receive the permission. If you use these
5492 ACL-specific headers, you cannot use the C<x-amz-acl> header to set a
5493 canned ACL. These parameters map to the set of permissions that Amazon
5494 S3 supports in an ACL. For more information, see Access Control List
5495 (ACL) Overview
5496 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html).
5497  
5498 You specify each grantee as a type=value pair, where the type is one of
5499 the following:
5500  
5501 =over
5502  
5503 =item *
5504  
5505 C<id> E<ndash> if the value specified is the canonical user ID of an
5506 AWS account
5507  
5508 =item *
5509  
5510 C<uri> E<ndash> if you are granting permissions to a predefined group
5511  
5512 =item *
5513  
5514 C<emailAddress> E<ndash> if the value specified is the email address of
5515 an AWS account
5516  
5517 Using email addresses to specify a grantee is only supported in the
5518 following AWS Regions:
5519  
5520 =over
5521  
5522 =item *
5523  
5524 US East (N. Virginia)
5525  
5526 =item *
5527  
5528 US West (N. California)
5529  
5530 =item *
5531  
5532 US West (Oregon)
5533  
5534 =item *
5535  
5536 Asia Pacific (Singapore)
5537  
5538 =item *
5539  
5540 Asia Pacific (Sydney)
5541  
5542 =item *
5543  
5544 Asia Pacific (Tokyo)
5545  
5546 =item *
5547  
5548 Europe (Ireland)
5549  
5550 =item *
5551  
5552 South America (SE<atilde>o Paulo)
5553  
5554 =back
5555  
5556 For a list of all the Amazon S3 supported Regions and endpoints, see
5557 Regions and Endpoints
5558 (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in
5559 the AWS General Reference.
5560  
5561 =back
5562  
5563 For example, the following C<x-amz-grant-write> header grants create,
5564 overwrite, and delete objects permission to LogDelivery group
5565 predefined by Amazon S3 and two AWS accounts identified by their email
5566 addresses.
5567  
5568 C<x-amz-grant-write:
5569 uri="http://acs.amazonaws.com/groups/s3/LogDelivery",
5570 id="111122223333", id="555566667777">
5571  
5572 =back
5573  
5574 You can use either a canned ACL or specify access permissions
5575 explicitly. You cannot do both.
5576  
5577 B<Grantee Values>
5578  
5579 You can specify the person (grantee) to whom you're assigning access
5580 rights (using request elements) in the following ways:
5581  
5582 =over
5583  
5584 =item *
5585  
5586 By the person's ID:
5587  
5588 C<E<lt>Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5589 xsi:type="CanonicalUser"E<gt>E<lt>IDE<gt>E<lt>E<gt>IDE<lt>E<gt>E<lt>/IDE<gt>E<lt>DisplayNameE<gt>E<lt>E<gt>GranteesEmailE<lt>E<gt>E<lt>/DisplayNameE<gt>
5590 E<lt>/GranteeE<gt>>
5591  
5592 DisplayName is optional and ignored in the request
5593  
5594 =item *
5595  
5596 By URI:
5597  
5598 C<E<lt>Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5599 xsi:type="Group"E<gt>E<lt>URIE<gt>E<lt>E<gt>http://acs.amazonaws.com/groups/global/AuthenticatedUsersE<lt>E<gt>E<lt>/URIE<gt>E<lt>/GranteeE<gt>>
5600  
5601 =item *
5602  
5603 By Email address:
5604  
5605 C<E<lt>Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5606 xsi:type="AmazonCustomerByEmail"E<gt>E<lt>EmailAddressE<gt>E<lt>E<gt>Grantees@email.comE<lt>E<gt>E<lt>/EmailAddressE<gt>lt;/GranteeE<gt>>
5607  
5608 The grantee is resolved to the CanonicalUser and, in a response to a
5609 GET Object acl request, appears as the CanonicalUser.
5610  
5611 Using email addresses to specify a grantee is only supported in the
5612 following AWS Regions:
5613  
5614 =over
5615  
5616 =item *
5617  
5618 US East (N. Virginia)
5619  
5620 =item *
5621  
5622 US West (N. California)
5623  
5624 =item *
5625  
5626 US West (Oregon)
5627  
5628 =item *
5629  
5630 Asia Pacific (Singapore)
5631  
5632 =item *
5633  
5634 Asia Pacific (Sydney)
5635  
5636 =item *
5637  
5638 Asia Pacific (Tokyo)
5639  
5640 =item *
5641  
5642 Europe (Ireland)
5643  
5644 =item *
5645  
5646 South America (SE<atilde>o Paulo)
5647  
5648 =back
5649  
5650 For a list of all the Amazon S3 supported Regions and endpoints, see
5651 Regions and Endpoints
5652 (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in
5653 the AWS General Reference.
5654  
5655 =back
5656  
5657 B<Related Resources>
5658  
5659 =over
5660  
5661 =item *
5662  
5663 CreateBucket
5664 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
5665  
5666 =item *
5667  
5668 DeleteBucket
5669 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
5670  
5671 =item *
5672  
5673 GetObjectAcl
5674 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html)
5675  
5676 =back
5677  
5678  
5679  
5680 =head2 PutBucketAnalyticsConfiguration
5681  
5682 =over
5683  
5684 =item AnalyticsConfiguration => L<Paws::S3::AnalyticsConfiguration>
5685  
5686 =item Bucket => Str
5687  
5688 =item Id => Str
5689  
5690 =item [ContentLength => Int]
5691  
5692 =item [ExpectedBucketOwner => Str]
5693  
5694  
5695 =back
5696  
5697 Each argument is described in detail in: L<Paws::S3::PutBucketAnalyticsConfiguration>
5698  
5699 Returns: nothing
5700  
5701 Sets an analytics configuration for the bucket (specified by the
5702 analytics configuration ID). You can have up to 1,000 analytics
5703 configurations per bucket.
5704  
5705 You can choose to have storage class analysis export analysis reports
5706 sent to a comma-separated values (CSV) flat file. See the C<DataExport>
5707 request element. Reports are updated daily and are based on the object
5708 filters that you configure. When selecting data export, you specify a
5709 destination bucket and an optional destination prefix where the file is
5710 written. You can export the data to a destination bucket in a different
5711 account. However, the destination bucket must be in the same Region as
5712 the bucket that you are making the PUT analytics configuration to. For
5713 more information, see Amazon S3 Analytics E<ndash> Storage Class
5714 Analysis
5715 (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html).
5716  
5717 You must create a bucket policy on the destination bucket where the
5718 exported file is written to grant permissions to Amazon S3 to write
5719 objects to the bucket. For an example policy, see Granting Permissions
5720 for Amazon S3 Inventory and Storage Class Analysis
5721 (https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9).
5722  
5723 To use this operation, you must have permissions to perform the
5724 C<s3:PutAnalyticsConfiguration> action. The bucket owner has this
5725 permission by default. The bucket owner can grant this permission to
5726 others. For more information about permissions, see Permissions Related
5727 to Bucket Subresource Operations
5728 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
5729 and Managing Access Permissions to Your Amazon S3 Resources
5730 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
5731  
5732 B<Special Errors>
5733  
5734 =over
5735  
5736 =item *
5737  
5738 =over
5739  
5740 =item *
5741  
5742 I<HTTP Error: HTTP 400 Bad Request>
5743  
5744 =item *
5745  
5746 I<Code: InvalidArgument>
5747  
5748 =item *
5749  
5750 I<Cause: Invalid argument.>
5751  
5752 =back
5753  
5754 =item *
5755  
5756 =over
5757  
5758 =item *
5759  
5760 I<HTTP Error: HTTP 400 Bad Request>
5761  
5762 =item *
5763  
5764 I<Code: TooManyConfigurations>
5765  
5766 =item *
5767  
5768 I<Cause: You are attempting to create a new configuration but have
5769 already reached the 1,000-configuration limit.>
5770  
5771 =back
5772  
5773 =item *
5774  
5775 =over
5776  
5777 =item *
5778  
5779 I<HTTP Error: HTTP 403 Forbidden>
5780  
5781 =item *
5782  
5783 I<Code: AccessDenied>
5784  
5785 =item *
5786  
5787 I<Cause: You are not the owner of the specified bucket, or you do not
5788 have the s3:PutAnalyticsConfiguration bucket permission to set the
5789 configuration on the bucket.>
5790  
5791 =back
5792  
5793 =back
5794  
5795 B<Related Resources>
5796  
5797 =over
5798  
5799 =item *
5800  
5801 GetBucketAnalyticsConfiguration
5802 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html)
5803  
5804 =item *
5805  
5806 DeleteBucketAnalyticsConfiguration
5807 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html)
5808  
5809 =item *
5810  
5811 ListBucketAnalyticsConfigurations
5812 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html)
5813  
5814 =back
5815  
5816  
5817  
5818 =head2 PutBucketCors
5819  
5820 =over
5821  
5822 =item Bucket => Str
5823  
5824 =item CORSConfiguration => L<Paws::S3::CORSConfiguration>
5825  
5826 =item [ContentLength => Int]
5827  
5828 =item [ContentMD5 => Str]
5829  
5830 =item [ExpectedBucketOwner => Str]
5831  
5832  
5833 =back
5834  
5835 Each argument is described in detail in: L<Paws::S3::PutBucketCors>
5836  
5837 Returns: nothing
5838  
5839 Sets the C<cors> configuration for your bucket. If the configuration
5840 exists, Amazon S3 replaces it.
5841  
5842 To use this operation, you must be allowed to perform the
5843 C<s3:PutBucketCORS> action. By default, the bucket owner has this
5844 permission and can grant it to others.
5845  
5846 You set this configuration on a bucket so that the bucket can service
5847 cross-origin requests. For example, you might want to enable a request
5848 whose origin is C<http://www.example.com> to access your Amazon S3
5849 bucket at C<my.example.bucket.com> by using the browser's
5850 C<XMLHttpRequest> capability.
5851  
5852 To enable cross-origin resource sharing (CORS) on a bucket, you add the
5853 C<cors> subresource to the bucket. The C<cors> subresource is an XML
5854 document in which you configure rules that identify origins and the
5855 HTTP methods that can be executed on your bucket. The document is
5856 limited to 64 KB in size.
5857  
5858 When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS
5859 request) against a bucket, it evaluates the C<cors> configuration on
5860 the bucket and uses the first C<CORSRule> rule that matches the
5861 incoming browser request to enable a cross-origin request. For a rule
5862 to match, the following conditions must be met:
5863  
5864 =over
5865  
5866 =item *
5867  
5868 The request's C<Origin> header must match C<AllowedOrigin> elements.
5869  
5870 =item *
5871  
5872 The request method (for example, GET, PUT, HEAD, and so on) or the
5873 C<Access-Control-Request-Method> header in case of a pre-flight
5874 C<OPTIONS> request must be one of the C<AllowedMethod> elements.
5875  
5876 =item *
5877  
5878 Every header specified in the C<Access-Control-Request-Headers> request
5879 header of a pre-flight request must match an C<AllowedHeader> element.
5880  
5881 =back
5882  
5883 For more information about CORS, go to Enabling Cross-Origin Resource
5884 Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in
5885 the I<Amazon S3 User Guide>.
5886  
5887 B<Related Resources>
5888  
5889 =over
5890  
5891 =item *
5892  
5893 GetBucketCors
5894 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html)
5895  
5896 =item *
5897  
5898 DeleteBucketCors
5899 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html)
5900  
5901 =item *
5902  
5903 RESTOPTIONSobject
5904 (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html)
5905  
5906 =back
5907  
5908  
5909  
5910 =head2 PutBucketEncryption
5911  
5912 =over
5913  
5914 =item Bucket => Str
5915  
5916 =item ServerSideEncryptionConfiguration => L<Paws::S3::ServerSideEncryptionConfiguration>
5917  
5918 =item [ContentLength => Int]
5919  
5920 =item [ContentMD5 => Str]
5921  
5922 =item [ExpectedBucketOwner => Str]
5923  
5924  
5925 =back
5926  
5927 Each argument is described in detail in: L<Paws::S3::PutBucketEncryption>
5928  
5929 Returns: nothing
5930  
5931 This action uses the C<encryption> subresource to configure default
5932 encryption and Amazon S3 Bucket Key for an existing bucket.
5933  
5934 Default encryption for a bucket can use server-side encryption with
5935 Amazon S3-managed keys (SSE-S3) or AWS KMS customer master keys
5936 (SSE-KMS). If you specify default encryption using SSE-KMS, you can
5937 also configure Amazon S3 Bucket Key. For information about default
5938 encryption, see Amazon S3 default bucket encryption
5939 (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html)
5940 in the I<Amazon S3 User Guide>. For more information about S3 Bucket
5941 Keys, see Amazon S3 Bucket Keys
5942 (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in
5943 the I<Amazon S3 User Guide>.
5944  
5945 This action requires AWS Signature Version 4. For more information, see
5946 Authenticating Requests (AWS Signature Version 4)
5947 (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html).
5948  
5949 To use this operation, you must have permissions to perform the
5950 C<s3:PutEncryptionConfiguration> action. The bucket owner has this
5951 permission by default. The bucket owner can grant this permission to
5952 others. For more information about permissions, see Permissions Related
5953 to Bucket Subresource Operations
5954 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
5955 and Managing Access Permissions to Your Amazon S3 Resources
5956 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
5957 in the Amazon S3 User Guide.
5958  
5959 B<Related Resources>
5960  
5961 =over
5962  
5963 =item *
5964  
5965 GetBucketEncryption
5966 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html)
5967  
5968 =item *
5969  
5970 DeleteBucketEncryption
5971 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html)
5972  
5973 =back
5974  
5975  
5976  
5977 =head2 PutBucketIntelligentTieringConfiguration
5978  
5979 =over
5980  
5981 =item Bucket => Str
5982  
5983 =item Id => Str
5984  
5985 =item IntelligentTieringConfiguration => L<Paws::S3::IntelligentTieringConfiguration>
5986  
5987  
5988 =back
5989  
5990 Each argument is described in detail in: L<Paws::S3::PutBucketIntelligentTieringConfiguration>
5991  
5992 Returns: nothing
5993  
5994 Puts a S3 Intelligent-Tiering configuration to the specified bucket.
5995 You can have up to 1,000 S3 Intelligent-Tiering configurations per
5996 bucket.
5997  
5998 The S3 Intelligent-Tiering storage class is designed to optimize
5999 storage costs by automatically moving data to the most cost-effective
6000 storage access tier, without additional operational overhead. S3
6001 Intelligent-Tiering delivers automatic cost savings by moving data
6002 between access tiers, when access patterns change.
6003  
6004 The S3 Intelligent-Tiering storage class is suitable for objects larger
6005 than 128 KB that you plan to store for at least 30 days. If the size of
6006 an object is less than 128 KB, it is not eligible for auto-tiering.
6007 Smaller objects can be stored, but they are always charged at the
6008 frequent access tier rates in the S3 Intelligent-Tiering storage class.
6009  
6010 If you delete an object before the end of the 30-day minimum storage
6011 duration period, you are charged for 30 days. For more information, see
6012 Storage class for automatically optimizing frequently and infrequently
6013 accessed objects
6014 (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access).
6015  
6016 Operations related to C<PutBucketIntelligentTieringConfiguration>
6017 include:
6018  
6019 =over
6020  
6021 =item *
6022  
6023 DeleteBucketIntelligentTieringConfiguration
6024 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html)
6025  
6026 =item *
6027  
6028 GetBucketIntelligentTieringConfiguration
6029 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html)
6030  
6031 =item *
6032  
6033 ListBucketIntelligentTieringConfigurations
6034 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html)
6035  
6036 =back
6037  
6038 You only need S3 Intelligent-Tiering enabled on a bucket if you want to
6039 automatically move objects stored in the S3 Intelligent-Tiering storage
6040 class to the Archive Access or Deep Archive Access tier.
6041  
6042 B<Special Errors>
6043  
6044 =over
6045  
6046 =item *
6047  
6048 B<HTTP 400 Bad Request Error>
6049  
6050 =over
6051  
6052 =item *
6053  
6054 I<Code:> InvalidArgument
6055  
6056 =item *
6057  
6058 I<Cause:> Invalid Argument
6059  
6060 =back
6061  
6062 =item *
6063  
6064 B<HTTP 400 Bad Request Error>
6065  
6066 =over
6067  
6068 =item *
6069  
6070 I<Code:> TooManyConfigurations
6071  
6072 =item *
6073  
6074 I<Cause:> You are attempting to create a new configuration but have
6075 already reached the 1,000-configuration limit.
6076  
6077 =back
6078  
6079 =item *
6080  
6081 B<HTTP 403 Forbidden Error>
6082  
6083 =over
6084  
6085 =item *
6086  
6087 I<Code:> AccessDenied
6088  
6089 =item *
6090  
6091 I<Cause:> You are not the owner of the specified bucket, or you do not
6092 have the C<s3:PutIntelligentTieringConfiguration> bucket permission to
6093 set the configuration on the bucket.
6094  
6095 =back
6096  
6097 =back
6098  
6099  
6100  
6101 =head2 PutBucketInventoryConfiguration
6102  
6103 =over
6104  
6105 =item Bucket => Str
6106  
6107 =item Id => Str
6108  
6109 =item InventoryConfiguration => L<Paws::S3::InventoryConfiguration>
6110  
6111 =item [ContentLength => Int]
6112  
6113 =item [ExpectedBucketOwner => Str]
6114  
6115  
6116 =back
6117  
6118 Each argument is described in detail in: L<Paws::S3::PutBucketInventoryConfiguration>
6119  
6120 Returns: nothing
6121  
6122 This implementation of the C<PUT> action adds an inventory
6123 configuration (identified by the inventory ID) to the bucket. You can
6124 have up to 1,000 inventory configurations per bucket.
6125  
6126 Amazon S3 inventory generates inventories of the objects in the bucket
6127 on a daily or weekly basis, and the results are published to a flat
6128 file. The bucket that is inventoried is called the I<source> bucket,
6129 and the bucket where the inventory flat file is stored is called the
6130 I<destination> bucket. The I<destination> bucket must be in the same
6131 AWS Region as the I<source> bucket.
6132  
6133 When you configure an inventory for a I<source> bucket, you specify the
6134 I<destination> bucket where you want the inventory to be stored, and
6135 whether to generate the inventory daily or weekly. You can also
6136 configure what object metadata to include and whether to inventory all
6137 object versions or only current versions. For more information, see
6138 Amazon S3 Inventory
6139 (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html)
6140 in the Amazon S3 User Guide.
6141  
6142 You must create a bucket policy on the I<destination> bucket to grant
6143 permissions to Amazon S3 to write objects to the bucket in the defined
6144 location. For an example policy, see Granting Permissions for Amazon S3
6145 Inventory and Storage Class Analysis
6146 (https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9).
6147  
6148 To use this operation, you must have permissions to perform the
6149 C<s3:PutInventoryConfiguration> action. The bucket owner has this
6150 permission by default and can grant this permission to others. For more
6151 information about permissions, see Permissions Related to Bucket
6152 Subresource Operations
6153 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
6154 and Managing Access Permissions to Your Amazon S3 Resources
6155 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
6156 in the Amazon S3 User Guide.
6157  
6158 B<Special Errors>
6159  
6160 =over
6161  
6162 =item *
6163  
6164 B<HTTP 400 Bad Request Error>
6165  
6166 =over
6167  
6168 =item *
6169  
6170 I<Code:> InvalidArgument
6171  
6172 =item *
6173  
6174 I<Cause:> Invalid Argument
6175  
6176 =back
6177  
6178 =item *
6179  
6180 B<HTTP 400 Bad Request Error>
6181  
6182 =over
6183  
6184 =item *
6185  
6186 I<Code:> TooManyConfigurations
6187  
6188 =item *
6189  
6190 I<Cause:> You are attempting to create a new configuration but have
6191 already reached the 1,000-configuration limit.
6192  
6193 =back
6194  
6195 =item *
6196  
6197 B<HTTP 403 Forbidden Error>
6198  
6199 =over
6200  
6201 =item *
6202  
6203 I<Code:> AccessDenied
6204  
6205 =item *
6206  
6207 I<Cause:> You are not the owner of the specified bucket, or you do not
6208 have the C<s3:PutInventoryConfiguration> bucket permission to set the
6209 configuration on the bucket.
6210  
6211 =back
6212  
6213 =back
6214  
6215 B<Related Resources>
6216  
6217 =over
6218  
6219 =item *
6220  
6221 GetBucketInventoryConfiguration
6222 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html)
6223  
6224 =item *
6225  
6226 DeleteBucketInventoryConfiguration
6227 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html)
6228  
6229 =item *
6230  
6231 ListBucketInventoryConfigurations
6232 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html)
6233  
6234 =back
6235  
6236  
6237  
6238 =head2 PutBucketLifecycle
6239  
6240 =over
6241  
6242 =item Bucket => Str
6243  
6244 =item [ContentLength => Int]
6245  
6246 =item [ContentMD5 => Str]
6247  
6248 =item [ExpectedBucketOwner => Str]
6249  
6250 =item [LifecycleConfiguration => L<Paws::S3::LifecycleConfiguration>]
6251  
6252  
6253 =back
6254  
6255 Each argument is described in detail in: L<Paws::S3::PutBucketLifecycle>
6256  
6257 Returns: nothing
6258  
6259 For an updated version of this API, see PutBucketLifecycleConfiguration
6260 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html).
6261 This version has been deprecated. Existing lifecycle configurations
6262 will work. For new lifecycle configurations, use the updated API.
6263  
6264 Creates a new lifecycle configuration for the bucket or replaces an
6265 existing lifecycle configuration. For information about lifecycle
6266 configuration, see Object Lifecycle Management
6267 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html)
6268 in the I<Amazon S3 User Guide>.
6269  
6270 By default, all Amazon S3 resources, including buckets, objects, and
6271 related subresources (for example, lifecycle configuration and website
6272 configuration) are private. Only the resource owner, the AWS account
6273 that created the resource, can access it. The resource owner can
6274 optionally grant access permissions to others by writing an access
6275 policy. For this operation, users must get the
6276 C<s3:PutLifecycleConfiguration> permission.
6277  
6278 You can also explicitly deny permissions. Explicit denial also
6279 supersedes any other permissions. If you want to prevent users or
6280 accounts from removing or deleting objects from your bucket, you must
6281 deny them permissions for the following actions:
6282  
6283 =over
6284  
6285 =item *
6286  
6287 C<s3:DeleteObject>
6288  
6289 =item *
6290  
6291 C<s3:DeleteObjectVersion>
6292  
6293 =item *
6294  
6295 C<s3:PutLifecycleConfiguration>
6296  
6297 =back
6298  
6299 For more information about permissions, see Managing Access Permissions
6300 to your Amazon S3 Resources
6301 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
6302 in the I<Amazon S3 User Guide>.
6303  
6304 For more examples of transitioning objects to storage classes such as
6305 STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration
6306 (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples).
6307  
6308 B<Related Resources>
6309  
6310 =over
6311  
6312 =item *
6313  
6314 GetBucketLifecycle
6315 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html)(Deprecated)
6316  
6317 =item *
6318  
6319 GetBucketLifecycleConfiguration
6320 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)
6321  
6322 =item *
6323  
6324 RestoreObject
6325 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html)
6326  
6327 =item *
6328  
6329 By default, a resource ownerE<mdash>in this case, a bucket owner, which
6330 is the AWS account that created the bucketE<mdash>can perform any of
6331 the operations. A resource owner can also grant others permission to
6332 perform the operation. For more information, see the following topics
6333 in the Amazon S3 User Guide:
6334  
6335 =over
6336  
6337 =item *
6338  
6339 Specifying Permissions in a Policy
6340 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html)
6341  
6342 =item *
6343  
6344 Managing Access Permissions to your Amazon S3 Resources
6345 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
6346  
6347 =back
6348  
6349 =back
6350  
6351  
6352  
6353 =head2 PutBucketLifecycleConfiguration
6354  
6355 =over
6356  
6357 =item Bucket => Str
6358  
6359 =item [ExpectedBucketOwner => Str]
6360  
6361 =item [LifecycleConfiguration => L<Paws::S3::BucketLifecycleConfiguration>]
6362  
6363  
6364 =back
6365  
6366 Each argument is described in detail in: L<Paws::S3::PutBucketLifecycleConfiguration>
6367  
6368 Returns: nothing
6369  
6370 Creates a new lifecycle configuration for the bucket or replaces an
6371 existing lifecycle configuration. For information about lifecycle
6372 configuration, see Managing your storage lifecycle
6373 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html).
6374  
6375 Bucket lifecycle configuration now supports specifying a lifecycle rule
6376 using an object key name prefix, one or more object tags, or a
6377 combination of both. Accordingly, this section describes the latest
6378 API. The previous version of the API supported filtering based only on
6379 an object key name prefix, which is supported for backward
6380 compatibility. For the related API description, see PutBucketLifecycle
6381 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html).
6382  
6383 B<Rules>
6384  
6385 You specify the lifecycle configuration in your request body. The
6386 lifecycle configuration is specified as XML consisting of one or more
6387 rules. Each rule consists of the following:
6388  
6389 =over
6390  
6391 =item *
6392  
6393 Filter identifying a subset of objects to which the rule applies. The
6394 filter can be based on a key name prefix, object tags, or a combination
6395 of both.
6396  
6397 =item *
6398  
6399 Status whether the rule is in effect.
6400  
6401 =item *
6402  
6403 One or more lifecycle transition and expiration actions that you want
6404 Amazon S3 to perform on the objects identified by the filter. If the
6405 state of your bucket is versioning-enabled or versioning-suspended, you
6406 can have many versions of the same object (one current version and zero
6407 or more noncurrent versions). Amazon S3 provides predefined actions
6408 that you can specify for current and noncurrent object versions.
6409  
6410 =back
6411  
6412 For more information, see Object Lifecycle Management
6413 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html)
6414 and Lifecycle Configuration Elements
6415 (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html).
6416  
6417 B<Permissions>
6418  
6419 By default, all Amazon S3 resources are private, including buckets,
6420 objects, and related subresources (for example, lifecycle configuration
6421 and website configuration). Only the resource owner (that is, the AWS
6422 account that created it) can access the resource. The resource owner
6423 can optionally grant access permissions to others by writing an access
6424 policy. For this operation, a user must get the
6425 s3:PutLifecycleConfiguration permission.
6426  
6427 You can also explicitly deny permissions. Explicit deny also supersedes
6428 any other permissions. If you want to block users or accounts from
6429 removing or deleting objects from your bucket, you must deny them
6430 permissions for the following actions:
6431  
6432 =over
6433  
6434 =item *
6435  
6436 s3:DeleteObject
6437  
6438 =item *
6439  
6440 s3:DeleteObjectVersion
6441  
6442 =item *
6443  
6444 s3:PutLifecycleConfiguration
6445  
6446 =back
6447  
6448 For more information about permissions, see Managing Access Permissions
6449 to Your Amazon S3 Resources
6450 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
6451  
6452 The following are related to C<PutBucketLifecycleConfiguration>:
6453  
6454 =over
6455  
6456 =item *
6457  
6458 Examples of Lifecycle Configuration
6459 (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html)
6460  
6461 =item *
6462  
6463 GetBucketLifecycleConfiguration
6464 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)
6465  
6466 =item *
6467  
6468 DeleteBucketLifecycle
6469 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html)
6470  
6471 =back
6472  
6473  
6474  
6475 =head2 PutBucketLogging
6476  
6477 =over
6478  
6479 =item Bucket => Str
6480  
6481 =item BucketLoggingStatus => L<Paws::S3::BucketLoggingStatus>
6482  
6483 =item [ContentLength => Int]
6484  
6485 =item [ContentMD5 => Str]
6486  
6487 =item [ExpectedBucketOwner => Str]
6488  
6489  
6490 =back
6491  
6492 Each argument is described in detail in: L<Paws::S3::PutBucketLogging>
6493  
6494 Returns: nothing
6495  
6496 Set the logging parameters for a bucket and to specify permissions for
6497 who can view and modify the logging parameters. All logs are saved to
6498 buckets in the same AWS Region as the source bucket. To set the logging
6499 status of a bucket, you must be the bucket owner.
6500  
6501 The bucket owner is automatically granted FULL_CONTROL to all logs. You
6502 use the C<Grantee> request element to grant access to other people. The
6503 C<Permissions> request element specifies the kind of access the grantee
6504 has to the logs.
6505  
6506 B<Grantee Values>
6507  
6508 You can specify the person (grantee) to whom you're assigning access
6509 rights (using request elements) in the following ways:
6510  
6511 =over
6512  
6513 =item *
6514  
6515 By the person's ID:
6516  
6517 C<E<lt>Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6518 xsi:type="CanonicalUser"E<gt>E<lt>IDE<gt>E<lt>E<gt>IDE<lt>E<gt>E<lt>/IDE<gt>E<lt>DisplayNameE<gt>E<lt>E<gt>GranteesEmailE<lt>E<gt>E<lt>/DisplayNameE<gt>
6519 E<lt>/GranteeE<gt>>
6520  
6521 DisplayName is optional and ignored in the request.
6522  
6523 =item *
6524  
6525 By Email address:
6526  
6527 C<E<lt>Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6528 xsi:type="AmazonCustomerByEmail"E<gt>E<lt>EmailAddressE<gt>E<lt>E<gt>Grantees@email.comE<lt>E<gt>E<lt>/EmailAddressE<gt>E<lt>/GranteeE<gt>>
6529  
6530 The grantee is resolved to the CanonicalUser and, in a response to a
6531 GET Object acl request, appears as the CanonicalUser.
6532  
6533 =item *
6534  
6535 By URI:
6536  
6537 C<E<lt>Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6538 xsi:type="Group"E<gt>E<lt>URIE<gt>E<lt>E<gt>http://acs.amazonaws.com/groups/global/AuthenticatedUsersE<lt>E<gt>E<lt>/URIE<gt>E<lt>/GranteeE<gt>>
6539  
6540 =back
6541  
6542 To enable logging, you use LoggingEnabled and its children request
6543 elements. To disable logging, you use an empty BucketLoggingStatus
6544 request element:
6545  
6546 C<E<lt>BucketLoggingStatus
6547 xmlns="http://doc.s3.amazonaws.com/2006-03-01" /E<gt>>
6548  
6549 For more information about server access logging, see Server Access
6550 Logging
6551 (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerLogs.html).
6552  
6553 For more information about creating a bucket, see CreateBucket
6554 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html).
6555 For more information about returning the logging status of a bucket,
6556 see GetBucketLogging
6557 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html).
6558  
6559 The following operations are related to C<PutBucketLogging>:
6560  
6561 =over
6562  
6563 =item *
6564  
6565 PutObject
6566 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
6567  
6568 =item *
6569  
6570 DeleteBucket
6571 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
6572  
6573 =item *
6574  
6575 CreateBucket
6576 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
6577  
6578 =item *
6579  
6580 GetBucketLogging
6581 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html)
6582  
6583 =back
6584  
6585  
6586  
6587 =head2 PutBucketMetricsConfiguration
6588  
6589 =over
6590  
6591 =item Bucket => Str
6592  
6593 =item Id => Str
6594  
6595 =item MetricsConfiguration => L<Paws::S3::MetricsConfiguration>
6596  
6597 =item [ContentLength => Int]
6598  
6599 =item [ExpectedBucketOwner => Str]
6600  
6601  
6602 =back
6603  
6604 Each argument is described in detail in: L<Paws::S3::PutBucketMetricsConfiguration>
6605  
6606 Returns: nothing
6607  
6608 Sets a metrics configuration (specified by the metrics configuration
6609 ID) for the bucket. You can have up to 1,000 metrics configurations per
6610 bucket. If you're updating an existing metrics configuration, note that
6611 this is a full replacement of the existing metrics configuration. If
6612 you don't include the elements you want to keep, they are erased.
6613  
6614 To use this operation, you must have permissions to perform the
6615 C<s3:PutMetricsConfiguration> action. The bucket owner has this
6616 permission by default. The bucket owner can grant this permission to
6617 others. For more information about permissions, see Permissions Related
6618 to Bucket Subresource Operations
6619 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
6620 and Managing Access Permissions to Your Amazon S3 Resources
6621 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
6622  
6623 For information about CloudWatch request metrics for Amazon S3, see
6624 Monitoring Metrics with Amazon CloudWatch
6625 (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html).
6626  
6627 The following operations are related to
6628 C<PutBucketMetricsConfiguration>:
6629  
6630 =over
6631  
6632 =item *
6633  
6634 DeleteBucketMetricsConfiguration
6635 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html)
6636  
6637 =item *
6638  
6639 PutBucketMetricsConfiguration
6640 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html)
6641  
6642 =item *
6643  
6644 ListBucketMetricsConfigurations
6645 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html)
6646  
6647 =back
6648  
6649 C<GetBucketLifecycle> has the following special error:
6650  
6651 =over
6652  
6653 =item *
6654  
6655 Error code: C<TooManyConfigurations>
6656  
6657 =over
6658  
6659 =item *
6660  
6661 Description: You are attempting to create a new configuration but have
6662 already reached the 1,000-configuration limit.
6663  
6664 =item *
6665  
6666 HTTP Status Code: HTTP 400 Bad Request
6667  
6668 =back
6669  
6670 =back
6671  
6672  
6673  
6674 =head2 PutBucketNotification
6675  
6676 =over
6677  
6678 =item Bucket => Str
6679  
6680 =item NotificationConfiguration => L<Paws::S3::NotificationConfigurationDeprecated>
6681  
6682 =item [ContentLength => Int]
6683  
6684 =item [ContentMD5 => Str]
6685  
6686 =item [ExpectedBucketOwner => Str]
6687  
6688  
6689 =back
6690  
6691 Each argument is described in detail in: L<Paws::S3::PutBucketNotification>
6692  
6693 Returns: nothing
6694  
6695 No longer used, see the PutBucketNotificationConfiguration
6696 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotificationConfiguration.html)
6697 operation.
6698  
6699  
6700 =head2 PutBucketNotificationConfiguration
6701  
6702 =over
6703  
6704 =item Bucket => Str
6705  
6706 =item NotificationConfiguration => L<Paws::S3::NotificationConfiguration>
6707  
6708 =item [ExpectedBucketOwner => Str]
6709  
6710  
6711 =back
6712  
6713 Each argument is described in detail in: L<Paws::S3::PutBucketNotificationConfiguration>
6714  
6715 Returns: nothing
6716  
6717 Enables notifications of specified events for a bucket. For more
6718 information about event notifications, see Configuring Event
6719 Notifications
6720 (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html).
6721  
6722 Using this API, you can replace an existing notification configuration.
6723 The configuration is an XML file that defines the event types that you
6724 want Amazon S3 to publish and the destination where you want Amazon S3
6725 to publish an event notification when it detects an event of the
6726 specified type.
6727  
6728 By default, your bucket has no event notifications configured. That is,
6729 the notification configuration will be an empty
6730 C<NotificationConfiguration>.
6731  
6732 C<E<lt>NotificationConfigurationE<gt>>
6733  
6734 C<E<lt>/NotificationConfigurationE<gt>>
6735  
6736 This action replaces the existing notification configuration with the
6737 configuration you include in the request body.
6738  
6739 After Amazon S3 receives this request, it first verifies that any
6740 Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue
6741 Service (Amazon SQS) destination exists, and that the bucket owner has
6742 permission to publish to it by sending a test notification. In the case
6743 of AWS Lambda destinations, Amazon S3 verifies that the Lambda function
6744 permissions grant Amazon S3 permission to invoke the function from the
6745 Amazon S3 bucket. For more information, see Configuring Notifications
6746 for Amazon S3 Events
6747 (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html).
6748  
6749 You can disable notifications by adding the empty
6750 NotificationConfiguration element.
6751  
6752 By default, only the bucket owner can configure notifications on a
6753 bucket. However, bucket owners can use a bucket policy to grant
6754 permission to other users to set this configuration with
6755 C<s3:PutBucketNotification> permission.
6756  
6757 The PUT notification is an atomic operation. For example, suppose your
6758 notification configuration includes SNS topic, SQS queue, and Lambda
6759 function configurations. When you send a PUT request with this
6760 configuration, Amazon S3 sends test messages to your SNS topic. If the
6761 message fails, the entire PUT action will fail, and Amazon S3 will not
6762 add the configuration to your bucket.
6763  
6764 B<Responses>
6765  
6766 If the configuration in the request body includes only one
6767 C<TopicConfiguration> specifying only the
6768 C<s3:ReducedRedundancyLostObject> event type, the response will also
6769 include the C<x-amz-sns-test-message-id> header containing the message
6770 ID of the test notification sent to the topic.
6771  
6772 The following action is related to
6773 C<PutBucketNotificationConfiguration>:
6774  
6775 =over
6776  
6777 =item *
6778  
6779 GetBucketNotificationConfiguration
6780 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html)
6781  
6782 =back
6783  
6784  
6785  
6786 =head2 PutBucketOwnershipControls
6787  
6788 =over
6789  
6790 =item Bucket => Str
6791  
6792 =item OwnershipControls => L<Paws::S3::OwnershipControls>
6793  
6794 =item [ContentLength => Int]
6795  
6796 =item [ContentMD5 => Str]
6797  
6798 =item [ExpectedBucketOwner => Str]
6799  
6800  
6801 =back
6802  
6803 Each argument is described in detail in: L<Paws::S3::PutBucketOwnershipControls>
6804  
6805 Returns: nothing
6806  
6807 Creates or modifies C<OwnershipControls> for an Amazon S3 bucket. To
6808 use this operation, you must have the C<s3:PutBucketOwnershipControls>
6809 permission. For more information about Amazon S3 permissions, see
6810 Specifying Permissions in a Policy
6811 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
6812  
6813 For information about Amazon S3 Object Ownership, see Using Object
6814 Ownership
6815 (https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html).
6816  
6817 The following operations are related to C<PutBucketOwnershipControls>:
6818  
6819 =over
6820  
6821 =item *
6822  
6823 GetBucketOwnershipControls
6824  
6825 =item *
6826  
6827 DeleteBucketOwnershipControls
6828  
6829 =back
6830  
6831  
6832  
6833 =head2 PutBucketPolicy
6834  
6835 =over
6836  
6837 =item Bucket => Str
6838  
6839 =item Policy => Str
6840  
6841 =item [ConfirmRemoveSelfBucketAccess => Bool]
6842  
6843 =item [ContentMD5 => Str]
6844  
6845 =item [ExpectedBucketOwner => Str]
6846  
6847  
6848 =back
6849  
6850 Each argument is described in detail in: L<Paws::S3::PutBucketPolicy>
6851  
6852 Returns: nothing
6853  
6854 Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are
6855 using an identity other than the root user of the AWS account that owns
6856 the bucket, the calling identity must have the C<PutBucketPolicy>
6857 permissions on the specified bucket and belong to the bucket owner's
6858 account in order to use this operation.
6859  
6860 If you don't have C<PutBucketPolicy> permissions, Amazon S3 returns a
6861 C<403 Access Denied> error. If you have the correct permissions, but
6862 you're not using an identity that belongs to the bucket owner's
6863 account, Amazon S3 returns a C<405 Method Not Allowed> error.
6864  
6865 As a security precaution, the root user of the AWS account that owns a
6866 bucket can always use this operation, even if the policy explicitly
6867 denies the root user the ability to perform this action.
6868  
6869 For more information about bucket policies, see Using Bucket Policies
6870 and User Policies
6871 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html).
6872  
6873 The following operations are related to C<PutBucketPolicy>:
6874  
6875 =over
6876  
6877 =item *
6878  
6879 CreateBucket
6880 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
6881  
6882 =item *
6883  
6884 DeleteBucket
6885 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
6886  
6887 =back
6888  
6889  
6890  
6891 =head2 PutBucketReplication
6892  
6893 =over
6894  
6895 =item Bucket => Str
6896  
6897 =item ReplicationConfiguration => L<Paws::S3::ReplicationConfiguration>
6898  
6899 =item [ContentLength => Int]
6900  
6901 =item [ContentMD5 => Str]
6902  
6903 =item [ExpectedBucketOwner => Str]
6904  
6905 =item [Token => Str]
6906  
6907  
6908 =back
6909  
6910 Each argument is described in detail in: L<Paws::S3::PutBucketReplication>
6911  
6912 Returns: nothing
6913  
6914 Creates a replication configuration or replaces an existing one. For
6915 more information, see Replication
6916 (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in
6917 the I<Amazon S3 User Guide>.
6918  
6919 To perform this operation, the user or role performing the action must
6920 have the iam:PassRole
6921 (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html)
6922 permission.
6923  
6924 Specify the replication configuration in the request body. In the
6925 replication configuration, you provide the name of the destination
6926 bucket or buckets where you want Amazon S3 to replicate objects, the
6927 IAM role that Amazon S3 can assume to replicate objects on your behalf,
6928 and other relevant information.
6929  
6930 A replication configuration must include at least one rule, and can
6931 contain a maximum of 1,000. Each rule identifies a subset of objects to
6932 replicate by filtering the objects in the source bucket. To choose
6933 additional subsets of objects to replicate, add a rule for each subset.
6934  
6935 To specify a subset of the objects in the source bucket to apply a
6936 replication rule to, add the Filter element as a child of the Rule
6937 element. You can filter objects based on an object key prefix, one or
6938 more object tags, or both. When you add the Filter element in the
6939 configuration, you must also add the following elements:
6940 C<DeleteMarkerReplication>, C<Status>, and C<Priority>.
6941  
6942 If you are using an earlier version of the replication configuration,
6943 Amazon S3 handles replication of delete markers differently. For more
6944 information, see Backward Compatibility
6945 (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations).
6946  
6947 For information about enabling versioning on a bucket, see Using
6948 Versioning
6949 (https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html).
6950  
6951 By default, a resource owner, in this case the AWS account that created
6952 the bucket, can perform this operation. The resource owner can also
6953 grant others permissions to perform the operation. For more information
6954 about permissions, see Specifying Permissions in a Policy
6955 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html)
6956 and Managing Access Permissions to Your Amazon S3 Resources
6957 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
6958  
6959 B<Handling Replication of Encrypted Objects>
6960  
6961 By default, Amazon S3 doesn't replicate objects that are stored at rest
6962 using server-side encryption with CMKs stored in AWS KMS. To replicate
6963 AWS KMS-encrypted objects, add the following:
6964 C<SourceSelectionCriteria>, C<SseKmsEncryptedObjects>, C<Status>,
6965 C<EncryptionConfiguration>, and C<ReplicaKmsKeyID>. For information
6966 about replication configuration, see Replicating Objects Created with
6967 SSE Using CMKs stored in AWS KMS
6968 (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html).
6969  
6970 For information on C<PutBucketReplication> errors, see List of
6971 replication-related error codes
6972 (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList)
6973  
6974 The following operations are related to C<PutBucketReplication>:
6975  
6976 =over
6977  
6978 =item *
6979  
6980 GetBucketReplication
6981 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html)
6982  
6983 =item *
6984  
6985 DeleteBucketReplication
6986 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html)
6987  
6988 =back
6989  
6990  
6991  
6992 =head2 PutBucketRequestPayment
6993  
6994 =over
6995  
6996 =item Bucket => Str
6997  
6998 =item RequestPaymentConfiguration => L<Paws::S3::RequestPaymentConfiguration>
6999  
7000 =item [ContentLength => Int]
7001  
7002 =item [ContentMD5 => Str]
7003  
7004 =item [ExpectedBucketOwner => Str]
7005  
7006  
7007 =back
7008  
7009 Each argument is described in detail in: L<Paws::S3::PutBucketRequestPayment>
7010  
7011 Returns: nothing
7012  
7013 Sets the request payment configuration for a bucket. By default, the
7014 bucket owner pays for downloads from the bucket. This configuration
7015 parameter enables the bucket owner (only) to specify that the person
7016 requesting the download will be charged for the download. For more
7017 information, see Requester Pays Buckets
7018 (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html).
7019  
7020 The following operations are related to C<PutBucketRequestPayment>:
7021  
7022 =over
7023  
7024 =item *
7025  
7026 CreateBucket
7027 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
7028  
7029 =item *
7030  
7031 GetBucketRequestPayment
7032 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html)
7033  
7034 =back
7035  
7036  
7037  
7038 =head2 PutBucketTagging
7039  
7040 =over
7041  
7042 =item Bucket => Str
7043  
7044 =item Tagging => L<Paws::S3::Tagging>
7045  
7046 =item [ContentLength => Int]
7047  
7048 =item [ContentMD5 => Str]
7049  
7050 =item [ExpectedBucketOwner => Str]
7051  
7052  
7053 =back
7054  
7055 Each argument is described in detail in: L<Paws::S3::PutBucketTagging>
7056  
7057 Returns: nothing
7058  
7059 Sets the tags for a bucket.
7060  
7061 Use tags to organize your AWS bill to reflect your own cost structure.
7062 To do this, sign up to get your AWS account bill with tag key values
7063 included. Then, to see the cost of combined resources, organize your
7064 billing information according to resources with the same tag key
7065 values. For example, you can tag several resources with a specific
7066 application name, and then organize your billing information to see the
7067 total cost of that application across several services. For more
7068 information, see Cost Allocation and Tagging
7069 (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)
7070 and Using Cost Allocation in Amazon S3 Bucket Tags
7071 (https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html).
7072  
7073 When this operation sets the tags for a bucket, it will overwrite any
7074 current tags the bucket already has. You cannot use this operation to
7075 add tags to an existing list of tags.
7076  
7077 To use this operation, you must have permissions to perform the
7078 C<s3:PutBucketTagging> action. The bucket owner has this permission by
7079 default and can grant this permission to others. For more information
7080 about permissions, see Permissions Related to Bucket Subresource
7081 Operations
7082 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
7083 and Managing Access Permissions to Your Amazon S3 Resources
7084 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html).
7085  
7086 C<PutBucketTagging> has the following special errors:
7087  
7088 =over
7089  
7090 =item *
7091  
7092 Error code: C<InvalidTagError>
7093  
7094 =over
7095  
7096 =item *
7097  
7098 Description: The tag provided was not a valid tag. This error can occur
7099 if the tag did not pass input validation. For information about tag
7100 restrictions, see User-Defined Tag Restrictions
7101 (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html)
7102 and AWS-Generated Cost Allocation Tag Restrictions
7103 (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html).
7104  
7105 =back
7106  
7107 =item *
7108  
7109 Error code: C<MalformedXMLError>
7110  
7111 =over
7112  
7113 =item *
7114  
7115 Description: The XML provided does not match the schema.
7116  
7117 =back
7118  
7119 =item *
7120  
7121 Error code: C<OperationAbortedError>
7122  
7123 =over
7124  
7125 =item *
7126  
7127 Description: A conflicting conditional action is currently in progress
7128 against this resource. Please try again.
7129  
7130 =back
7131  
7132 =item *
7133  
7134 Error code: C<InternalError>
7135  
7136 =over
7137  
7138 =item *
7139  
7140 Description: The service was unable to apply the provided tag to the
7141 bucket.
7142  
7143 =back
7144  
7145 =back
7146  
7147 The following operations are related to C<PutBucketTagging>:
7148  
7149 =over
7150  
7151 =item *
7152  
7153 GetBucketTagging
7154 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html)
7155  
7156 =item *
7157  
7158 DeleteBucketTagging
7159 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html)
7160  
7161 =back
7162  
7163  
7164  
7165 =head2 PutBucketVersioning
7166  
7167 =over
7168  
7169 =item Bucket => Str
7170  
7171 =item VersioningConfiguration => L<Paws::S3::VersioningConfiguration>
7172  
7173 =item [ContentLength => Int]
7174  
7175 =item [ContentMD5 => Str]
7176  
7177 =item [ExpectedBucketOwner => Str]
7178  
7179 =item [MFA => Str]
7180  
7181  
7182 =back
7183  
7184 Each argument is described in detail in: L<Paws::S3::PutBucketVersioning>
7185  
7186 Returns: nothing
7187  
7188 Sets the versioning state of an existing bucket. To set the versioning
7189 state, you must be the bucket owner.
7190  
7191 You can set the versioning state with one of the following values:
7192  
7193 B<Enabled>E<mdash>Enables versioning for the objects in the bucket. All
7194 objects added to the bucket receive a unique version ID.
7195  
7196 B<Suspended>E<mdash>Disables versioning for the objects in the bucket.
7197 All objects added to the bucket receive the version ID null.
7198  
7199 If the versioning state has never been set on a bucket, it has no
7200 versioning state; a GetBucketVersioning
7201 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html)
7202 request does not return a versioning state value.
7203  
7204 If the bucket owner enables MFA Delete in the bucket versioning
7205 configuration, the bucket owner must include the C<x-amz-mfa request>
7206 header and the C<Status> and the C<MfaDelete> request elements in a
7207 request to set the versioning state of the bucket.
7208  
7209 If you have an object expiration lifecycle policy in your non-versioned
7210 bucket and you want to maintain the same permanent delete behavior when
7211 you enable versioning, you must add a noncurrent expiration policy. The
7212 noncurrent expiration lifecycle policy will manage the deletes of the
7213 noncurrent object versions in the version-enabled bucket. (A
7214 version-enabled bucket maintains one current and zero or more
7215 noncurrent object versions.) For more information, see Lifecycle and
7216 Versioning
7217 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config).
7218  
7219 B<Related Resources>
7220  
7221 =over
7222  
7223 =item *
7224  
7225 CreateBucket
7226 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html)
7227  
7228 =item *
7229  
7230 DeleteBucket
7231 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html)
7232  
7233 =item *
7234  
7235 GetBucketVersioning
7236 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html)
7237  
7238 =back
7239  
7240  
7241  
7242 =head2 PutBucketWebsite
7243  
7244 =over
7245  
7246 =item Bucket => Str
7247  
7248 =item WebsiteConfiguration => L<Paws::S3::WebsiteConfiguration>
7249  
7250 =item [ContentLength => Int]
7251  
7252 =item [ContentMD5 => Str]
7253  
7254 =item [ExpectedBucketOwner => Str]
7255  
7256  
7257 =back
7258  
7259 Each argument is described in detail in: L<Paws::S3::PutBucketWebsite>
7260  
7261 Returns: nothing
7262  
7263 Sets the configuration of the website that is specified in the
7264 C<website> subresource. To configure a bucket as a website, you can add
7265 this subresource on the bucket with website configuration information
7266 such as the file name of the index document and any redirect rules. For
7267 more information, see Hosting Websites on Amazon S3
7268 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html).
7269  
7270 This PUT action requires the C<S3:PutBucketWebsite> permission. By
7271 default, only the bucket owner can configure the website attached to a
7272 bucket; however, bucket owners can allow other users to set the website
7273 configuration by writing a bucket policy that grants them the
7274 C<S3:PutBucketWebsite> permission.
7275  
7276 To redirect all website requests sent to the bucket's website endpoint,
7277 you add a website configuration with the following elements. Because
7278 all requests are sent to another website, you don't need to provide
7279 index document name for the bucket.
7280  
7281 =over
7282  
7283 =item *
7284  
7285 C<WebsiteConfiguration>
7286  
7287 =item *
7288  
7289 C<RedirectAllRequestsTo>
7290  
7291 =item *
7292  
7293 C<HostName>
7294  
7295 =item *
7296  
7297 C<Protocol>
7298  
7299 =back
7300  
7301 If you want granular control over redirects, you can use the following
7302 elements to add routing rules that describe conditions for redirecting
7303 requests and information about the redirect destination. In this case,
7304 the website configuration must provide an index document for the
7305 bucket, because some requests might not be redirected.
7306  
7307 =over
7308  
7309 =item *
7310  
7311 C<WebsiteConfiguration>
7312  
7313 =item *
7314  
7315 C<IndexDocument>
7316  
7317 =item *
7318  
7319 C<Suffix>
7320  
7321 =item *
7322  
7323 C<ErrorDocument>
7324  
7325 =item *
7326  
7327 C<Key>
7328  
7329 =item *
7330  
7331 C<RoutingRules>
7332  
7333 =item *
7334  
7335 C<RoutingRule>
7336  
7337 =item *
7338  
7339 C<Condition>
7340  
7341 =item *
7342  
7343 C<HttpErrorCodeReturnedEquals>
7344  
7345 =item *
7346  
7347 C<KeyPrefixEquals>
7348  
7349 =item *
7350  
7351 C<Redirect>
7352  
7353 =item *
7354  
7355 C<Protocol>
7356  
7357 =item *
7358  
7359 C<HostName>
7360  
7361 =item *
7362  
7363 C<ReplaceKeyPrefixWith>
7364  
7365 =item *
7366  
7367 C<ReplaceKeyWith>
7368  
7369 =item *
7370  
7371 C<HttpRedirectCode>
7372  
7373 =back
7374  
7375 Amazon S3 has a limitation of 50 routing rules per website
7376 configuration. If you require more than 50 routing rules, you can use
7377 object redirect. For more information, see Configuring an Object
7378 Redirect
7379 (https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html)
7380 in the I<Amazon S3 User Guide>.
7381  
7382  
7383 =head2 PutObject
7384  
7385 =over
7386  
7387 =item Bucket => Str
7388  
7389 =item Key => Str
7390  
7391 =item [ACL => Str]
7392  
7393 =item [Body => Str]
7394  
7395 =item [BucketKeyEnabled => Bool]
7396  
7397 =item [CacheControl => Str]
7398  
7399 =item [ContentDisposition => Str]
7400  
7401 =item [ContentEncoding => Str]
7402  
7403 =item [ContentLanguage => Str]
7404  
7405 =item [ContentLength => Int]
7406  
7407 =item [ContentMD5 => Str]
7408  
7409 =item [ContentType => Str]
7410  
7411 =item [ExpectedBucketOwner => Str]
7412  
7413 =item [Expires => Str]
7414  
7415 =item [GrantFullControl => Str]
7416  
7417 =item [GrantRead => Str]
7418  
7419 =item [GrantReadACP => Str]
7420  
7421 =item [GrantWriteACP => Str]
7422  
7423 =item [Metadata => L<Paws::S3::Metadata>]
7424  
7425 =item [ObjectLockLegalHoldStatus => Str]
7426  
7427 =item [ObjectLockMode => Str]
7428  
7429 =item [ObjectLockRetainUntilDate => Str]
7430  
7431 =item [RequestPayer => Str]
7432  
7433 =item [ServerSideEncryption => Str]
7434  
7435 =item [SSECustomerAlgorithm => Str]
7436  
7437 =item [SSECustomerKey => Str]
7438  
7439 =item [SSECustomerKeyMD5 => Str]
7440  
7441 =item [SSEKMSEncryptionContext => Str]
7442  
7443 =item [SSEKMSKeyId => Str]
7444  
7445 =item [StorageClass => Str]
7446  
7447 =item [Tagging => Str]
7448  
7449 =item [WebsiteRedirectLocation => Str]
7450  
7451  
7452 =back
7453  
7454 Each argument is described in detail in: L<Paws::S3::PutObject>
7455  
7456 Returns: a L<Paws::S3::PutObjectOutput> instance
7457  
7458 Adds an object to a bucket. You must have WRITE permissions on a bucket
7459 to add an object to it.
7460  
7461 Amazon S3 never adds partial objects; if you receive a success
7462 response, Amazon S3 added the entire object to the bucket.
7463  
7464 Amazon S3 is a distributed system. If it receives multiple write
7465 requests for the same object simultaneously, it overwrites all but the
7466 last object written. Amazon S3 does not provide object locking; if you
7467 need this, make sure to build it into your application layer or use
7468 versioning instead.
7469  
7470 To ensure that data is not corrupted traversing the network, use the
7471 C<Content-MD5> header. When you use this header, Amazon S3 checks the
7472 object against the provided MD5 value and, if they do not match,
7473 returns an error. Additionally, you can calculate the MD5 while putting
7474 an object to Amazon S3 and compare the returned ETag to the calculated
7475 MD5 value.
7476  
7477 The C<Content-MD5> header is required for any request to upload an
7478 object with a retention period configured using Amazon S3 Object Lock.
7479 For more information about Amazon S3 Object Lock, see Amazon S3 Object
7480 Lock Overview
7481 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html)
7482 in the I<Amazon S3 User Guide>.
7483  
7484 B<Server-side Encryption>
7485  
7486 You can optionally request server-side encryption. With server-side
7487 encryption, Amazon S3 encrypts your data as it writes it to disks in
7488 its data centers and decrypts the data when you access it. You have the
7489 option to provide your own encryption key or use AWS managed encryption
7490 keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side
7491 Encryption
7492 (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html).
7493  
7494 If you request server-side encryption using AWS Key Management Service
7495 (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For
7496 more information, see Amazon S3 Bucket Keys
7497 (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in
7498 the I<Amazon S3 User Guide>.
7499  
7500 B<Access Control List (ACL)-Specific Request Headers>
7501  
7502 You can use headers to grant ACL- based permissions. By default, all
7503 objects are private. Only the owner has full access control. When
7504 adding a new object, you can grant permissions to individual AWS
7505 accounts or to predefined groups defined by Amazon S3. These
7506 permissions are then added to the ACL on the object. For more
7507 information, see Access Control List (ACL) Overview
7508 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) and
7509 Managing ACLs Using the REST API
7510 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html).
7511  
7512 B<Storage Class Options>
7513  
7514 By default, Amazon S3 uses the STANDARD Storage Class to store newly
7515 created objects. The STANDARD storage class provides high durability
7516 and high availability. Depending on performance needs, you can specify
7517 a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS
7518 Storage Class. For more information, see Storage Classes
7519 (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html)
7520 in the I<Amazon S3 User Guide>.
7521  
7522 B<Versioning>
7523  
7524 If you enable versioning for a bucket, Amazon S3 automatically
7525 generates a unique version ID for the object being stored. Amazon S3
7526 returns this ID in the response. When you enable versioning for a
7527 bucket, if Amazon S3 receives multiple write requests for the same
7528 object simultaneously, it stores all of the objects.
7529  
7530 For more information about versioning, see Adding Objects to Versioning
7531 Enabled Buckets
7532 (https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html).
7533 For information about returning the versioning state of a bucket, see
7534 GetBucketVersioning
7535 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html).
7536  
7537 B<Related Resources>
7538  
7539 =over
7540  
7541 =item *
7542  
7543 CopyObject
7544 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)
7545  
7546 =item *
7547  
7548 DeleteObject
7549 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html)
7550  
7551 =back
7552  
7553  
7554  
7555 =head2 PutObjectAcl
7556  
7557 =over
7558  
7559 =item Bucket => Str
7560  
7561 =item Key => Str
7562  
7563 =item [AccessControlPolicy => L<Paws::S3::AccessControlPolicy>]
7564  
7565 =item [ACL => Str]
7566  
7567 =item [ContentLength => Int]
7568  
7569 =item [ContentMD5 => Str]
7570  
7571 =item [ExpectedBucketOwner => Str]
7572  
7573 =item [GrantFullControl => Str]
7574  
7575 =item [GrantRead => Str]
7576  
7577 =item [GrantReadACP => Str]
7578  
7579 =item [GrantWrite => Str]
7580  
7581 =item [GrantWriteACP => Str]
7582  
7583 =item [RequestPayer => Str]
7584  
7585 =item [VersionId => Str]
7586  
7587  
7588 =back
7589  
7590 Each argument is described in detail in: L<Paws::S3::PutObjectAcl>
7591  
7592 Returns: a L<Paws::S3::PutObjectAclOutput> instance
7593  
7594 Uses the C<acl> subresource to set the access control list (ACL)
7595 permissions for a new or existing object in an S3 bucket. You must have
7596 C<WRITE_ACP> permission to set the ACL of an object. For more
7597 information, see What permissions can I grant?
7598 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions)
7599 in the I<Amazon S3 User Guide>.
7600  
7601 This action is not supported by Amazon S3 on Outposts.
7602  
7603 Depending on your application needs, you can choose to set the ACL on
7604 an object using either the request body or the headers. For example, if
7605 you have an existing application that updates a bucket ACL using the
7606 request body, you can continue to use that approach. For more
7607 information, see Access Control List (ACL) Overview
7608 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in
7609 the I<Amazon S3 User Guide>.
7610  
7611 B<Access Permissions>
7612  
7613 You can set access permissions using one of the following methods:
7614  
7615 =over
7616  
7617 =item *
7618  
7619 Specify a canned ACL with the C<x-amz-acl> request header. Amazon S3
7620 supports a set of predefined ACLs, known as canned ACLs. Each canned
7621 ACL has a predefined set of grantees and permissions. Specify the
7622 canned ACL name as the value of C<x-amz-ac>l. If you use this header,
7623 you cannot use other access control-specific headers in your request.
7624 For more information, see Canned ACL
7625 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL).
7626  
7627 =item *
7628  
7629 Specify access permissions explicitly with the C<x-amz-grant-read>,
7630 C<x-amz-grant-read-acp>, C<x-amz-grant-write-acp>, and
7631 C<x-amz-grant-full-control> headers. When using these headers, you
7632 specify explicit access permissions and grantees (AWS accounts or
7633 Amazon S3 groups) who will receive the permission. If you use these
7634 ACL-specific headers, you cannot use C<x-amz-acl> header to set a
7635 canned ACL. These parameters map to the set of permissions that Amazon
7636 S3 supports in an ACL. For more information, see Access Control List
7637 (ACL) Overview
7638 (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html).
7639  
7640 You specify each grantee as a type=value pair, where the type is one of
7641 the following:
7642  
7643 =over
7644  
7645 =item *
7646  
7647 C<id> E<ndash> if the value specified is the canonical user ID of an
7648 AWS account
7649  
7650 =item *
7651  
7652 C<uri> E<ndash> if you are granting permissions to a predefined group
7653  
7654 =item *
7655  
7656 C<emailAddress> E<ndash> if the value specified is the email address of
7657 an AWS account
7658  
7659 Using email addresses to specify a grantee is only supported in the
7660 following AWS Regions:
7661  
7662 =over
7663  
7664 =item *
7665  
7666 US East (N. Virginia)
7667  
7668 =item *
7669  
7670 US West (N. California)
7671  
7672 =item *
7673  
7674 US West (Oregon)
7675  
7676 =item *
7677  
7678 Asia Pacific (Singapore)
7679  
7680 =item *
7681  
7682 Asia Pacific (Sydney)
7683  
7684 =item *
7685  
7686 Asia Pacific (Tokyo)
7687  
7688 =item *
7689  
7690 Europe (Ireland)
7691  
7692 =item *
7693  
7694 South America (SE<atilde>o Paulo)
7695  
7696 =back
7697  
7698 For a list of all the Amazon S3 supported Regions and endpoints, see
7699 Regions and Endpoints
7700 (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in
7701 the AWS General Reference.
7702  
7703 =back
7704  
7705 For example, the following C<x-amz-grant-read> header grants list
7706 objects permission to the two AWS accounts identified by their email
7707 addresses.
7708  
7709 C<x-amz-grant-read: emailAddress="xyz@amazon.com",
7710 emailAddress="abc@amazon.com">
7711  
7712 =back
7713  
7714 You can use either a canned ACL or specify access permissions
7715 explicitly. You cannot do both.
7716  
7717 B<Grantee Values>
7718  
7719 You can specify the person (grantee) to whom you're assigning access
7720 rights (using request elements) in the following ways:
7721  
7722 =over
7723  
7724 =item *
7725  
7726 By the person's ID:
7727  
7728 C<E<lt>Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
7729 xsi:type="CanonicalUser"E<gt>E<lt>IDE<gt>E<lt>E<gt>IDE<lt>E<gt>E<lt>/IDE<gt>E<lt>DisplayNameE<gt>E<lt>E<gt>GranteesEmailE<lt>E<gt>E<lt>/DisplayNameE<gt>
7730 E<lt>/GranteeE<gt>>
7731  
7732 DisplayName is optional and ignored in the request.
7733  
7734 =item *
7735  
7736 By URI:
7737  
7738 C<E<lt>Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
7739 xsi:type="Group"E<gt>E<lt>URIE<gt>E<lt>E<gt>http://acs.amazonaws.com/groups/global/AuthenticatedUsersE<lt>E<gt>E<lt>/URIE<gt>E<lt>/GranteeE<gt>>
7740  
7741 =item *
7742  
7743 By Email address:
7744  
7745 C<E<lt>Grantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
7746 xsi:type="AmazonCustomerByEmail"E<gt>E<lt>EmailAddressE<gt>E<lt>E<gt>Grantees@email.comE<lt>E<gt>E<lt>/EmailAddressE<gt>lt;/GranteeE<gt>>
7747  
7748 The grantee is resolved to the CanonicalUser and, in a response to a
7749 GET Object acl request, appears as the CanonicalUser.
7750  
7751 Using email addresses to specify a grantee is only supported in the
7752 following AWS Regions:
7753  
7754 =over
7755  
7756 =item *
7757  
7758 US East (N. Virginia)
7759  
7760 =item *
7761  
7762 US West (N. California)
7763  
7764 =item *
7765  
7766 US West (Oregon)
7767  
7768 =item *
7769  
7770 Asia Pacific (Singapore)
7771  
7772 =item *
7773  
7774 Asia Pacific (Sydney)
7775  
7776 =item *
7777  
7778 Asia Pacific (Tokyo)
7779  
7780 =item *
7781  
7782 Europe (Ireland)
7783  
7784 =item *
7785  
7786 South America (SE<atilde>o Paulo)
7787  
7788 =back
7789  
7790 For a list of all the Amazon S3 supported Regions and endpoints, see
7791 Regions and Endpoints
7792 (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in
7793 the AWS General Reference.
7794  
7795 =back
7796  
7797 B<Versioning>
7798  
7799 The ACL of an object is set at the object version level. By default,
7800 PUT sets the ACL of the current version of an object. To set the ACL of
7801 a different version, use the C<versionId> subresource.
7802  
7803 B<Related Resources>
7804  
7805 =over
7806  
7807 =item *
7808  
7809 CopyObject
7810 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)
7811  
7812 =item *
7813  
7814 GetObject
7815 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
7816  
7817 =back
7818  
7819  
7820  
7821 =head2 PutObjectLegalHold
7822  
7823 =over
7824  
7825 =item Bucket => Str
7826  
7827 =item Key => Str
7828  
7829 =item [ContentMD5 => Str]
7830  
7831 =item [ExpectedBucketOwner => Str]
7832  
7833 =item [LegalHold => L<Paws::S3::ObjectLockLegalHold>]
7834  
7835 =item [RequestPayer => Str]
7836  
7837 =item [VersionId => Str]
7838  
7839  
7840 =back
7841  
7842 Each argument is described in detail in: L<Paws::S3::PutObjectLegalHold>
7843  
7844 Returns: a L<Paws::S3::PutObjectLegalHoldOutput> instance
7845  
7846 Applies a Legal Hold configuration to the specified object. For more
7847 information, see Locking Objects
7848 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
7849  
7850 This action is not supported by Amazon S3 on Outposts.
7851  
7852  
7853 =head2 PutObjectLockConfiguration
7854  
7855 =over
7856  
7857 =item Bucket => Str
7858  
7859 =item [ContentMD5 => Str]
7860  
7861 =item [ExpectedBucketOwner => Str]
7862  
7863 =item [ObjectLockConfiguration => L<Paws::S3::ObjectLockConfiguration>]
7864  
7865 =item [RequestPayer => Str]
7866  
7867 =item [Token => Str]
7868  
7869  
7870 =back
7871  
7872 Each argument is described in detail in: L<Paws::S3::PutObjectLockConfiguration>
7873  
7874 Returns: a L<Paws::S3::PutObjectLockConfigurationOutput> instance
7875  
7876 Places an Object Lock configuration on the specified bucket. The rule
7877 specified in the Object Lock configuration will be applied by default
7878 to every new object placed in the specified bucket. For more
7879 information, see Locking Objects
7880 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
7881  
7882 =over
7883  
7884 =item *
7885  
7886 The C<DefaultRetention> settings require both a mode and a period.
7887  
7888 =item *
7889  
7890 The C<DefaultRetention> period can be either C<Days> or C<Years> but
7891 you must select one. You cannot specify C<Days> and C<Years> at the
7892 same time.
7893  
7894 =item *
7895  
7896 You can only enable Object Lock for new buckets. If you want to turn on
7897 Object Lock for an existing bucket, contact AWS Support.
7898  
7899 =back
7900  
7901  
7902  
7903 =head2 PutObjectRetention
7904  
7905 =over
7906  
7907 =item Bucket => Str
7908  
7909 =item Key => Str
7910  
7911 =item [BypassGovernanceRetention => Bool]
7912  
7913 =item [ContentMD5 => Str]
7914  
7915 =item [ExpectedBucketOwner => Str]
7916  
7917 =item [RequestPayer => Str]
7918  
7919 =item [Retention => L<Paws::S3::ObjectLockRetention>]
7920  
7921 =item [VersionId => Str]
7922  
7923  
7924 =back
7925  
7926 Each argument is described in detail in: L<Paws::S3::PutObjectRetention>
7927  
7928 Returns: a L<Paws::S3::PutObjectRetentionOutput> instance
7929  
7930 Places an Object Retention configuration on an object. For more
7931 information, see Locking Objects
7932 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html).
7933  
7934 This action is not supported by Amazon S3 on Outposts.
7935  
7936  
7937 =head2 PutObjectTagging
7938  
7939 =over
7940  
7941 =item Bucket => Str
7942  
7943 =item Key => Str
7944  
7945 =item Tagging => L<Paws::S3::Tagging>
7946  
7947 =item [ContentLength => Int]
7948  
7949 =item [ContentMD5 => Str]
7950  
7951 =item [ExpectedBucketOwner => Str]
7952  
7953 =item [RequestPayer => Str]
7954  
7955 =item [VersionId => Str]
7956  
7957  
7958 =back
7959  
7960 Each argument is described in detail in: L<Paws::S3::PutObjectTagging>
7961  
7962 Returns: a L<Paws::S3::PutObjectTaggingOutput> instance
7963  
7964 Sets the supplied tag-set to an object that already exists in a bucket.
7965  
7966 A tag is a key-value pair. You can associate tags with an object by
7967 sending a PUT request against the tagging subresource that is
7968 associated with the object. You can retrieve tags by sending a GET
7969 request. For more information, see GetObjectTagging
7970 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html).
7971  
7972 For tagging-related restrictions related to characters and encodings,
7973 see Tag Restrictions
7974 (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html).
7975 Note that Amazon S3 limits the maximum number of tags to 10 tags per
7976 object.
7977  
7978 To use this operation, you must have permission to perform the
7979 C<s3:PutObjectTagging> action. By default, the bucket owner has this
7980 permission and can grant this permission to others.
7981  
7982 To put tags of any other version, use the C<versionId> query parameter.
7983 You also need permission for the C<s3:PutObjectVersionTagging> action.
7984  
7985 For information about the Amazon S3 object tagging feature, see Object
7986 Tagging
7987 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html).
7988  
7989 B<Special Errors>
7990  
7991 =over
7992  
7993 =item *
7994  
7995 =over
7996  
7997 =item *
7998  
7999 I<Code: InvalidTagError>
8000  
8001 =item *
8002  
8003 I<Cause: The tag provided was not a valid tag. This error can occur if
8004 the tag did not pass input validation. For more information, see Object
8005 Tagging
8006 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html).>
8007  
8008 =back
8009  
8010 =item *
8011  
8012 =over
8013  
8014 =item *
8015  
8016 I<Code: MalformedXMLError>
8017  
8018 =item *
8019  
8020 I<Cause: The XML provided does not match the schema.>
8021  
8022 =back
8023  
8024 =item *
8025  
8026 =over
8027  
8028 =item *
8029  
8030 I<Code: OperationAbortedError>
8031  
8032 =item *
8033  
8034 I<Cause: A conflicting conditional action is currently in progress
8035 against this resource. Please try again.>
8036  
8037 =back
8038  
8039 =item *
8040  
8041 =over
8042  
8043 =item *
8044  
8045 I<Code: InternalError>
8046  
8047 =item *
8048  
8049 I<Cause: The service was unable to apply the provided tag to the
8050 object.>
8051  
8052 =back
8053  
8054 =back
8055  
8056 B<Related Resources>
8057  
8058 =over
8059  
8060 =item *
8061  
8062 GetObjectTagging
8063 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html)
8064  
8065 =item *
8066  
8067 DeleteObjectTagging
8068 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html)
8069  
8070 =back
8071  
8072  
8073  
8074 =head2 PutPublicAccessBlock
8075  
8076 =over
8077  
8078 =item Bucket => Str
8079  
8080 =item PublicAccessBlockConfiguration => L<Paws::S3::PublicAccessBlockConfiguration>
8081  
8082 =item [ContentMD5 => Str]
8083  
8084 =item [ExpectedBucketOwner => Str]
8085  
8086  
8087 =back
8088  
8089 Each argument is described in detail in: L<Paws::S3::PutPublicAccessBlock>
8090  
8091 Returns: nothing
8092  
8093 Creates or modifies the C<PublicAccessBlock> configuration for an
8094 Amazon S3 bucket. To use this operation, you must have the
8095 C<s3:PutBucketPublicAccessBlock> permission. For more information about
8096 Amazon S3 permissions, see Specifying Permissions in a Policy
8097 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html).
8098  
8099 When Amazon S3 evaluates the C<PublicAccessBlock> configuration for a
8100 bucket or an object, it checks the C<PublicAccessBlock> configuration
8101 for both the bucket (or the bucket that contains the object) and the
8102 bucket owner's account. If the C<PublicAccessBlock> configurations are
8103 different between the bucket and the account, Amazon S3 uses the most
8104 restrictive combination of the bucket-level and account-level settings.
8105  
8106 For more information about when Amazon S3 considers a bucket or an
8107 object public, see The Meaning of "Public"
8108 (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status).
8109  
8110 B<Related Resources>
8111  
8112 =over
8113  
8114 =item *
8115  
8116 GetPublicAccessBlock
8117 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html)
8118  
8119 =item *
8120  
8121 DeletePublicAccessBlock
8122 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html)
8123  
8124 =item *
8125  
8126 GetBucketPolicyStatus
8127 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html)
8128  
8129 =item *
8130  
8131 Using Amazon S3 Block Public Access
8132 (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html)
8133  
8134 =back
8135  
8136  
8137  
8138 =head2 RestoreObject
8139  
8140 =over
8141  
8142 =item Bucket => Str
8143  
8144 =item Key => Str
8145  
8146 =item [ContentMD5 => Str]
8147  
8148 =item [ExpectedBucketOwner => Str]
8149  
8150 =item [RequestPayer => Str]
8151  
8152 =item [RestoreRequest => L<Paws::S3::RestoreRequest>]
8153  
8154 =item [VersionId => Str]
8155  
8156  
8157 =back
8158  
8159 Each argument is described in detail in: L<Paws::S3::RestoreObject>
8160  
8161 Returns: a L<Paws::S3::RestoreObjectOutput> instance
8162  
8163 Restores an archived copy of an object back into Amazon S3
8164  
8165 This action is not supported by Amazon S3 on Outposts.
8166  
8167 This action performs the following types of requests:
8168  
8169 =over
8170  
8171 =item *
8172  
8173 C<select> - Perform a select query on an archived object
8174  
8175 =item *
8176  
8177 C<restore an archive> - Restore an archived object
8178  
8179 =back
8180  
8181 To use this operation, you must have permissions to perform the
8182 C<s3:RestoreObject> action. The bucket owner has this permission by
8183 default and can grant this permission to others. For more information
8184 about permissions, see Permissions Related to Bucket Subresource
8185 Operations
8186 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources)
8187 and Managing Access Permissions to Your Amazon S3 Resources
8188 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html)
8189 in the I<Amazon S3 User Guide>.
8190  
8191 B<Querying Archives with Select Requests>
8192  
8193 You use a select type of request to perform SQL queries on archived
8194 objects. The archived objects that are being queried by the select
8195 request must be formatted as uncompressed comma-separated values (CSV)
8196 files. You can run queries and custom analytics on your archived data
8197 without having to restore your data to a hotter Amazon S3 tier. For an
8198 overview about select requests, see Querying Archived Objects
8199 (https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html)
8200 in the I<Amazon S3 User Guide>.
8201  
8202 When making a select request, do the following:
8203  
8204 =over
8205  
8206 =item *
8207  
8208 Define an output location for the select query's output. This must be
8209 an Amazon S3 bucket in the same AWS Region as the bucket that contains
8210 the archive object that is being queried. The AWS account that
8211 initiates the job must have permissions to write to the S3 bucket. You
8212 can specify the storage class and encryption for the output objects
8213 stored in the bucket. For more information about output, see Querying
8214 Archived Objects
8215 (https://docs.aws.amazon.com/AmazonS3/latest/dev/querying-glacier-archives.html)
8216 in the I<Amazon S3 User Guide>.
8217  
8218 For more information about the C<S3> structure in the request body, see
8219 the following:
8220  
8221 =over
8222  
8223 =item *
8224  
8225 PutObject
8226 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html)
8227  
8228 =item *
8229  
8230 Managing Access with ACLs
8231 (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html)
8232 in the I<Amazon S3 User Guide>
8233  
8234 =item *
8235  
8236 Protecting Data Using Server-Side Encryption
8237 (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html)
8238 in the I<Amazon S3 User Guide>
8239  
8240 =back
8241  
8242 =item *
8243  
8244 Define the SQL expression for the C<SELECT> type of restoration for
8245 your query in the request body's C<SelectParameters> structure. You can
8246 use expressions like the following examples.
8247  
8248 =over
8249  
8250 =item *
8251  
8252 The following expression returns all records from the specified object.
8253  
8254 C<SELECT * FROM Object>
8255  
8256 =item *
8257  
8258 Assuming that you are not using any headers for data stored in the
8259 object, you can specify columns with positional headers.
8260  
8261 C<SELECT s._1, s._2 FROM Object s WHERE s._3 E<gt> 100>
8262  
8263 =item *
8264  
8265 If you have headers and you set the C<fileHeaderInfo> in the C<CSV>
8266 structure in the request body to C<USE>, you can specify headers in the
8267 query. (If you set the C<fileHeaderInfo> field to C<IGNORE>, the first
8268 row is skipped for the query.) You cannot mix ordinal positions with
8269 header column names.
8270  
8271 C<SELECT s.Id, s.FirstName, s.SSN FROM S3Object s>
8272  
8273 =back
8274  
8275 =back
8276  
8277 For more information about using SQL with S3 Glacier Select restore,
8278 see SQL Reference for Amazon S3 Select and S3 Glacier Select
8279 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html)
8280 in the I<Amazon S3 User Guide>.
8281  
8282 When making a select request, you can also do the following:
8283  
8284 =over
8285  
8286 =item *
8287  
8288 To expedite your queries, specify the C<Expedited> tier. For more
8289 information about tiers, see "Restoring Archives," later in this topic.
8290  
8291 =item *
8292  
8293 Specify details about the data serialization format of both the input
8294 object that is being queried and the serialization of the CSV-encoded
8295 query results.
8296  
8297 =back
8298  
8299 The following are additional important facts about the select feature:
8300  
8301 =over
8302  
8303 =item *
8304  
8305 The output results are new Amazon S3 objects. Unlike archive
8306 retrievals, they are stored until explicitly deleted-manually or
8307 through a lifecycle policy.
8308  
8309 =item *
8310  
8311 You can issue more than one select request on the same Amazon S3
8312 object. Amazon S3 doesn't deduplicate requests, so avoid issuing
8313 duplicate requests.
8314  
8315 =item *
8316  
8317 Amazon S3 accepts a select request even if the object has already been
8318 restored. A select request doesnE<rsquo>t return error response C<409>.
8319  
8320 =back
8321  
8322 B<Restoring objects>
8323  
8324 Objects that you archive to the S3 Glacier or S3 Glacier Deep Archive
8325 storage class, and S3 Intelligent-Tiering Archive or S3
8326 Intelligent-Tiering Deep Archive tiers are not accessible in real time.
8327 For objects in Archive Access or Deep Archive Access tiers you must
8328 first initiate a restore request, and then wait until the object is
8329 moved into the Frequent Access tier. For objects in S3 Glacier or S3
8330 Glacier Deep Archive storage classes you must first initiate a restore
8331 request, and then wait until a temporary copy of the object is
8332 available. To access an archived object, you must restore the object
8333 for the duration (number of days) that you specify.
8334  
8335 To restore a specific object version, you can provide a version ID. If
8336 you don't provide a version ID, Amazon S3 restores the current version.
8337  
8338 When restoring an archived object (or using a select request), you can
8339 specify one of the following data access tier options in the C<Tier>
8340 element of the request body:
8341  
8342 =over
8343  
8344 =item *
8345  
8346 B<C<Expedited> > - Expedited retrievals allow you to quickly access
8347 your data stored in the S3 Glacier storage class or S3
8348 Intelligent-Tiering Archive tier when occasional urgent requests for a
8349 subset of archives are required. For all but the largest archived
8350 objects (250 MB+), data accessed using Expedited retrievals is
8351 typically made available within 1E<ndash>5 minutes. Provisioned
8352 capacity ensures that retrieval capacity for Expedited retrievals is
8353 available when you need it. Expedited retrievals and provisioned
8354 capacity are not available for objects stored in the S3 Glacier Deep
8355 Archive storage class or S3 Intelligent-Tiering Deep Archive tier.
8356  
8357 =item *
8358  
8359 B<C<Standard> > - Standard retrievals allow you to access any of your
8360 archived objects within several hours. This is the default option for
8361 retrieval requests that do not specify the retrieval option. Standard
8362 retrievals typically finish within 3E<ndash>5 hours for objects stored
8363 in the S3 Glacier storage class or S3 Intelligent-Tiering Archive tier.
8364 They typically finish within 12 hours for objects stored in the S3
8365 Glacier Deep Archive storage class or S3 Intelligent-Tiering Deep
8366 Archive tier. Standard retrievals are free for objects stored in S3
8367 Intelligent-Tiering.
8368  
8369 =item *
8370  
8371 B<C<Bulk> > - Bulk retrievals are the lowest-cost retrieval option in
8372 S3 Glacier, enabling you to retrieve large amounts, even petabytes, of
8373 data inexpensively. Bulk retrievals typically finish within 5E<ndash>12
8374 hours for objects stored in the S3 Glacier storage class or S3
8375 Intelligent-Tiering Archive tier. They typically finish within 48 hours
8376 for objects stored in the S3 Glacier Deep Archive storage class or S3
8377 Intelligent-Tiering Deep Archive tier. Bulk retrievals are free for
8378 objects stored in S3 Intelligent-Tiering.
8379  
8380 =back
8381  
8382 For more information about archive retrieval options and provisioned
8383 capacity for C<Expedited> data access, see Restoring Archived Objects
8384 (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html)
8385 in the I<Amazon S3 User Guide>.
8386  
8387 You can use Amazon S3 restore speed upgrade to change the restore speed
8388 to a faster speed while it is in progress. For more information, see
8389 Upgrading the speed of an in-progress restore
8390 (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html#restoring-objects-upgrade-tier.title.html)
8391 in the I<Amazon S3 User Guide>.
8392  
8393 To get the status of object restoration, you can send a C<HEAD>
8394 request. Operations return the C<x-amz-restore> header, which provides
8395 information about the restoration status, in the response. You can use
8396 Amazon S3 event notifications to notify you when a restore is initiated
8397 or completed. For more information, see Configuring Amazon S3 Event
8398 Notifications
8399 (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html)
8400 in the I<Amazon S3 User Guide>.
8401  
8402 After restoring an archived object, you can update the restoration
8403 period by reissuing the request with a new period. Amazon S3 updates
8404 the restoration period relative to the current time and charges only
8405 for the request-there are no data transfer charges. You cannot update
8406 the restoration period when Amazon S3 is actively processing your
8407 current restore request for the object.
8408  
8409 If your bucket has a lifecycle configuration with a rule that includes
8410 an expiration action, the object expiration overrides the life span
8411 that you specify in a restore request. For example, if you restore an
8412 object copy for 10 days, but the object is scheduled to expire in 3
8413 days, Amazon S3 deletes the object in 3 days. For more information
8414 about lifecycle configuration, see PutBucketLifecycleConfiguration
8415 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)
8416 and Object Lifecycle Management
8417 (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html)
8418 in I<Amazon S3 User Guide>.
8419  
8420 B<Responses>
8421  
8422 A successful action returns either the C<200 OK> or C<202 Accepted>
8423 status code.
8424  
8425 =over
8426  
8427 =item *
8428  
8429 If the object is not previously restored, then Amazon S3 returns C<202
8430 Accepted> in the response.
8431  
8432 =item *
8433  
8434 If the object is previously restored, Amazon S3 returns C<200 OK> in
8435 the response.
8436  
8437 =back
8438  
8439 B<Special Errors>
8440  
8441 =over
8442  
8443 =item *
8444  
8445 =over
8446  
8447 =item *
8448  
8449 I<Code: RestoreAlreadyInProgress>
8450  
8451 =item *
8452  
8453 I<Cause: Object restore is already in progress. (This error does not
8454 apply to SELECT type requests.)>
8455  
8456 =item *
8457  
8458 I<HTTP Status Code: 409 Conflict>
8459  
8460 =item *
8461  
8462 I<SOAP Fault Code Prefix: Client>
8463  
8464 =back
8465  
8466 =item *
8467  
8468 =over
8469  
8470 =item *
8471  
8472 I<Code: GlacierExpeditedRetrievalNotAvailable>
8473  
8474 =item *
8475  
8476 I<Cause: expedited retrievals are currently not available. Try again
8477 later. (Returned if there is insufficient capacity to process the
8478 Expedited request. This error applies only to Expedited retrievals and
8479 not to S3 Standard or Bulk retrievals.)>
8480  
8481 =item *
8482  
8483 I<HTTP Status Code: 503>
8484  
8485 =item *
8486  
8487 I<SOAP Fault Code Prefix: N/A>
8488  
8489 =back
8490  
8491 =back
8492  
8493 B<Related Resources>
8494  
8495 =over
8496  
8497 =item *
8498  
8499 PutBucketLifecycleConfiguration
8500 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)
8501  
8502 =item *
8503  
8504 GetBucketNotificationConfiguration
8505 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html)
8506  
8507 =item *
8508  
8509 SQL Reference for Amazon S3 Select and S3 Glacier Select
8510 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html)
8511 in the I<Amazon S3 User Guide>
8512  
8513 =back
8514  
8515  
8516  
8517 =head2 SelectObjectContent
8518  
8519 =over
8520  
8521 =item Bucket => Str
8522  
8523 =item Expression => Str
8524  
8525 =item ExpressionType => Str
8526  
8527 =item InputSerialization => L<Paws::S3::InputSerialization>
8528  
8529 =item Key => Str
8530  
8531 =item OutputSerialization => L<Paws::S3::OutputSerialization>
8532  
8533 =item [ExpectedBucketOwner => Str]
8534  
8535 =item [RequestProgress => L<Paws::S3::RequestProgress>]
8536  
8537 =item [ScanRange => L<Paws::S3::ScanRange>]
8538  
8539 =item [SSECustomerAlgorithm => Str]
8540  
8541 =item [SSECustomerKey => Str]
8542  
8543 =item [SSECustomerKeyMD5 => Str]
8544  
8545  
8546 =back
8547  
8548 Each argument is described in detail in: L<Paws::S3::SelectObjectContent>
8549  
8550 Returns: a L<Paws::S3::SelectObjectContentOutput> instance
8551  
8552 This action filters the contents of an Amazon S3 object based on a
8553 simple structured query language (SQL) statement. In the request, along
8554 with the SQL expression, you must also specify a data serialization
8555 format (JSON, CSV, or Apache Parquet) of the object. Amazon S3 uses
8556 this format to parse object data into records, and returns only records
8557 that match the specified SQL expression. You must also specify the data
8558 serialization format for the response.
8559  
8560 This action is not supported by Amazon S3 on Outposts.
8561  
8562 For more information about Amazon S3 Select, see Selecting Content from
8563 Objects
8564 (https://docs.aws.amazon.com/AmazonS3/latest/dev/selecting-content-from-objects.html)
8565 in the I<Amazon S3 User Guide>.
8566  
8567 For more information about using SQL with Amazon S3 Select, see SQL
8568 Reference for Amazon S3 Select and S3 Glacier Select
8569 (https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-glacier-select-sql-reference.html)
8570 in the I<Amazon S3 User Guide>.
8571  
8572 B<Permissions>
8573  
8574 You must have C<s3:GetObject> permission for this operation. Amazon S3
8575 Select does not support anonymous access. For more information about
8576 permissions, see Specifying Permissions in a Policy
8577 (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html)
8578 in the I<Amazon S3 User Guide>.
8579  
8580 I<Object Data Formats>
8581  
8582 You can use Amazon S3 Select to query objects that have the following
8583 format properties:
8584  
8585 =over
8586  
8587 =item *
8588  
8589 I<CSV, JSON, and Parquet> - Objects must be in CSV, JSON, or Parquet
8590 format.
8591  
8592 =item *
8593  
8594 I<UTF-8> - UTF-8 is the only encoding type Amazon S3 Select supports.
8595  
8596 =item *
8597  
8598 I<GZIP or BZIP2> - CSV and JSON files can be compressed using GZIP or
8599 BZIP2. GZIP and BZIP2 are the only compression formats that Amazon S3
8600 Select supports for CSV and JSON files. Amazon S3 Select supports
8601 columnar compression for Parquet using GZIP or Snappy. Amazon S3 Select
8602 does not support whole-object compression for Parquet objects.
8603  
8604 =item *
8605  
8606 I<Server-side encryption> - Amazon S3 Select supports querying objects
8607 that are protected with server-side encryption.
8608  
8609 For objects that are encrypted with customer-provided encryption keys
8610 (SSE-C), you must use HTTPS, and you must use the headers that are
8611 documented in the GetObject
8612 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html).
8613 For more information about SSE-C, see Server-Side Encryption (Using
8614 Customer-Provided Encryption Keys)
8615 (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html)
8616 in the I<Amazon S3 User Guide>.
8617  
8618 For objects that are encrypted with Amazon S3 managed encryption keys
8619 (SSE-S3) and customer master keys (CMKs) stored in AWS Key Management
8620 Service (SSE-KMS), server-side encryption is handled transparently, so
8621 you don't need to specify anything. For more information about
8622 server-side encryption, including SSE-S3 and SSE-KMS, see Protecting
8623 Data Using Server-Side Encryption
8624 (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html)
8625 in the I<Amazon S3 User Guide>.
8626  
8627 =back
8628  
8629 B<Working with the Response Body>
8630  
8631 Given the response size is unknown, Amazon S3 Select streams the
8632 response as a series of messages and includes a C<Transfer-Encoding>
8633 header with C<chunked> as its value in the response. For more
8634 information, see Appendix: SelectObjectContent Response
8635 (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTSelectObjectAppendix.html)
8636 .
8637  
8638 B<GetObject Support>
8639  
8640 The C<SelectObjectContent> action does not support the following
8641 C<GetObject> functionality. For more information, see GetObject
8642 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html).
8643  
8644 =over
8645  
8646 =item *
8647  
8648 C<Range>: Although you can specify a scan range for an Amazon S3 Select
8649 request (see SelectObjectContentRequest - ScanRange
8650 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html#AmazonS3-SelectObjectContent-request-ScanRange)
8651 in the request parameters), you cannot specify the range of bytes of an
8652 object to return.
8653  
8654 =item *
8655  
8656 GLACIER, DEEP_ARCHIVE and REDUCED_REDUNDANCY storage classes: You
8657 cannot specify the GLACIER, DEEP_ARCHIVE, or C<REDUCED_REDUNDANCY>
8658 storage classes. For more information, about storage classes see
8659 Storage Classes
8660 (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMetadata.html#storage-class-intro)
8661 in the I<Amazon S3 User Guide>.
8662  
8663 =back
8664  
8665 B<Special Errors>
8666  
8667 For a list of special errors for this operation, see List of SELECT
8668 Object Content Error Codes
8669 (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#SelectObjectContentErrorCodeList)
8670  
8671 B<Related Resources>
8672  
8673 =over
8674  
8675 =item *
8676  
8677 GetObject
8678 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html)
8679  
8680 =item *
8681  
8682 GetBucketLifecycleConfiguration
8683 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html)
8684  
8685 =item *
8686  
8687 PutBucketLifecycleConfiguration
8688 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html)
8689  
8690 =back
8691  
8692  
8693  
8694 =head2 UploadPart
8695  
8696 =over
8697  
8698 =item Bucket => Str
8699  
8700 =item Key => Str
8701  
8702 =item PartNumber => Int
8703  
8704 =item UploadId => Str
8705  
8706 =item [Body => Str]
8707  
8708 =item [ContentLength => Int]
8709  
8710 =item [ContentMD5 => Str]
8711  
8712 =item [ExpectedBucketOwner => Str]
8713  
8714 =item [RequestPayer => Str]
8715  
8716 =item [SSECustomerAlgorithm => Str]
8717  
8718 =item [SSECustomerKey => Str]
8719  
8720 =item [SSECustomerKeyMD5 => Str]
8721  
8722  
8723 =back
8724  
8725 Each argument is described in detail in: L<Paws::S3::UploadPart>
8726  
8727 Returns: a L<Paws::S3::UploadPartOutput> instance
8728  
8729 Uploads a part in a multipart upload.
8730  
8731 In this operation, you provide part data in your request. However, you
8732 have an option to specify your existing Amazon S3 object as a data
8733 source for the part you are uploading. To upload a part from an
8734 existing object, you use the UploadPartCopy
8735 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html)
8736 operation.
8737  
8738 You must initiate a multipart upload (see CreateMultipartUpload
8739 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html))
8740 before you can upload any part. In response to your initiate request,
8741 Amazon S3 returns an upload ID, a unique identifier, that you must
8742 include in your upload part request.
8743  
8744 Part numbers can be any number from 1 to 10,000, inclusive. A part
8745 number uniquely identifies a part and also defines its position within
8746 the object being created. If you upload a new part using the same part
8747 number that was used with a previous part, the previously uploaded part
8748 is overwritten. Each part must be at least 5 MB in size, except the
8749 last part. There is no size limit on the last part of your multipart
8750 upload.
8751  
8752 To ensure that data is not corrupted when traversing the network,
8753 specify the C<Content-MD5> header in the upload part request. Amazon S3
8754 checks the part data against the provided MD5 value. If they do not
8755 match, Amazon S3 returns an error.
8756  
8757 If the upload request is signed with Signature Version 4, then AWS S3
8758 uses the C<x-amz-content-sha256> header as a checksum instead of
8759 C<Content-MD5>. For more information see Authenticating Requests: Using
8760 the Authorization Header (AWS Signature Version 4)
8761 (https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html).
8762  
8763 B<Note:> After you initiate multipart upload and upload one or more
8764 parts, you must either complete or abort multipart upload in order to
8765 stop getting charged for storage of the uploaded parts. Only after you
8766 either complete or abort multipart upload, Amazon S3 frees up the parts
8767 storage and stops charging you for the parts storage.
8768  
8769 For more information on multipart uploads, go to Multipart Upload
8770 Overview
8771 (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html) in
8772 the I<Amazon S3 User Guide >.
8773  
8774 For information on the permissions required to use the multipart upload
8775 API, go to Multipart Upload and Permissions
8776 (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)
8777 in the I<Amazon S3 User Guide>.
8778  
8779 You can optionally request server-side encryption where Amazon S3
8780 encrypts your data as it writes it to disks in its data centers and
8781 decrypts it for you when you access it. You have the option of
8782 providing your own encryption key, or you can use the AWS managed
8783 encryption keys. If you choose to provide your own encryption key, the
8784 request headers you provide in the request must match the headers you
8785 used in the request to initiate the upload by using
8786 CreateMultipartUpload
8787 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html).
8788 For more information, go to Using Server-Side Encryption
8789 (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html)
8790 in the I<Amazon S3 User Guide>.
8791  
8792 Server-side encryption is supported by the S3 Multipart Upload actions.
8793 Unless you are using a customer-provided encryption key, you don't need
8794 to specify the encryption parameters in each UploadPart request.
8795 Instead, you only need to specify the server-side encryption parameters
8796 in the initial Initiate Multipart request. For more information, see
8797 CreateMultipartUpload
8798 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html).
8799  
8800 If you requested server-side encryption using a customer-provided
8801 encryption key in your initiate multipart upload request, you must
8802 provide identical encryption information in each part upload using the
8803 following headers.
8804  
8805 =over
8806  
8807 =item *
8808  
8809 x-amz-server-side-encryption-customer-algorithm
8810  
8811 =item *
8812  
8813 x-amz-server-side-encryption-customer-key
8814  
8815 =item *
8816  
8817 x-amz-server-side-encryption-customer-key-MD5
8818  
8819 =back
8820  
8821 B<Special Errors>
8822  
8823 =over
8824  
8825 =item *
8826  
8827 =over
8828  
8829 =item *
8830  
8831 I<Code: NoSuchUpload>
8832  
8833 =item *
8834  
8835 I<Cause: The specified multipart upload does not exist. The upload ID
8836 might be invalid, or the multipart upload might have been aborted or
8837 completed.>
8838  
8839 =item *
8840  
8841 I<HTTP Status Code: 404 Not Found>
8842  
8843 =item *
8844  
8845 I<SOAP Fault Code Prefix: Client>
8846  
8847 =back
8848  
8849 =back
8850  
8851 B<Related Resources>
8852  
8853 =over
8854  
8855 =item *
8856  
8857 CreateMultipartUpload
8858 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
8859  
8860 =item *
8861  
8862 CompleteMultipartUpload
8863 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
8864  
8865 =item *
8866  
8867 AbortMultipartUpload
8868 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
8869  
8870 =item *
8871  
8872 ListParts
8873 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
8874  
8875 =item *
8876  
8877 ListMultipartUploads
8878 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
8879  
8880 =back
8881  
8882  
8883  
8884 =head2 UploadPartCopy
8885  
8886 =over
8887  
8888 =item Bucket => Str
8889  
8890 =item CopySource => Str
8891  
8892 =item Key => Str
8893  
8894 =item PartNumber => Int
8895  
8896 =item UploadId => Str
8897  
8898 =item [CopySourceIfMatch => Str]
8899  
8900 =item [CopySourceIfModifiedSince => Str]
8901  
8902 =item [CopySourceIfNoneMatch => Str]
8903  
8904 =item [CopySourceIfUnmodifiedSince => Str]
8905  
8906 =item [CopySourceRange => Str]
8907  
8908 =item [CopySourceSSECustomerAlgorithm => Str]
8909  
8910 =item [CopySourceSSECustomerKey => Str]
8911  
8912 =item [CopySourceSSECustomerKeyMD5 => Str]
8913  
8914 =item [ExpectedBucketOwner => Str]
8915  
8916 =item [ExpectedSourceBucketOwner => Str]
8917  
8918 =item [RequestPayer => Str]
8919  
8920 =item [SSECustomerAlgorithm => Str]
8921  
8922 =item [SSECustomerKey => Str]
8923  
8924 =item [SSECustomerKeyMD5 => Str]
8925  
8926  
8927 =back
8928  
8929 Each argument is described in detail in: L<Paws::S3::UploadPartCopy>
8930  
8931 Returns: a L<Paws::S3::UploadPartCopyOutput> instance
8932  
8933 Uploads a part by copying data from an existing object as data source.
8934 You specify the data source by adding the request header
8935 C<x-amz-copy-source> in your request and a byte range by adding the
8936 request header C<x-amz-copy-source-range> in your request.
8937  
8938 The minimum allowable part size for a multipart upload is 5 MB. For
8939 more information about multipart upload limits, go to Quick Facts
8940 (https://docs.aws.amazon.com/AmazonS3/latest/dev/qfacts.html) in the
8941 I<Amazon S3 User Guide>.
8942  
8943 Instead of using an existing object as part data, you might use the
8944 UploadPart
8945 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
8946 action and provide data in your request.
8947  
8948 You must initiate a multipart upload before you can upload any part. In
8949 response to your initiate request. Amazon S3 returns a unique
8950 identifier, the upload ID, that you must include in your upload part
8951 request.
8952  
8953 For more information about using the C<UploadPartCopy> operation, see
8954 the following:
8955  
8956 =over
8957  
8958 =item *
8959  
8960 For conceptual information about multipart uploads, see Uploading
8961 Objects Using Multipart Upload
8962 (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html)
8963 in the I<Amazon S3 User Guide>.
8964  
8965 =item *
8966  
8967 For information about permissions required to use the multipart upload
8968 API, see Multipart Upload and Permissions
8969 (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html)
8970 in the I<Amazon S3 User Guide>.
8971  
8972 =item *
8973  
8974 For information about copying objects using a single atomic action vs.
8975 the multipart upload, see Operations on Objects
8976 (https://docs.aws.amazon.com/AmazonS3/latest/dev/ObjectOperations.html)
8977 in the I<Amazon S3 User Guide>.
8978  
8979 =item *
8980  
8981 For information about using server-side encryption with
8982 customer-provided encryption keys with the UploadPartCopy operation,
8983 see CopyObject
8984 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html)
8985 and UploadPart
8986 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html).
8987  
8988 =back
8989  
8990 Note the following additional considerations about the request headers
8991 C<x-amz-copy-source-if-match>, C<x-amz-copy-source-if-none-match>,
8992 C<x-amz-copy-source-if-unmodified-since>, and
8993 C<x-amz-copy-source-if-modified-since>:
8994  
8995 =over
8996  
8997 =item *
8998  
8999 B<Consideration 1> - If both of the C<x-amz-copy-source-if-match> and
9000 C<x-amz-copy-source-if-unmodified-since> headers are present in the
9001 request as follows:
9002  
9003 C<x-amz-copy-source-if-match> condition evaluates to C<true>, and;
9004  
9005 C<x-amz-copy-source-if-unmodified-since> condition evaluates to
9006 C<false>;
9007  
9008 Amazon S3 returns C<200 OK> and copies the data.
9009  
9010 =item *
9011  
9012 B<Consideration 2> - If both of the C<x-amz-copy-source-if-none-match>
9013 and C<x-amz-copy-source-if-modified-since> headers are present in the
9014 request as follows:
9015  
9016 C<x-amz-copy-source-if-none-match> condition evaluates to C<false>,
9017 and;
9018  
9019 C<x-amz-copy-source-if-modified-since> condition evaluates to C<true>;
9020  
9021 Amazon S3 returns C<412 Precondition Failed> response code.
9022  
9023 =back
9024  
9025 B<Versioning>
9026  
9027 If your bucket has versioning enabled, you could have multiple versions
9028 of the same object. By default, C<x-amz-copy-source> identifies the
9029 current version of the object to copy. If the current version is a
9030 delete marker and you don't specify a versionId in the
9031 C<x-amz-copy-source>, Amazon S3 returns a 404 error, because the object
9032 does not exist. If you specify versionId in the C<x-amz-copy-source>
9033 and the versionId is a delete marker, Amazon S3 returns an HTTP 400
9034 error, because you are not allowed to specify a delete marker as a
9035 version for the C<x-amz-copy-source>.
9036  
9037 You can optionally specify a specific version of the source object to
9038 copy by adding the C<versionId> subresource as shown in the following
9039 example:
9040  
9041 C<x-amz-copy-source: /bucket/object?versionId=version id>
9042  
9043 B<Special Errors>
9044  
9045 =over
9046  
9047 =item *
9048  
9049 =over
9050  
9051 =item *
9052  
9053 I<Code: NoSuchUpload>
9054  
9055 =item *
9056  
9057 I<Cause: The specified multipart upload does not exist. The upload ID
9058 might be invalid, or the multipart upload might have been aborted or
9059 completed.>
9060  
9061 =item *
9062  
9063 I<HTTP Status Code: 404 Not Found>
9064  
9065 =back
9066  
9067 =item *
9068  
9069 =over
9070  
9071 =item *
9072  
9073 I<Code: InvalidRequest>
9074  
9075 =item *
9076  
9077 I<Cause: The specified copy source is not supported as a byte-range
9078 copy source.>
9079  
9080 =item *
9081  
9082 I<HTTP Status Code: 400 Bad Request>
9083  
9084 =back
9085  
9086 =back
9087  
9088 B<Related Resources>
9089  
9090 =over
9091  
9092 =item *
9093  
9094 CreateMultipartUpload
9095 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)
9096  
9097 =item *
9098  
9099 UploadPart
9100 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)
9101  
9102 =item *
9103  
9104 CompleteMultipartUpload
9105 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html)
9106  
9107 =item *
9108  
9109 AbortMultipartUpload
9110 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html)
9111  
9112 =item *
9113  
9114 ListParts
9115 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html)
9116  
9117 =item *
9118  
9119 ListMultipartUploads
9120 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html)
9121  
9122 =back
9123  
9124  
9125  
9126 =head2 WriteGetObjectResponse
9127  
9128 =over
9129  
9130 =item RequestRoute => Str
9131  
9132 =item RequestToken => Str
9133  
9134 =item [AcceptRanges => Str]
9135  
9136 =item [Body => Str]
9137  
9138 =item [BucketKeyEnabled => Bool]
9139  
9140 =item [CacheControl => Str]
9141  
9142 =item [ContentDisposition => Str]
9143  
9144 =item [ContentEncoding => Str]
9145  
9146 =item [ContentLanguage => Str]
9147  
9148 =item [ContentLength => Int]
9149  
9150 =item [ContentRange => Str]
9151  
9152 =item [ContentType => Str]
9153  
9154 =item [DeleteMarker => Bool]
9155  
9156 =item [ErrorCode => Str]
9157  
9158 =item [ErrorMessage => Str]
9159  
9160 =item [ETag => Str]
9161  
9162 =item [Expiration => Str]
9163  
9164 =item [Expires => Str]
9165  
9166 =item [LastModified => Str]
9167  
9168 =item [Metadata => L<Paws::S3::Metadata>]
9169  
9170 =item [MissingMeta => Int]
9171  
9172 =item [ObjectLockLegalHoldStatus => Str]
9173  
9174 =item [ObjectLockMode => Str]
9175  
9176 =item [ObjectLockRetainUntilDate => Str]
9177  
9178 =item [PartsCount => Int]
9179  
9180 =item [ReplicationStatus => Str]
9181  
9182 =item [RequestCharged => Str]
9183  
9184 =item [Restore => Str]
9185  
9186 =item [ServerSideEncryption => Str]
9187  
9188 =item [SSECustomerAlgorithm => Str]
9189  
9190 =item [SSECustomerKeyMD5 => Str]
9191  
9192 =item [SSEKMSKeyId => Str]
9193  
9194 =item [StatusCode => Int]
9195  
9196 =item [StorageClass => Str]
9197  
9198 =item [TagCount => Int]
9199  
9200 =item [VersionId => Str]
9201  
9202  
9203 =back
9204  
9205 Each argument is described in detail in: L<Paws::S3::WriteGetObjectResponse>
9206  
9207 Returns: nothing
9208  
9209 Passes transformed objects to a C<GetObject> operation when using
9210 Object Lambda Access Points. For information about Object Lambda Access
9211 Points, see Transforming objects with Object Lambda Access Points
9212 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/transforming-objects.html)
9213 in the I<Amazon S3 User Guide>.
9214  
9215 This operation supports metadata that can be returned by GetObject
9216 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html),
9217 in addition to C<RequestRoute>, C<RequestToken>, C<StatusCode>,
9218 C<ErrorCode>, and C<ErrorMessage>. The C<GetObject> response metadata
9219 is supported so that the C<WriteGetObjectResponse> caller, typically an
9220 AWS Lambda function, can provide the same metadata when it internally
9221 invokes C<GetObject>. When C<WriteGetObjectResponse> is called by a
9222 customer-owned Lambda function, the metadata returned to the end user
9223 C<GetObject> call might differ from what Amazon S3 would normally
9224 return.
9225  
9226 AWS provides some prebuilt Lambda functions that you can use with S3
9227 Object Lambda to detect and redact personally identifiable information
9228 (PII) and decompress S3 objects. These Lambda functions are available
9229 in the AWS Serverless Application Repository, and can be selected
9230 through the AWS Management Console when you create your Object Lambda
9231 Access Point.
9232  
9233 Example 1: PII Access Control - This Lambda function uses Amazon
9234 Comprehend, a natural language processing (NLP) service using machine
9235 learning to find insights and relationships in text. It automatically
9236 detects personally identifiable information (PII) such as names,
9237 addresses, dates, credit card numbers, and social security numbers from
9238 documents in your Amazon S3 bucket.
9239  
9240 Example 2: PII Redaction - This Lambda function uses Amazon Comprehend,
9241 a natural language processing (NLP) service using machine learning to
9242 find insights and relationships in text. It automatically redacts
9243 personally identifiable information (PII) such as names, addresses,
9244 dates, credit card numbers, and social security numbers from documents
9245 in your Amazon S3 bucket.
9246  
9247 Example 3: Decompression - The Lambda function
9248 S3ObjectLambdaDecompression, is equipped to decompress objects stored
9249 in S3 in one of six compressed file formats including bzip2, gzip,
9250 snappy, zlib, zstandard and ZIP.
9251  
9252 For information on how to view and use these functions, see Using AWS
9253 built Lambda functions
9254 (https://docs.aws.amazon.com/AmazonS3/latest/userguide/olap-examples.html)
9255 in the I<Amazon S3 User Guide>.
9256  
9257  
9258  
9259  
9260 =head1 PAGINATORS
9261  
9262 Paginator methods are helpers that repetively call methods that return partial results
9263  
9264 =head2 ListAllMultipartUploads(sub { },Bucket => Str, [Delimiter => Str, EncodingType => Str, ExpectedBucketOwner => Str, KeyMarker => Str, MaxUploads => Int, Prefix => Str, UploadIdMarker => Str])
9265  
9266 =head2 ListAllMultipartUploads(Bucket => Str, [Delimiter => Str, EncodingType => Str, ExpectedBucketOwner => Str, KeyMarker => Str, MaxUploads => Int, Prefix => Str, UploadIdMarker => Str])
9267  
9268  
9269 If passed a sub as first parameter, it will call the sub for each element found in :
9270  
9271 - Uploads, passing the object as the first parameter, and the string 'Uploads' as the second parameter
9272  
9273 - CommonPrefixes, passing the object as the first parameter, and the string 'CommonPrefixes' as the second parameter
9274  
9275 If not, it will return a a L<Paws::S3::ListMultipartUploadsOutput> instance with all the C<param>s; andC<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
9276  
9277  
9278 =head2 ListAllObjects(sub { },Bucket => Str, [Delimiter => Str, EncodingType => Str, ExpectedBucketOwner => Str, Marker => Str, MaxKeys => Int, Prefix => Str, RequestPayer => Str])
9279  
9280 =head2 ListAllObjects(Bucket => Str, [Delimiter => Str, EncodingType => Str, ExpectedBucketOwner => Str, Marker => Str, MaxKeys => Int, Prefix => Str, RequestPayer => Str])
9281  
9282  
9283 If passed a sub as first parameter, it will call the sub for each element found in :
9284  
9285 - Contents, passing the object as the first parameter, and the string 'Contents' as the second parameter
9286  
9287 - CommonPrefixes, passing the object as the first parameter, and the string 'CommonPrefixes' as the second parameter
9288  
9289 If not, it will return a a L<Paws::S3::ListObjectsOutput> instance with all the C<param>s; andC<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
9290  
9291  
9292 =head2 ListAllObjectsV2(sub { },Bucket => Str, [ContinuationToken => Str, Delimiter => Str, EncodingType => Str, ExpectedBucketOwner => Str, FetchOwner => Bool, MaxKeys => Int, Prefix => Str, RequestPayer => Str, StartAfter => Str])
9293  
9294 =head2 ListAllObjectsV2(Bucket => Str, [ContinuationToken => Str, Delimiter => Str, EncodingType => Str, ExpectedBucketOwner => Str, FetchOwner => Bool, MaxKeys => Int, Prefix => Str, RequestPayer => Str, StartAfter => Str])
9295  
9296  
9297 If passed a sub as first parameter, it will call the sub for each element found in :
9298  
9299 - Contents, passing the object as the first parameter, and the string 'Contents' as the second parameter
9300  
9301 - CommonPrefixes, passing the object as the first parameter, and the string 'CommonPrefixes' as the second parameter
9302  
9303 If not, it will return a a L<Paws::S3::ListObjectsV2Output> instance with all the C<param>s; andC<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
9304  
9305  
9306 =head2 ListAllObjectVersions(sub { },Bucket => Str, [Delimiter => Str, EncodingType => Str, ExpectedBucketOwner => Str, KeyMarker => Str, MaxKeys => Int, Prefix => Str, VersionIdMarker => Str])
9307  
9308 =head2 ListAllObjectVersions(Bucket => Str, [Delimiter => Str, EncodingType => Str, ExpectedBucketOwner => Str, KeyMarker => Str, MaxKeys => Int, Prefix => Str, VersionIdMarker => Str])
9309  
9310  
9311 If passed a sub as first parameter, it will call the sub for each element found in :
9312  
9313 - Versions, passing the object as the first parameter, and the string 'Versions' as the second parameter
9314  
9315 - DeleteMarkers, passing the object as the first parameter, and the string 'DeleteMarkers' as the second parameter
9316  
9317 - CommonPrefixes, passing the object as the first parameter, and the string 'CommonPrefixes' as the second parameter
9318  
9319 If not, it will return a a L<Paws::S3::ListObjectVersionsOutput> instance with all the C<param>s; andC<param>s; andC<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
9320  
9321  
9322 =head2 ListAllParts(sub { },Bucket => Str, Key => Str, UploadId => Str, [ExpectedBucketOwner => Str, MaxParts => Int, PartNumberMarker => Int, RequestPayer => Str])
9323  
9324 =head2 ListAllParts(Bucket => Str, Key => Str, UploadId => Str, [ExpectedBucketOwner => Str, MaxParts => Int, PartNumberMarker => Int, RequestPayer => Str])
9325  
9326  
9327 If passed a sub as first parameter, it will call the sub for each element found in :
9328  
9329 - Parts, passing the object as the first parameter, and the string 'Parts' as the second parameter
9330  
9331 If not, it will return a a L<Paws::S3::ListPartsOutput> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
9332  
9333  
9334  
9335  
9336  
9337 =head1 SEE ALSO
9338  
9339 This service class forms part of L<Paws>
9340  
9341 =head1 BUGS and CONTRIBUTIONS
9342  
9343 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
9344  
9345 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
9346  
9347 =cut
9348  
« blib/lib/Paws/Route53Domains.pm ↑ Summary blib/lib/Paws/ImportExport.pm »