PNG  IHDR;IDATxܻn0K )(pA 7LeG{ §㻢|ذaÆ 6lذaÆ 6lذaÆ 6lom$^yذag5bÆ 6lذaÆ 6lذa{ 6lذaÆ `}HFkm,mӪôô! x|'ܢ˟;E:9&ᶒ}{v]n&6 h_tڠ͵-ҫZ;Z$.Pkž)!o>}leQfJTu іچ\X=8Rن4`Vwl>nG^is"ms$ui?wbs[m6K4O.4%/bC%t Mז -lG6mrz2s%9s@-k9=)kB5\+͂Zsٲ Rn~GRC wIcIn7jJhۛNCS|j08yiHKֶۛkɈ+;SzL/F*\Ԕ#"5m2[S=gnaPeғL lذaÆ 6l^ḵaÆ 6lذaÆ 6lذa; _ذaÆ 6lذaÆ 6lذaÆ RIENDB` package Paws::S3; warn "Paws::S3 is not stable / supported / entirely developed" unless $ENV{'PAWS_SILENCE_UNSTABLE_WARNINGS'}; use Moose; sub service { 's3' } sub signing_name { 's3' } sub version { '2006-03-01' } sub flattened_arrays { 1 } has max_attempts => (is => 'ro', isa => 'Int', default => 5); has retry => (is => 'ro', isa => 'HashRef', default => sub { { base => 'rand', type => 'exponential', growth_factor => 2 } }); has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [ sub { defined $_[0]->http_status and $_[0]->http_status == 400 and $_[0]->code eq 'BadDigest' }, sub { defined $_[0]->http_status and $_[0]->http_status == 400 and $_[0]->code eq 'RequestTimeout' }, ] }); with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::S3Signature', 'Paws::Net::RestXmlCaller'; has '+region_rules' => (default => sub { my $regioninfo; $regioninfo = [ { constraints => [ [ 'region', 'oneOf', [ 'us-east-1', undef ] ] ], properties => { credentialScope => { region => 'us-east-1' } }, uri => '{scheme}://s3.amazonaws.com' }, { constraints => [ [ 'region', 'startsWith', 'cn-' ] ], properties => { signatureVersion => 's3v4' }, uri => '{scheme}://{service}.{region}.amazonaws.com.cn' }, { constraints => [ [ 'region', 'oneOf', [ 'us-east-1', 'ap-northeast-1', 'sa-east-1', 'ap-southeast-1', 'ap-southeast-2', 'us-west-2', 'us-west-1', 'eu-west-1', 'us-gov-west-1', 'fips-us-gov-west-1' ] ] ], uri => '{scheme}://{service}-{region}.amazonaws.com' }, { constraints => [ [ 'region', 'notEquals', undef ] ], properties => { signatureVersion => 's3v4' }, uri => '{scheme}://{service}.{region}.amazonaws.com' } ]; return $regioninfo; }); sub AbortMultipartUpload { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::AbortMultipartUpload', @_); return $self->caller->do_call($self, $call_object); } sub CompleteMultipartUpload { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::CompleteMultipartUpload', @_); return $self->caller->do_call($self, $call_object); } sub CopyObject { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::CopyObject', @_); return $self->caller->do_call($self, $call_object); } sub CreateBucket { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::CreateBucket', @_); return $self->caller->do_call($self, $call_object); } sub CreateMultipartUpload { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::CreateMultipartUpload', @_); return $self->caller->do_call($self, $call_object); } sub DeleteBucket { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucket', @_); return $self->caller->do_call($self, $call_object); } sub DeleteBucketAnalyticsConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketAnalyticsConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub DeleteBucketCors { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketCors', @_); return $self->caller->do_call($self, $call_object); } sub DeleteBucketEncryption { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketEncryption', @_); return $self->caller->do_call($self, $call_object); } sub DeleteBucketIntelligentTieringConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketIntelligentTieringConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub DeleteBucketInventoryConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketInventoryConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub DeleteBucketLifecycle { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketLifecycle', @_); return $self->caller->do_call($self, $call_object); } sub DeleteBucketMetricsConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketMetricsConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub DeleteBucketOwnershipControls { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketOwnershipControls', @_); return $self->caller->do_call($self, $call_object); } sub DeleteBucketPolicy { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketPolicy', @_); return $self->caller->do_call($self, $call_object); } sub DeleteBucketReplication { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketReplication', @_); return $self->caller->do_call($self, $call_object); } sub DeleteBucketTagging { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketTagging', @_); return $self->caller->do_call($self, $call_object); } sub DeleteBucketWebsite { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteBucketWebsite', @_); return $self->caller->do_call($self, $call_object); } sub DeleteObject { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteObject', @_); return $self->caller->do_call($self, $call_object); } sub DeleteObjects { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteObjects', @_); return $self->caller->do_call($self, $call_object); } sub DeleteObjectTagging { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeleteObjectTagging', @_); return $self->caller->do_call($self, $call_object); } sub DeletePublicAccessBlock { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::DeletePublicAccessBlock', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketAccelerateConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketAccelerateConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketAcl { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketAcl', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketAnalyticsConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketAnalyticsConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketCors { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketCors', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketEncryption { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketEncryption', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketIntelligentTieringConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketIntelligentTieringConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketInventoryConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketInventoryConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketLifecycle { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketLifecycle', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketLifecycleConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketLifecycleConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketLocation { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketLocation', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketLogging { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketLogging', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketMetricsConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketMetricsConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketNotification { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketNotification', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketNotificationConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketNotificationConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketOwnershipControls { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketOwnershipControls', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketPolicy { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketPolicy', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketPolicyStatus { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketPolicyStatus', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketReplication { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketReplication', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketRequestPayment { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketRequestPayment', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketTagging { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketTagging', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketVersioning { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketVersioning', @_); return $self->caller->do_call($self, $call_object); } sub GetBucketWebsite { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetBucketWebsite', @_); return $self->caller->do_call($self, $call_object); } sub GetObject { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetObject', @_); return $self->caller->do_call($self, $call_object); } sub GetObjectAcl { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetObjectAcl', @_); return $self->caller->do_call($self, $call_object); } sub GetObjectLegalHold { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetObjectLegalHold', @_); return $self->caller->do_call($self, $call_object); } sub GetObjectLockConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetObjectLockConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub GetObjectRetention { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetObjectRetention', @_); return $self->caller->do_call($self, $call_object); } sub GetObjectTagging { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetObjectTagging', @_); return $self->caller->do_call($self, $call_object); } sub GetObjectTorrent { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetObjectTorrent', @_); return $self->caller->do_call($self, $call_object); } sub GetPublicAccessBlock { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::GetPublicAccessBlock', @_); return $self->caller->do_call($self, $call_object); } sub HeadBucket { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::HeadBucket', @_); return $self->caller->do_call($self, $call_object); } sub HeadObject { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::HeadObject', @_); return $self->caller->do_call($self, $call_object); } sub ListBucketAnalyticsConfigurations { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::ListBucketAnalyticsConfigurations', @_); return $self->caller->do_call($self, $call_object); } sub ListBucketIntelligentTieringConfigurations { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::ListBucketIntelligentTieringConfigurations', @_); return $self->caller->do_call($self, $call_object); } sub ListBucketInventoryConfigurations { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::ListBucketInventoryConfigurations', @_); return $self->caller->do_call($self, $call_object); } sub ListBucketMetricsConfigurations { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::ListBucketMetricsConfigurations', @_); return $self->caller->do_call($self, $call_object); } sub ListBuckets { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::ListBuckets', @_); return $self->caller->do_call($self, $call_object); } sub ListMultipartUploads { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::ListMultipartUploads', @_); return $self->caller->do_call($self, $call_object); } sub ListObjects { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::ListObjects', @_); return $self->caller->do_call($self, $call_object); } sub ListObjectsV2 { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::ListObjectsV2', @_); return $self->caller->do_call($self, $call_object); } sub ListObjectVersions { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::ListObjectVersions', @_); return $self->caller->do_call($self, $call_object); } sub ListParts { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::ListParts', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketAccelerateConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketAccelerateConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketAcl { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketAcl', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketAnalyticsConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketAnalyticsConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketCors { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketCors', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketEncryption { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketEncryption', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketIntelligentTieringConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketIntelligentTieringConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketInventoryConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketInventoryConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketLifecycle { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketLifecycle', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketLifecycleConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketLifecycleConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketLogging { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketLogging', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketMetricsConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketMetricsConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketNotification { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketNotification', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketNotificationConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketNotificationConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketOwnershipControls { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketOwnershipControls', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketPolicy { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketPolicy', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketReplication { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketReplication', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketRequestPayment { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketRequestPayment', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketTagging { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketTagging', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketVersioning { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketVersioning', @_); return $self->caller->do_call($self, $call_object); } sub PutBucketWebsite { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutBucketWebsite', @_); return $self->caller->do_call($self, $call_object); } sub PutObject { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutObject', @_); return $self->caller->do_call($self, $call_object); } sub PutObjectAcl { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutObjectAcl', @_); return $self->caller->do_call($self, $call_object); } sub PutObjectLegalHold { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutObjectLegalHold', @_); return $self->caller->do_call($self, $call_object); } sub PutObjectLockConfiguration { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutObjectLockConfiguration', @_); return $self->caller->do_call($self, $call_object); } sub PutObjectRetention { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutObjectRetention', @_); return $self->caller->do_call($self, $call_object); } sub PutObjectTagging { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutObjectTagging', @_); return $self->caller->do_call($self, $call_object); } sub PutPublicAccessBlock { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::PutPublicAccessBlock', @_); return $self->caller->do_call($self, $call_object); } sub RestoreObject { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::RestoreObject', @_); return $self->caller->do_call($self, $call_object); } sub SelectObjectContent { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::SelectObjectContent', @_); return $self->caller->do_call($self, $call_object); } sub UploadPart { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::UploadPart', @_); return $self->caller->do_call($self, $call_object); } sub UploadPartCopy { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::UploadPartCopy', @_); return $self->caller->do_call($self, $call_object); } sub WriteGetObjectResponse { my $self = shift; my $call_object = $self->new_with_coercions('Paws::S3::WriteGetObjectResponse', @_); return $self->caller->do_call($self, $call_object); } sub ListAllMultipartUploads { my $self = shift; my $callback = shift @_ if (ref($_[0]) eq 'CODE'); my $result = $self->ListMultipartUploads(@_); my $next_result = $result; if (not defined $callback) { while ($next_result->IsTruncated) { $next_result = $self->ListMultipartUploads(@_, KeyMarker => $next_result->NextKeyMarker, UploadIdMarker => $next_result->NextUploadIdMarker); push @{ $result->Uploads }, @{ $next_result->Uploads }; push @{ $result->CommonPrefixes }, @{ $next_result->CommonPrefixes }; } return $result; } else { while ($result->IsTruncated) { $callback->($_ => 'Uploads') foreach (@{ $result->Uploads }); $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes }); $result = $self->ListMultipartUploads(@_, KeyMarker => $result->NextKeyMarker, UploadIdMarker => $result->NextUploadIdMarker); } $callback->($_ => 'Uploads') foreach (@{ $result->Uploads }); $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes }); } return undef } sub ListAllObjects { my $self = shift; my $callback = shift @_ if (ref($_[0]) eq 'CODE'); my $result = $self->ListObjects(@_); my $next_result = $result; if (not defined $callback) { while ($next_result->IsTruncated) { $next_result = $self->ListObjects(@_, Marker => $result->NextMarker || ( (defined $result->Contents->[-1]) ? $result->Contents->[-1]->Key : undef )); push @{ $result->Contents }, @{ $next_result->Contents }; push @{ $result->CommonPrefixes }, @{ $next_result->CommonPrefixes }; } return $result; } else { while ($result->IsTruncated) { $callback->($_ => 'Contents') foreach (@{ $result->Contents }); $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes }); $result = $self->ListObjects(@_, Marker => $result->NextMarker || ( (defined $result->Contents->[-1]) ? $result->Contents->[-1]->Key : undef )); } $callback->($_ => 'Contents') foreach (@{ $result->Contents }); $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes }); } return undef } sub ListAllObjectsV2 { my $self = shift; my $callback = shift @_ if (ref($_[0]) eq 'CODE'); my $result = $self->ListObjectsV2(@_); my $next_result = $result; if (not defined $callback) { while ($next_result->IsTruncated) { $next_result = $self->ListObjectsV2(@_, ContinuationToken => $next_result->NextContinuationToken); push @{ $result->Contents }, @{ $next_result->Contents }; push @{ $result->CommonPrefixes }, @{ $next_result->CommonPrefixes }; } return $result; } else { while ($result->IsTruncated) { $callback->($_ => 'Contents') foreach (@{ $result->Contents }); $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes }); $result = $self->ListObjectsV2(@_, ContinuationToken => $result->NextContinuationToken); } $callback->($_ => 'Contents') foreach (@{ $result->Contents }); $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes }); } return undef } sub ListAllObjectVersions { my $self = shift; my $callback = shift @_ if (ref($_[0]) eq 'CODE'); my $result = $self->ListObjectVersions(@_); my $next_result = $result; if (not defined $callback) { while ($next_result->IsTruncated) { $next_result = $self->ListObjectVersions(@_, KeyMarker => $next_result->NextKeyMarker, VersionIdMarker => $next_result->NextVersionIdMarker); push @{ $result->Versions }, @{ $next_result->Versions }; push @{ $result->DeleteMarkers }, @{ $next_result->DeleteMarkers }; push @{ $result->CommonPrefixes }, @{ $next_result->CommonPrefixes }; } return $result; } else { while ($result->IsTruncated) { $callback->($_ => 'Versions') foreach (@{ $result->Versions }); $callback->($_ => 'DeleteMarkers') foreach (@{ $result->DeleteMarkers }); $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes }); $result = $self->ListObjectVersions(@_, KeyMarker => $result->NextKeyMarker, VersionIdMarker => $result->NextVersionIdMarker); } $callback->($_ => 'Versions') foreach (@{ $result->Versions }); $callback->($_ => 'DeleteMarkers') foreach (@{ $result->DeleteMarkers }); $callback->($_ => 'CommonPrefixes') foreach (@{ $result->CommonPrefixes }); } return undef } sub ListAllParts { my $self = shift; my $callback = shift @_ if (ref($_[0]) eq 'CODE'); my $result = $self->ListParts(@_); my $next_result = $result; if (not defined $callback) { while ($next_result->IsTruncated) { $next_result = $self->ListParts(@_, PartNumberMarker => $next_result->NextPartNumberMarker); push @{ $result->Parts }, @{ $next_result->Parts }; } return $result; } else { while ($result->IsTruncated) { $callback->($_ => 'Parts') foreach (@{ $result->Parts }); $result = $self->ListParts(@_, PartNumberMarker => $result->NextPartNumberMarker); } $callback->($_ => 'Parts') foreach (@{ $result->Parts }); } return undef } 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 / } 1; ### main pod documentation begin ### =head1 NAME Paws::S3 - Perl Interface to AWS Amazon Simple Storage Service =head1 SYNOPSIS use Paws; my $obj = Paws->service('S3'); my $res = $obj->Method( Arg1 => $val1, Arg2 => [ 'V1', 'V2' ], # if Arg3 is an object, the HashRef will be used as arguments to the constructor # of the arguments type Arg3 => { Att1 => 'Val1' }, # if Arg4 is an array of objects, the HashRefs will be passed as arguments to # the constructor of the arguments type Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], ); =head1 DESCRIPTION Amazon Simple Storage Service Amazon Simple Storage Service is storage for the Internet. It is designed to make web-scale computing easier for developers. Amazon S3 has a simple web services interface that you can use to store and retrieve any amount of data, at any time, from anywhere on the web. It gives any developer access to the same highly scalable, reliable, fast, inexpensive data storage infrastructure that Amazon uses to run its own global network of web sites. The service aims to maximize benefits of scale and to pass those benefits on to developers. For the AWS API documentation, see L =head1 METHODS =head2 AbortMultipartUpload =over =item Bucket => Str =item Key => Str =item UploadId => Str =item [ExpectedBucketOwner => Str] =item [RequestPayer => Str] =back Each argument is described in detail in: L Returns: a L instance This action aborts a multipart upload. After a multipart upload is aborted, no additional parts can be uploaded using that upload ID. The storage consumed by any previously uploaded parts will be freed. However, if any part uploads are currently in progress, those part uploads might or might not succeed. As a result, it might be necessary to abort a given multipart upload multiple times in order to completely free all storage consumed by all parts. To verify that all parts have been removed, so you don't get charged for the part storage, you should call the ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) action and ensure that the parts list is empty. For information about permissions required to use the multipart upload, see Multipart Upload and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). The following operations are related to C: =over =item * CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) =item * UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) =item * CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) =item * ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) =item * ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) =back =head2 CompleteMultipartUpload =over =item Bucket => Str =item Key => Str =item UploadId => Str =item [ExpectedBucketOwner => Str] =item [MultipartUpload => L] =item [RequestPayer => Str] =back Each argument is described in detail in: L Returns: a L instance Completes a multipart upload by assembling previously uploaded parts. You first initiate the multipart upload and then upload all parts using the UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) operation. After successfully uploading all relevant parts of an upload, you call this action to complete the upload. Upon receiving this request, Amazon S3 concatenates all the parts in ascending order by part number to create a new object. In the Complete Multipart Upload request, you must provide the parts list. You must ensure that the parts list is complete. This action concatenates the parts that you provide in the list. For each part in the list, you must provide the part number and the C value, returned after that part was uploaded. Processing of a Complete Multipart Upload request could take several minutes to complete. After Amazon S3 begins processing the request, it sends an HTTP response header that specifies a 200 OK response. While processing is in progress, Amazon S3 periodically sends white space characters to keep the connection from timing out. Because a request could fail after the initial 200 OK response has been sent, it is important that you check the response body to determine whether the request succeeded. Note that if C fails, applications should be prepared to retry the failed requests. For more information, see Amazon S3 Error Best Practices (https://docs.aws.amazon.com/AmazonS3/latest/dev/ErrorBestPractices.html). For more information about multipart uploads, see Uploading Objects Using Multipart Upload (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html). For information about permissions required to use the multipart upload API, see Multipart Upload and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). C has the following special errors: =over =item * Error code: C =over =item * Description: Your proposed upload is smaller than the minimum allowed object size. Each part must be at least 5 MB in size, except the last part. =item * 400 Bad Request =back =item * Error code: C =over =item * Description: One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag. =item * 400 Bad Request =back =item * Error code: C =over =item * Description: The list of parts was not in ascending order. The parts list must be specified in order by part number. =item * 400 Bad Request =back =item * Error code: C =over =item * Description: The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed. =item * 404 Not Found =back =back The following operations are related to C: =over =item * CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) =item * UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) =item * AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) =item * ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) =item * ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) =back =head2 CopyObject =over =item Bucket => Str =item CopySource => Str =item Key => Str =item [ACL => Str] =item [BucketKeyEnabled => Bool] =item [CacheControl => Str] =item [ContentDisposition => Str] =item [ContentEncoding => Str] =item [ContentLanguage => Str] =item [ContentType => Str] =item [CopySourceIfMatch => Str] =item [CopySourceIfModifiedSince => Str] =item [CopySourceIfNoneMatch => Str] =item [CopySourceIfUnmodifiedSince => Str] =item [CopySourceSSECustomerAlgorithm => Str] =item [CopySourceSSECustomerKey => Str] =item [CopySourceSSECustomerKeyMD5 => Str] =item [ExpectedBucketOwner => Str] =item [ExpectedSourceBucketOwner => Str] =item [Expires => Str] =item [GrantFullControl => Str] =item [GrantRead => Str] =item [GrantReadACP => Str] =item [GrantWriteACP => Str] =item [Metadata => L] =item [MetadataDirective => Str] =item [ObjectLockLegalHoldStatus => Str] =item [ObjectLockMode => Str] =item [ObjectLockRetainUntilDate => Str] =item [RequestPayer => Str] =item [ServerSideEncryption => Str] =item [SSECustomerAlgorithm => Str] =item [SSECustomerKey => Str] =item [SSECustomerKeyMD5 => Str] =item [SSEKMSEncryptionContext => Str] =item [SSEKMSKeyId => Str] =item [StorageClass => Str] =item [Tagging => Str] =item [TaggingDirective => Str] =item [WebsiteRedirectLocation => Str] =back Each argument is described in detail in: L Returns: a L instance Creates a copy of an object that is already stored in Amazon S3. You can store individual objects of up to 5 TB in Amazon S3. You create a copy of your object up to 5 GB in size in a single atomic action using this API. However, to copy an object greater than 5 GB, you must use the multipart upload Upload Part - Copy API. For more information, see Copy Object Using the REST Multipart Upload API (https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjctsUsingRESTMPUapi.html). All copy requests must be authenticated. Additionally, you must have I access to the source object and I access to the destination bucket. For more information, see REST Authentication (https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html). Both the Region that you want to copy the object from and the Region that you want to copy the object to must be enabled for your account. A copy request might return an error when Amazon S3 receives the copy request or while Amazon S3 is copying the files. If the error occurs before the copy action starts, you receive a standard Amazon S3 error. If the error occurs during the copy operation, the error response is embedded in the C<200 OK> response. This means that a C<200 OK> response can contain either a success or an error. Design your application to parse the contents of the response and handle it appropriately. If the copy is successful, you receive a response with information about the copied object. If the request is an HTTP 1.1 request, the response is chunk encoded. If it were not, it would not contain the content-length, and you would need to read the entire body. The copy request charge is based on the storage class and Region that you specify for the destination object. For pricing information, see Amazon S3 pricing (http://aws.amazon.com/s3/pricing/). Amazon S3 transfer acceleration does not support cross-Region copies. If you request a cross-Region copy using a transfer acceleration endpoint, you get a 400 C error. For more information, see Transfer Acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html). B When copying an object, you can preserve all metadata (default) or specify new metadata. However, the ACL is not preserved and is set to private for the user making the request. To override the default ACL setting, specify a new ACL when generating a copy request. For more information, see Using ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html). To specify whether you want the object metadata copied from the source object or replaced with metadata provided in the request, you can optionally add the C header. When you grant permissions, you can use the C condition key to enforce certain metadata behavior when objects are uploaded. For more information, see Specifying Conditions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/amazon-s3-policy-keys.html) in the I. For a complete list of Amazon S3-specific condition keys, see Actions, Resources, and Condition Keys for Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/list_amazons3.html). B Headers> To only copy an object under certain conditions, such as whether the C matches or whether the object was modified before or after a specified date, use the following request parameters: =over =item * C =item * C =item * C =item * C =back If both the C and C headers are present in the request and evaluate as follows, Amazon S3 returns C<200 OK> and copies the data: =over =item * C condition evaluates to true =item * C condition evaluates to false =back If both the C and C headers are present in the request and evaluate as follows, Amazon S3 returns the C<412 Precondition Failed> response code: =over =item * C condition evaluates to false =item * C condition evaluates to true =back All headers with the C prefix, including C, must be signed. B When you perform a CopyObject operation, you can optionally use the appropriate encryption-related headers to encrypt the object using server-side encryption with AWS managed encryption keys (SSE-S3 or SSE-KMS) or a customer-provided encryption key. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html). If a target object uses SSE-KMS, you can enable an S3 Bucket Key for the object. For more information, see Amazon S3 Bucket Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the I. B When copying an object, you can optionally use headers to grant ACL-based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) and Managing ACLs Using the REST API (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html). B You can use the C action to change the storage class of an object that is already stored in Amazon S3 using the C parameter. For more information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in the I. B By default, C identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the object was deleted. To copy a different version, use the C subresource. If you enable versioning on the target bucket, Amazon S3 generates a unique version ID for the object being copied. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID of the copied object in the C response header in the response. If you do not enable versioning or suspend it on the target bucket, the version ID that Amazon S3 generates is always null. If the source object's storage class is GLACIER, you must restore a copy of this object before you can use it as a source object for the copy operation. For more information, see RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html). The following operations are related to C: =over =item * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) =item * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) =back For more information, see Copying Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/CopyingObjectsExamples.html). =head2 CreateBucket =over =item Bucket => Str =item [ACL => Str] =item [ContentLength => Int] =item [CreateBucketConfiguration => L] =item [GrantFullControl => Str] =item [GrantRead => Str] =item [GrantReadACP => Str] =item [GrantWrite => Str] =item [GrantWriteACP => Str] =item [ObjectLockEnabledForBucket => Bool] =back Each argument is described in detail in: L Returns: a L instance Creates a new S3 bucket. To create a bucket, you must register with Amazon S3 and have a valid AWS Access Key ID to authenticate requests. Anonymous requests are never allowed to create buckets. By creating the bucket, you become the bucket owner. Not every string is an acceptable bucket name. For information about bucket naming restrictions, see Bucket naming rules (https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html). If you want to create an Amazon S3 on Outposts bucket, see Create Bucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_control_CreateBucket.html). By default, the bucket is created in the US East (N. Virginia) Region. You can optionally specify a Region in the request body. You might choose a Region to optimize latency, minimize costs, or address regulatory requirements. For example, if you reside in Europe, you will probably find it advantageous to create buckets in the Europe (Ireland) Region. For more information, see Accessing a bucket (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingBucket.html#access-bucket-intro). If you send your create bucket request to the C endpoint, the request goes to the us-east-1 Region. Accordingly, the signature calculations in Signature Version 4 must use us-east-1 as the Region, even if the location constraint in the request specifies another Region where the bucket is to be created. If you create a bucket in a Region other than US East (N. Virginia), your application must be able to handle 307 redirect. For more information, see Virtual hosting of buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html). When creating a bucket using this operation, you can optionally specify the accounts or groups that should be granted specific permissions on the bucket. There are two ways to grant the appropriate permissions using the request headers. =over =item * Specify a canned ACL using the C request header. Amazon S3 supports a set of predefined ACLs, known as I. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). =item * Specify access permissions explicitly using the C, C, C, C, and C headers. These headers map to the set of permissions Amazon S3 supports in an ACL. For more information, see Access control list (ACL) overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). You specify each grantee as a type=value pair, where the type is one of the following: =over =item * C E if the value specified is the canonical user ID of an AWS account =item * C E if you are granting permissions to a predefined group =item * C E if the value specified is the email address of an AWS account Using email addresses to specify a grantee is only supported in the following AWS Regions: =over =item * US East (N. Virginia) =item * US West (N. California) =item * US West (Oregon) =item * Asia Pacific (Singapore) =item * Asia Pacific (Sydney) =item * Asia Pacific (Tokyo) =item * Europe (Ireland) =item * South America (SEo Paulo) =back For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the AWS General Reference. =back For example, the following C header grants the AWS accounts identified by account IDs permissions to read object data and its metadata: C =back You can use either a canned ACL or specify access permissions explicitly. You cannot do both. The following operations are related to C: =over =item * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) =item * DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) =back =head2 CreateMultipartUpload =over =item Bucket => Str =item Key => Str =item [ACL => Str] =item [BucketKeyEnabled => Bool] =item [CacheControl => Str] =item [ContentDisposition => Str] =item [ContentEncoding => Str] =item [ContentLanguage => Str] =item [ContentType => Str] =item [ExpectedBucketOwner => Str] =item [Expires => Str] =item [GrantFullControl => Str] =item [GrantRead => Str] =item [GrantReadACP => Str] =item [GrantWriteACP => Str] =item [Metadata => L] =item [ObjectLockLegalHoldStatus => Str] =item [ObjectLockMode => Str] =item [ObjectLockRetainUntilDate => Str] =item [RequestPayer => Str] =item [ServerSideEncryption => Str] =item [SSECustomerAlgorithm => Str] =item [SSECustomerKey => Str] =item [SSECustomerKeyMD5 => Str] =item [SSEKMSEncryptionContext => Str] =item [SSEKMSKeyId => Str] =item [StorageClass => Str] =item [Tagging => Str] =item [WebsiteRedirectLocation => Str] =back Each argument is described in detail in: L Returns: a L instance This action initiates a multipart upload and returns an upload ID. This upload ID is used to associate all of the parts in the specific multipart upload. You specify this upload ID in each of your subsequent upload part requests (see UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html)). You also include this upload ID in the final request to either complete or abort the multipart upload request. For more information about multipart uploads, see Multipart Upload Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html). If you have configured a lifecycle rule to abort incomplete multipart uploads, the upload must complete within the number of days specified in the bucket lifecycle configuration. Otherwise, the incomplete multipart upload becomes eligible for an abort action and Amazon S3 aborts the multipart upload. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuoverview.html#mpu-abort-incomplete-mpu-lifecycle-config). For information about the permissions required to use the multipart upload API, see Multipart Upload and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). For request signing, multipart upload is just a series of regular requests. You initiate a multipart upload, send one or more requests to upload parts, and then complete the multipart upload process. You sign each request individually. There is nothing special about signing multipart upload requests. For more information about signing, see Authenticating Requests (AWS Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html). After you initiate a multipart upload and upload one or more parts, to stop being charged for storing the uploaded parts, you must either complete or abort the multipart upload. Amazon S3 frees up the space used to store the parts and stop charging you for storing them only after you either complete or abort a multipart upload. You can optionally request server-side encryption. For server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. You can provide your own encryption key, or use AWS Key Management Service (AWS KMS) customer master keys (CMKs) or Amazon S3-managed encryption keys. If you choose to provide your own encryption key, the request headers you provide in UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) and UploadPartCopy (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html) requests must match the headers you used in the request to initiate the upload by using C. To perform a multipart upload with encryption using an AWS KMS CMK, the requester must have permission to the C and C actions on the key. These permissions are required because Amazon S3 must decrypt and read data from the encrypted file parts before it completes the multipart upload. For more information, see Multipart upload API and permissions (https://docs.aws.amazon.com/AmazonS3/latest/userguide/mpuoverview.html#mpuAndPermissions) in the I. If your AWS Identity and Access Management (IAM) user or role is in the same AWS account as the AWS KMS CMK, then you must have these permissions on the key policy. If your IAM user or role belongs to a different account than the key, then you must have the permissions on both the key policy and your IAM user or role. For more information, see Protecting Data Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html). =over =item Access Permissions When copying an object, you can optionally specify the accounts or groups that should be granted specific permissions on the new object. There are two ways to grant the permissions using the request headers: =over =item * Specify a canned ACL with the C request header. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). =item * Specify access permissions explicitly with the C, C, C, and C headers. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). =back You can use either a canned ACL or specify access permissions explicitly. You cannot do both. =item Server-Side- Encryption-Specific Request Headers You can optionally tell Amazon S3 to encrypt data at rest using server-side encryption. Server-side encryption is for data encryption at rest. Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it when you access it. The option you use depends on whether you want to use AWS managed encryption keys or provide your own encryption key. =over =item * Use encryption keys managed by Amazon S3 or customer master keys (CMKs) stored in AWS Key Management Service (AWS KMS) E If you want AWS to manage the keys used to encrypt data, specify the following headers in the request. =over =item * x-amz-server-side-encryption =item * x-amz-server-side-encryption-aws-kms-key-id =item * x-amz-server-side-encryption-context =back If you specify C, but don't provide C, Amazon S3 uses the AWS managed CMK in AWS KMS to protect the data. All GET and PUT requests for an object protected by AWS KMS fail if you don't make them with SSL or by using SigV4. For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html). =item * Use customer-provided encryption keys E If you want to manage your own encryption keys, provide all the following headers in the request. =over =item * x-amz-server-side-encryption-customer-algorithm =item * x-amz-server-side-encryption-customer-key =item * x-amz-server-side-encryption-customer-key-MD5 =back For more information about server-side encryption with CMKs stored in AWS KMS (SSE-KMS), see Protecting Data Using Server-Side Encryption with CMKs stored in AWS KMS (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingKMSEncryption.html). =back =item Access-Control-List (ACL)-Specific Request Headers You also can use the following access controlErelated headers with this operation. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the access control list (ACL) on the object. For more information, see Using ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html). With this operation, you can grant access permissions using one of the following two methods: =over =item * Specify a canned ACL (C) E Amazon S3 supports a set of predefined ACLs, known as I. Each canned ACL has a predefined set of grantees and permissions. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). =item * Specify access permissions explicitly E To explicitly grant access permissions to specific AWS accounts or groups, use the following headers. Each header maps to specific permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). In the header, you specify a list of grantees who get the specific permission. To grant permissions explicitly, use: =over =item * x-amz-grant-read =item * x-amz-grant-write =item * x-amz-grant-read-acp =item * x-amz-grant-write-acp =item * x-amz-grant-full-control =back You specify each grantee as a type=value pair, where the type is one of the following: =over =item * C E if the value specified is the canonical user ID of an AWS account =item * C E if you are granting permissions to a predefined group =item * C E if the value specified is the email address of an AWS account Using email addresses to specify a grantee is only supported in the following AWS Regions: =over =item * US East (N. Virginia) =item * US West (N. California) =item * US West (Oregon) =item * Asia Pacific (Singapore) =item * Asia Pacific (Sydney) =item * Asia Pacific (Tokyo) =item * Europe (Ireland) =item * South America (SEo Paulo) =back For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the AWS General Reference. =back For example, the following C header grants the AWS accounts identified by account IDs permissions to read object data and its metadata: C =back =back The following operations are related to C: =over =item * UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) =item * CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) =item * AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) =item * ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) =item * ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) =back =head2 DeleteBucket =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Deletes the S3 bucket. All objects (including all object versions and delete markers) in the bucket must be deleted before the bucket itself can be deleted. B =over =item * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) =item * DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) =back =head2 DeleteBucketAnalyticsConfiguration =over =item Bucket => Str =item Id => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Deletes an analytics configuration for the bucket (specified by the analytics configuration ID). To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). For information about the Amazon S3 analytics feature, see Amazon S3 Analytics E Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html). The following operations are related to C: =over =item * GetBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) =item * ListBucketAnalyticsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) =item * PutBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) =back =head2 DeleteBucketCors =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Deletes the C configuration information set for the bucket. To use this operation, you must have permission to perform the C action. The bucket owner has this permission by default and can grant this permission to others. For information about C, see Enabling Cross-Origin Resource Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the I. B =over =item * PutBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html) =item * RESTOPTIONSobject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html) =back =head2 DeleteBucketEncryption =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing This implementation of the DELETE action removes default encryption from the bucket. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the I. To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) in the I. B =over =item * PutBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html) =item * GetBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) =back =head2 DeleteBucketIntelligentTieringConfiguration =over =item Bucket => Str =item Id => Str =back Each argument is described in detail in: L Returns: nothing Deletes the S3 Intelligent-Tiering configuration from the specified bucket. The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change. The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class. If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). Operations related to C include: =over =item * GetBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html) =item * PutBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html) =item * ListBucketIntelligentTieringConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html) =back =head2 DeleteBucketInventoryConfiguration =over =item Bucket => Str =item Id => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Deletes an inventory configuration (identified by the inventory ID) from the bucket. To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). For information about the Amazon S3 inventory feature, see Amazon S3 Inventory (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html). Operations related to C include: =over =item * GetBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) =item * PutBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) =item * ListBucketInventoryConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) =back =head2 DeleteBucketLifecycle =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Deletes the lifecycle configuration from the specified bucket. Amazon S3 removes all the lifecycle configuration rules in the lifecycle subresource associated with the bucket. Your objects never expire, and Amazon S3 no longer automatically deletes any objects on the basis of rules contained in the deleted lifecycle configuration. To use this operation, you must have permission to perform the C action. By default, the bucket owner has this permission and the bucket owner can grant this permission to others. There is usually some time lag before lifecycle configuration deletion is fully propagated to all the Amazon S3 systems. For more information about the object expiration, see Elements to Describe Lifecycle Actions (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#intro-lifecycle-rules-actions). Related actions include: =over =item * PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html) =item * GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) =back =head2 DeleteBucketMetricsConfiguration =over =item Bucket => Str =item Id => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Deletes a metrics configuration for the Amazon CloudWatch request metrics (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics. To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html). The following operations are related to C: =over =item * GetBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) =item * PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) =item * ListBucketMetricsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) =item * Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) =back =head2 DeleteBucketOwnershipControls =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Removes C for an Amazon S3 bucket. To use this operation, you must have the C permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). For information about Amazon S3 Object Ownership, see Using Object Ownership (https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html). The following operations are related to C: =over =item * GetBucketOwnershipControls =item * PutBucketOwnershipControls =back =head2 DeleteBucketPolicy =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing This implementation of the DELETE action uses the policy subresource to delete the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the C permissions on the specified bucket and belong to the bucket owner's account to use this operation. If you don't have C permissions, Amazon S3 returns a C<403 Access Denied> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a C<405 Method Not Allowed> error. As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and UserPolicies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). The following operations are related to C =over =item * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) =item * DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) =back =head2 DeleteBucketReplication =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Deletes the replication configuration from the bucket. To use this operation, you must have permissions to perform the C action. The bucket owner has these permissions by default and can grant it to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). It can take a while for the deletion of a replication configuration to fully propagate. For information about replication configuration, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the I. The following operations are related to C: =over =item * PutBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html) =item * GetBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html) =back =head2 DeleteBucketTagging =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Deletes the tags from the bucket. To use this operation, you must have permission to perform the C action. By default, the bucket owner has this permission and can grant this permission to others. The following operations are related to C: =over =item * GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) =item * PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) =back =head2 DeleteBucketWebsite =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing This action removes the website configuration for a bucket. Amazon S3 returns a C<200 OK> response upon successfully deleting a website configuration on the specified bucket. You will get a C<200 OK> response if the website configuration you are trying to delete does not exist on the bucket. Amazon S3 returns a C<404> response if the bucket specified in the request does not exist. This DELETE action requires the C permission. By default, only the bucket owner can delete the website configuration attached to a bucket. However, bucket owners can grant other users permission to delete the website configuration by writing a bucket policy granting them the C permission. For more information about hosting websites, see Hosting Websites on Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). The following operations are related to C: =over =item * GetBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketWebsite.html) =item * PutBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html) =back =head2 DeleteObject =over =item Bucket => Str =item Key => Str =item [BypassGovernanceRetention => Bool] =item [ExpectedBucketOwner => Str] =item [MFA => Str] =item [RequestPayer => Str] =item [VersionId => Str] =back Each argument is described in detail in: L Returns: a L instance Removes the null version (if there is one) of an object and inserts a delete marker, which becomes the latest version of the object. If there isn't a null version, Amazon S3 does not remove any objects but will still respond that the command was successful. To remove a specific version, you must be the bucket owner and you must use the version Id subresource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, Amazon S3 sets the response header, C, to true. If the object you want to delete is in a bucket where the bucket versioning configuration is MFA Delete enabled, you must include the C request header in the DELETE C request. Requests that include C must use HTTPS. For more information about MFA Delete, see Using MFA Delete (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingMFADelete.html). To see sample requests that use versioning, see Sample Request (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectDELETE.html#ExampleVersionObjectDelete). You can delete objects by explicitly calling DELETE Object or configure its lifecycle (PutBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html)) to enable Amazon S3 to remove them for you. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them the C, C, and C actions. The following action is related to C: =over =item * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) =back =head2 DeleteObjects =over =item Bucket => Str =item Delete => L =item [BypassGovernanceRetention => Bool] =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =item [MFA => Str] =item [RequestPayer => Str] =back Each argument is described in detail in: L Returns: a L instance This action enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this action provides a suitable alternative to sending individual delete requests, reducing per-request overhead. The request contains a list of up to 1000 keys that you want to delete. In the XML, you provide the object key names, and optionally, version IDs if you want to delete a specific version of the object from a versioning-enabled bucket. For each key, Amazon S3 performs a delete action and returns the result of that delete, success, or failure, in the response. Note that if the object specified in the request is not found, Amazon S3 returns the result as deleted. The action supports two modes for the response: verbose and quiet. By default, the action uses verbose mode in which the response includes the result of deletion of each key in your request. In quiet mode the response includes only keys where the delete action encountered an error. For a successful deletion, the action does not return any information about the delete in the response body. When performing this action on an MFA Delete enabled bucket, that attempts to delete any versioned objects, you must include an MFA token. If you do not provide one, the entire request will fail, even if there are non-versioned objects you are trying to delete. If you provide an invalid token, whether there are versioned keys in the request or not, the entire Multi-Object Delete request will fail. For information about MFA Delete, see MFA Delete (https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html#MultiFactorAuthenticationDelete). Finally, the Content-MD5 header is required for all Multi-Object Delete requests. Amazon S3 uses the header value to ensure that your request body has not been altered in transit. The following operations are related to C: =over =item * CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) =item * UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) =item * CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) =item * ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) =item * AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) =back =head2 DeleteObjectTagging =over =item Bucket => Str =item Key => Str =item [ExpectedBucketOwner => Str] =item [VersionId => Str] =back Each argument is described in detail in: L Returns: a L instance Removes the entire tag set from the specified object. For more information about managing object tags, see Object Tagging (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html). To use this operation, you must have permission to perform the C action. To delete tags of a specific object version, add the C query parameter in the request. You will need permission for the C action. The following operations are related to C: =over =item * PutObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html) =item * GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) =back =head2 DeletePublicAccessBlock =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Removes the C configuration for an Amazon S3 bucket. To use this operation, you must have the C permission. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). The following operations are related to C: =over =item * Using Amazon S3 Block Public Access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) =item * GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) =item * PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) =item * GetBucketPolicyStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html) =back =head2 GetBucketAccelerateConfiguration =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance This implementation of the GET action uses the C subresource to return the Transfer Acceleration state of a bucket, which is either C or C. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to and from Amazon S3. To use this operation, you must have permission to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) in the I. You set the Transfer Acceleration state of an existing bucket to C or C by using the PutBucketAccelerateConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html) operation. A GET C request does not return a state value for a bucket that has no transfer acceleration state. A bucket has no Transfer Acceleration state if a state has never been set on the bucket. For more information about transfer acceleration, see Transfer Acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html) in the Amazon S3 User Guide. B =over =item * PutBucketAccelerateConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAccelerateConfiguration.html) =back =head2 GetBucketAcl =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance This implementation of the C action uses the C subresource to return the access control list (ACL) of a bucket. To use C to return the ACL of the bucket, you must have C access to the bucket. If C permission is granted to the anonymous user, you can return the ACL of the bucket without using an authorization header. B =over =item * ListObjects (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) =back =head2 GetBucketAnalyticsConfiguration =over =item Bucket => Str =item Id => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance This implementation of the GET action returns an analytics configuration (identified by the analytics configuration ID) from the bucket. To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) in the I. For information about Amazon S3 analytics feature, see Amazon S3 Analytics E Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html) in the I. B =over =item * DeleteBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) =item * ListBucketAnalyticsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) =item * PutBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) =back =head2 GetBucketCors =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Returns the cors configuration information set for the bucket. To use this operation, you must have permission to perform the s3:GetBucketCORS action. By default, the bucket owner has this permission and can grant it to others. For more information about cors, see Enabling Cross-Origin Resource Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html). The following operations are related to C: =over =item * PutBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketCors.html) =item * DeleteBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html) =back =head2 GetBucketEncryption =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Returns the default encryption configuration for an Amazon S3 bucket. If the bucket does not have a default encryption configuration, GetBucketEncryption returns C. For information about the Amazon S3 default encryption feature, see Amazon S3 Default Bucket Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html). To use this operation, you must have permission to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). The following operations are related to C: =over =item * PutBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketEncryption.html) =item * DeleteBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html) =back =head2 GetBucketIntelligentTieringConfiguration =over =item Bucket => Str =item Id => Str =back Each argument is described in detail in: L Returns: a L instance Gets the S3 Intelligent-Tiering configuration from the specified bucket. The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change. The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class. If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). Operations related to C include: =over =item * DeleteBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html) =item * PutBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html) =item * ListBucketIntelligentTieringConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html) =back =head2 GetBucketInventoryConfiguration =over =item Bucket => Str =item Id => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Returns an inventory configuration (identified by the inventory configuration ID) from the bucket. To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). For information about the Amazon S3 inventory feature, see Amazon S3 Inventory (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html). The following operations are related to C: =over =item * DeleteBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) =item * ListBucketInventoryConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) =item * PutBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) =back =head2 GetBucketLifecycle =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance For an updated version of this API, see GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html). If you configured a bucket lifecycle using the C element, you should see the updated version of this topic. This topic is provided for backward compatibility. Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html). To use this operation, you must have permission to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). C has the following special error: =over =item * Error code: C =over =item * Description: The lifecycle configuration does not exist. =item * HTTP Status Code: 404 Not Found =item * SOAP Fault Code Prefix: Client =back =back The following operations are related to C: =over =item * GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) =item * PutBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html) =item * DeleteBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) =back =head2 GetBucketLifecycleConfiguration =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The response describes the new filter element that you can use to specify a filter to select a subset of objects to which the rule applies. If you are using a previous version of the lifecycle configuration, it still works. For the earlier action, see GetBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html). Returns the lifecycle configuration information set on the bucket. For information about lifecycle configuration, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html). To use this operation, you must have permission to perform the C action. The bucket owner has this permission, by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). C has the following special error: =over =item * Error code: C =over =item * Description: The lifecycle configuration does not exist. =item * HTTP Status Code: 404 Not Found =item * SOAP Fault Code Prefix: Client =back =back The following operations are related to C: =over =item * GetBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html) =item * PutBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html) =item * DeleteBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) =back =head2 GetBucketLocation =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Returns the Region the bucket resides in. You set the bucket's Region using the C request parameter in a C request. For more information, see CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html). To use this implementation of the operation, you must be the bucket owner. The following operations are related to C: =over =item * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) =item * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) =back =head2 GetBucketLogging =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Returns the logging status of a bucket and the permissions users have to view and modify that status. To use GET, you must be the bucket owner. The following operations are related to C: =over =item * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) =item * PutBucketLogging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLogging.html) =back =head2 GetBucketMetricsConfiguration =over =item Bucket => Str =item Id => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Gets a metrics configuration (specified by the metrics configuration ID) from the bucket. Note that this doesn't include the daily storage metrics. To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html). The following operations are related to C: =over =item * PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) =item * DeleteBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) =item * ListBucketMetricsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) =item * Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html) =back =head2 GetBucketNotification =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance No longer used, see GetBucketNotificationConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html). =head2 GetBucketNotificationConfiguration =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Returns the notification configuration of a bucket. If notifications are not enabled on the bucket, the action returns an empty C element. By default, you must be the bucket owner to read the notification configuration of a bucket. However, the bucket owner can use a bucket policy to grant permission to other users to read this configuration with the C permission. For more information about setting and reading the notification configuration on a bucket, see Setting Up Notification of Bucket Events (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). For more information about bucket policies, see Using Bucket Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). The following action is related to C: =over =item * PutBucketNotification (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotification.html) =back =head2 GetBucketOwnershipControls =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Retrieves C for an Amazon S3 bucket. To use this operation, you must have the C permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). For information about Amazon S3 Object Ownership, see Using Object Ownership (https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html). The following operations are related to C: =over =item * PutBucketOwnershipControls =item * DeleteBucketOwnershipControls =back =head2 GetBucketPolicy =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Returns the policy of a specified bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the C permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. If you don't have C permissions, Amazon S3 returns a C<403 Access Denied> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a C<405 Method Not Allowed> error. As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). The following action is related to C: =over =item * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) =back =head2 GetBucketPolicyStatus =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Retrieves the policy status for an Amazon S3 bucket, indicating whether the bucket is public. In order to use this operation, you must have the C permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). For more information about when Amazon S3 considers a bucket public, see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status). The following operations are related to C: =over =item * Using Amazon S3 Block Public Access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) =item * GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) =item * PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) =item * DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) =back =head2 GetBucketReplication =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Returns the replication configuration of a bucket. It can take a while to propagate the put or delete a replication configuration to all Amazon S3 systems. Therefore, a get request soon after put or delete can return a wrong result. For information about replication configuration, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the I. This action requires permissions for the C action. For more information about permissions, see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). If you include the C element in a replication configuration, you must also include the C and C elements. The response also returns those elements. For information about C errors, see List of replication-related error codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList) The following operations are related to C: =over =item * PutBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketReplication.html) =item * DeleteBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html) =back =head2 GetBucketRequestPayment =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Returns the request payment configuration of a bucket. To use this version of the operation, you must be the bucket owner. For more information, see Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html). The following operations are related to C: =over =item * ListObjects (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html) =back =head2 GetBucketTagging =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Returns the tag set associated with the bucket. To use this operation, you must have permission to perform the C action. By default, the bucket owner has this permission and can grant this permission to others. C has the following special error: =over =item * Error code: C =over =item * Description: There is no tag set associated with the bucket. =back =back The following operations are related to C: =over =item * PutBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketTagging.html) =item * DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) =back =head2 GetBucketVersioning =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Returns the versioning state of a bucket. To retrieve the versioning state of a bucket, you must be the bucket owner. This implementation also returns the MFA Delete status of the versioning state. If the MFA Delete status is C, the bucket owner must use an authentication device to change the versioning state of the bucket. The following operations are related to C: =over =item * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) =item * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) =item * DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) =back =head2 GetBucketWebsite =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Returns the website configuration for a bucket. To host website on Amazon S3, you can configure a bucket as website by adding a website configuration. For more information about hosting websites, see Hosting Websites on Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). This GET action requires the C permission. By default, only the bucket owner can read the bucket website configuration. However, bucket owners can allow other users to read the website configuration by writing a bucket policy granting them the C permission. The following operations are related to C: =over =item * DeleteBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketWebsite.html) =item * PutBucketWebsite (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketWebsite.html) =back =head2 GetObject =over =item Bucket => Str =item Key => Str =item [ExpectedBucketOwner => Str] =item [IfMatch => Str] =item [IfModifiedSince => Str] =item [IfNoneMatch => Str] =item [IfUnmodifiedSince => Str] =item [PartNumber => Int] =item [Range => Str] =item [RequestPayer => Str] =item [ResponseCacheControl => Str] =item [ResponseContentDisposition => Str] =item [ResponseContentEncoding => Str] =item [ResponseContentLanguage => Str] =item [ResponseContentType => Str] =item [ResponseExpires => Str] =item [SSECustomerAlgorithm => Str] =item [SSECustomerKey => Str] =item [SSECustomerKeyMD5 => Str] =item [VersionId => Str] =back Each argument is described in detail in: L Returns: a L instance Retrieves objects from Amazon S3. To use C, you must have C access to the object. If you grant C access to the anonymous user, you can return the object without using an authorization header. An Amazon S3 bucket has no directory hierarchy such as you would find in a typical computer file system. You can, however, create a logical hierarchy by using object key names that imply a folder structure. For example, instead of naming an object C, you can name it C. To get an object from such a logical hierarchy, specify the full key name for the object in the C operation. For a virtual hosted-style request example, if you have the object C, specify the resource as C. For a path-style request example, if you have the object C in the bucket named C, specify the resource as C. For more information about request types, see HTTP Host Header Bucket Specification (https://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingSpecifyBucket). To distribute large files to many people, you can save bandwidth costs by using BitTorrent. For more information, see Amazon S3 Torrent (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html). For more information about returning the ACL of an object, see GetObjectAcl (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html). If the object you are retrieving is stored in the S3 Glacier or S3 Glacier Deep Archive storage class, or S3 Intelligent-Tiering Archive or S3 Intelligent-Tiering Deep Archive tiers, before you can retrieve the object you must first restore a copy using RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html). Otherwise, this action returns an C error. For information about restoring archived objects, see Restoring Archived Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/restoring-objects.html). Encryption request headers, like C, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3Emanaged encryption keys (SSE-S3). If your object does use these types of keys, youEll get an HTTP 400 BadRequest error. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you GET the object, you must use the following headers: =over =item * x-amz-server-side-encryption-customer-algorithm =item * x-amz-server-side-encryption-customer-key =item * x-amz-server-side-encryption-customer-key-MD5 =back For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html). Assuming you have permission to read object tags (permission for the C action), the response also returns the C header that provides the count of number of tags associated with the object. You can use GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) to retrieve the tag set associated with an object. B You need the C permission for this operation. For more information, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the C permission. =over =item * If you have the C permission on the bucket, Amazon S3 will return an HTTP status code 404 ("no such key") error. =item * If you donEt have the C permission, Amazon S3 will return an HTTP status code 403 ("access denied") error. =back B By default, the GET action returns the current version of an object. To return a different version, use the C subresource. If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes C in the response. For more information about versioning, see PutBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketVersioning.html). B There are times when you want to override certain response header values in a GET response. For example, you might override the Content-Disposition response header value in your GET request. You can override values for a set of response headers using the following query parameters. These response header values are sent only on a successful request, that is, when status code 200 OK is returned. The set of headers you can override using these parameters is a subset of the headers that Amazon S3 accepts when you create an object. The response headers that you can override for the GET response are C, C, C, C, C, and C. To override these header values in the GET response, you use the following request parameters. You must sign the request, either using an Authorization header or a presigned URL, when using these parameters. They cannot be used with an unsigned (anonymous) request. =over =item * C =item * C =item * C =item * C =item * C =item * C =back B If both of the C and C headers are present in the request as follows: C condition evaluates to C, and; C condition evaluates to C; then, S3 returns 200 OK and the data requested. If both of the C and C headers are present in the request as follows:C< If-None-Match> condition evaluates to C, and; C condition evaluates to C; then, S3 returns 304 Not Modified response code. For more information about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232). The following operations are related to C: =over =item * ListBuckets (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) =item * GetObjectAcl (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html) =back =head2 GetObjectAcl =over =item Bucket => Str =item Key => Str =item [ExpectedBucketOwner => Str] =item [RequestPayer => Str] =item [VersionId => Str] =back Each argument is described in detail in: L Returns: a L instance Returns the access control list (ACL) of an object. To use this operation, you must have C access to the object. This action is not supported by Amazon S3 on Outposts. B By default, GET returns ACL information about the current version of an object. To return ACL information about a different version, use the versionId subresource. The following operations are related to C: =over =item * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) =item * DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) =item * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) =back =head2 GetObjectLegalHold =over =item Bucket => Str =item Key => Str =item [ExpectedBucketOwner => Str] =item [RequestPayer => Str] =item [VersionId => Str] =back Each argument is described in detail in: L Returns: a L instance Gets an object's current Legal Hold status. For more information, see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). This action is not supported by Amazon S3 on Outposts. =head2 GetObjectLockConfiguration =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Gets the Object Lock configuration for a bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). =head2 GetObjectRetention =over =item Bucket => Str =item Key => Str =item [ExpectedBucketOwner => Str] =item [RequestPayer => Str] =item [VersionId => Str] =back Each argument is described in detail in: L Returns: a L instance Retrieves an object's retention settings. For more information, see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). This action is not supported by Amazon S3 on Outposts. =head2 GetObjectTagging =over =item Bucket => Str =item Key => Str =item [ExpectedBucketOwner => Str] =item [RequestPayer => Str] =item [VersionId => Str] =back Each argument is described in detail in: L Returns: a L instance Returns the tag-set of an object. You send the GET request against the tagging subresource associated with the object. To use this operation, you must have permission to perform the C action. By default, the GET action returns information about current version of an object. For a versioned bucket, you can have multiple versions of an object in your bucket. To retrieve tags of any other version, use the versionId query parameter. You also need permission for the C action. By default, the bucket owner has this permission and can grant this permission to others. For information about the Amazon S3 object tagging feature, see Object Tagging (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html). The following action is related to C: =over =item * PutObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectTagging.html) =item * DeleteObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html) =back =head2 GetObjectTorrent =over =item Bucket => Str =item Key => Str =item [ExpectedBucketOwner => Str] =item [RequestPayer => Str] =back Each argument is described in detail in: L Returns: a L instance Returns torrent files from a bucket. BitTorrent can save you bandwidth when you're distributing large files. For more information about BitTorrent, see Using BitTorrent with Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3Torrent.html). You can get torrent only for objects that are less than 5 GB in size, and that are not encrypted using server-side encryption with a customer-provided encryption key. To use GET, you must have READ access to the object. This action is not supported by Amazon S3 on Outposts. The following action is related to C: =over =item * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) =back =head2 GetPublicAccessBlock =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Retrieves the C configuration for an Amazon S3 bucket. To use this operation, you must have the C permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). When Amazon S3 evaluates the C configuration for a bucket or an object, it checks the C configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the C settings are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings. For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status). The following operations are related to C: =over =item * Using Amazon S3 Block Public Access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) =item * PutPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutPublicAccessBlock.html) =item * GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) =item * DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) =back =head2 HeadBucket =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing This action is useful to determine if a bucket exists and you have permission to access it. The action returns a C<200 OK> if the bucket exists and you have permission to access it. If the bucket does not exist or you do not have permission to access it, the C request returns a generic C<404 Not Found> or C<403 Forbidden> code. A message body is not included, so you cannot determine the exception beyond these error codes. To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). =head2 HeadObject =over =item Bucket => Str =item Key => Str =item [ExpectedBucketOwner => Str] =item [IfMatch => Str] =item [IfModifiedSince => Str] =item [IfNoneMatch => Str] =item [IfUnmodifiedSince => Str] =item [PartNumber => Int] =item [Range => Str] =item [RequestPayer => Str] =item [SSECustomerAlgorithm => Str] =item [SSECustomerKey => Str] =item [SSECustomerKeyMD5 => Str] =item [VersionId => Str] =back Each argument is described in detail in: L Returns: a L instance The HEAD action retrieves metadata from an object without returning the object itself. This action is useful if you're only interested in an object's metadata. To use HEAD, you must have READ access to the object. A C request has the same options as a C action on an object. The response is identical to the C response except that there is no response body. Because of this, if the C request generates an error, it returns a generic C<404 Not Found> or C<403 Forbidden> code. It is not possible to retrieve the exact exception beyond these error codes. If you encrypt an object by using server-side encryption with customer-provided encryption keys (SSE-C) when you store the object in Amazon S3, then when you retrieve the metadata from the object, you must use the following headers: =over =item * x-amz-server-side-encryption-customer-algorithm =item * x-amz-server-side-encryption-customer-key =item * x-amz-server-side-encryption-customer-key-MD5 =back For more information about SSE-C, see Server-Side Encryption (Using Customer-Provided Encryption Keys) (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerSideEncryptionCustomerKeys.html). =over =item * Encryption request headers, like C, should not be sent for GET requests if your object uses server-side encryption with CMKs stored in AWS KMS (SSE-KMS) or server-side encryption with Amazon S3Emanaged encryption keys (SSE-S3). If your object does use these types of keys, youEll get an HTTP 400 BadRequest error. =item * The last modified property in this case is the creation date of the object. =back Request headers are limited to 8 KB in size. For more information, see Common Request Headers (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html). Consider the following when using request headers: =over =item * Consideration 1 E If both of the C and C headers are present in the request as follows: =over =item * C condition evaluates to C, and; =item * C condition evaluates to C; =back Then Amazon S3 returns C<200 OK> and the data requested. =item * Consideration 2 E If both of the C and C headers are present in the request as follows: =over =item * C condition evaluates to C, and; =item * C condition evaluates to C; =back Then Amazon S3 returns the C<304 Not Modified> response code. =back For more information about conditional requests, see RFC 7232 (https://tools.ietf.org/html/rfc7232). B You need the C permission for this operation. For more information, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). If the object you request does not exist, the error Amazon S3 returns depends on whether you also have the s3:ListBucket permission. =over =item * If you have the C permission on the bucket, Amazon S3 returns an HTTP status code 404 ("no such key") error. =item * If you donEt have the C permission, Amazon S3 returns an HTTP status code 403 ("access denied") error. =back The following action is related to C: =over =item * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) =back =head2 ListBucketAnalyticsConfigurations =over =item Bucket => Str =item [ContinuationToken => Str] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Lists the analytics configurations for the bucket. You can have up to 1,000 analytics configurations per bucket. This action supports list pagination and does not return more than 100 configurations at a time. You should always check the C element in the response. If there are no more configurations to list, C is set to false. If there are more configurations to list, C is set to true, and there will be a value in C. You use the C value to continue the pagination of the list by passing the value in continuation-token in the request to C the next page. To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). For information about Amazon S3 analytics feature, see Amazon S3 Analytics E Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html). The following operations are related to C: =over =item * GetBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) =item * DeleteBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) =item * PutBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketAnalyticsConfiguration.html) =back =head2 ListBucketIntelligentTieringConfigurations =over =item Bucket => Str =item [ContinuationToken => Str] =back Each argument is described in detail in: L Returns: a L instance Lists the S3 Intelligent-Tiering configuration from the specified bucket. The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change. The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class. If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). Operations related to C include: =over =item * DeleteBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html) =item * PutBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketIntelligentTieringConfiguration.html) =item * GetBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html) =back =head2 ListBucketInventoryConfigurations =over =item Bucket => Str =item [ContinuationToken => Str] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Returns a list of inventory configurations for the bucket. You can have up to 1,000 analytics configurations per bucket. This action supports list pagination and does not return more than 100 configurations at a time. Always check the C element in the response. If there are no more configurations to list, C is set to false. If there are more configurations to list, C is set to true, and there is a value in C. You use the C value to continue the pagination of the list by passing the value in continuation-token in the request to C the next page. To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). For information about the Amazon S3 inventory feature, see Amazon S3 Inventory (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html) The following operations are related to C: =over =item * GetBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) =item * DeleteBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) =item * PutBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketInventoryConfiguration.html) =back =head2 ListBucketMetricsConfigurations =over =item Bucket => Str =item [ContinuationToken => Str] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: a L instance Lists the metrics configurations for the bucket. The metrics configurations are only for the request metrics of the bucket and do not provide information on daily storage metrics. You can have up to 1,000 configurations per bucket. This action supports list pagination and does not return more than 100 configurations at a time. Always check the C element in the response. If there are no more configurations to list, C is set to false. If there are more configurations to list, C is set to true, and there is a value in C. You use the C value to continue the pagination of the list by passing the value in C in the request to C the next page. To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). For more information about metrics configurations and CloudWatch request metrics, see Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html). The following operations are related to C: =over =item * PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) =item * GetBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketMetricsConfiguration.html) =item * DeleteBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) =back =head2 ListBuckets =over =item => =back Each argument is described in detail in: L Returns: a L instance Returns a list of all buckets owned by the authenticated sender of the request. =head2 ListMultipartUploads =over =item Bucket => Str =item [Delimiter => Str] =item [EncodingType => Str] =item [ExpectedBucketOwner => Str] =item [KeyMarker => Str] =item [MaxUploads => Int] =item [Prefix => Str] =item [UploadIdMarker => Str] =back Each argument is described in detail in: L Returns: a L instance This action lists in-progress multipart uploads. An in-progress multipart upload is a multipart upload that has been initiated using the Initiate Multipart Upload request, but has not yet been completed or aborted. This action returns at most 1,000 multipart uploads in the response. 1,000 multipart uploads is the maximum number of uploads a response can include, which is also the default value. You can further limit the number of uploads in a response by specifying the C parameter in the response. If additional multipart uploads satisfy the list criteria, the response will contain an C element with the value true. To list the additional multipart uploads, use the C and C request parameters. In the response, the uploads are sorted by key. If your application has initiated more than one multipart upload using the same object key, then uploads in the response are first sorted by key. Additionally, uploads are sorted in ascending order within each key by the upload initiation time. For more information on multipart uploads, see Uploading Objects Using Multipart Upload (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html). For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). The following operations are related to C: =over =item * CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) =item * UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) =item * CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) =item * ListParts (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html) =item * AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) =back =head2 ListObjects =over =item Bucket => Str =item [Delimiter => Str] =item [EncodingType => Str] =item [ExpectedBucketOwner => Str] =item [Marker => Str] =item [MaxKeys => Int] =item [Prefix => Str] =item [RequestPayer => Str] =back Each argument is described in detail in: L Returns: a L instance Returns some or all (up to 1,000) of the objects in a bucket. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Be sure to design your application to parse the contents of the response and handle it appropriately. This action has been revised. We recommend that you use the newer version, ListObjectsV2 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html), when developing applications. For backward compatibility, Amazon S3 continues to support C. The following operations are related to C: =over =item * ListObjectsV2 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) =item * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) =item * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) =item * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) =item * ListBuckets (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html) =back =head2 ListObjectsV2 =over =item Bucket => Str =item [ContinuationToken => Str] =item [Delimiter => Str] =item [EncodingType => Str] =item [ExpectedBucketOwner => Str] =item [FetchOwner => Bool] =item [MaxKeys => Int] =item [Prefix => Str] =item [RequestPayer => Str] =item [StartAfter => Str] =back Each argument is described in detail in: L Returns: a L instance Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A C<200 OK> response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. Objects are returned sorted in an ascending order of the respective key names in the list. For more information about listing objects, see Listing object keys programmatically (https://docs.aws.amazon.com/AmazonS3/latest/userguide/ListingKeysUsingAPIs.html) To use this operation, you must have READ access to the bucket. To use this action in an AWS Identity and Access Management (IAM) policy, you must have permissions to perform the C action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). This section describes the latest revision of this action. We recommend that you use this revised API for application development. For backward compatibility, Amazon S3 continues to support the prior version of this API, ListObjects (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html). To get a list of your buckets, see ListBuckets (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBuckets.html). The following operations are related to C: =over =item * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) =item * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) =item * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) =back =head2 ListObjectVersions =over =item Bucket => Str =item [Delimiter => Str] =item [EncodingType => Str] =item [ExpectedBucketOwner => Str] =item [KeyMarker => Str] =item [MaxKeys => Int] =item [Prefix => Str] =item [VersionIdMarker => Str] =back Each argument is described in detail in: L Returns: a L instance Returns metadata about all versions of the objects in a bucket. You can also use request parameters as selection criteria to return metadata about a subset of all the object versions. To use this operation, you must have permissions to perform the C action. Be aware of the name difference. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately. To use this operation, you must have READ access to the bucket. This action is not supported by Amazon S3 on Outposts. The following operations are related to C: =over =item * ListObjectsV2 (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html) =item * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) =item * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) =item * DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) =back =head2 ListParts =over =item Bucket => Str =item Key => Str =item UploadId => Str =item [ExpectedBucketOwner => Str] =item [MaxParts => Int] =item [PartNumberMarker => Int] =item [RequestPayer => Str] =back Each argument is described in detail in: L Returns: a L instance Lists the parts that have been uploaded for a specific multipart upload. This operation must include the upload ID, which you obtain by sending the initiate multipart upload request (see CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html)). This request returns a maximum of 1,000 uploaded parts. The default number of parts returned is 1,000 parts. You can restrict the number of parts returned by specifying the C request parameter. If your multipart upload consists of more than 1,000 parts, the response returns an C field with the value of true, and a C element. In subsequent C requests you can include the part-number-marker query string parameter and set its value to the C field value from the previous response. For more information on multipart uploads, see Uploading Objects Using Multipart Upload (https://docs.aws.amazon.com/AmazonS3/latest/dev/uploadobjusingmpu.html). For information on permissions required to use the multipart upload API, see Multipart Upload and Permissions (https://docs.aws.amazon.com/AmazonS3/latest/dev/mpuAndPermissions.html). The following operations are related to C: =over =item * CreateMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html) =item * UploadPart (https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html) =item * CompleteMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html) =item * AbortMultipartUpload (https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html) =item * ListMultipartUploads (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListMultipartUploads.html) =back =head2 PutBucketAccelerateConfiguration =over =item AccelerateConfiguration => L =item Bucket => Str =item [ContentLength => Int] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Sets the accelerate configuration of an existing bucket. Amazon S3 Transfer Acceleration is a bucket-level feature that enables you to perform faster data transfers to Amazon S3. To use this operation, you must have permission to perform the s3:PutAccelerateConfiguration action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). The Transfer Acceleration state of a bucket can be set to one of the following two values: =over =item * Enabled E Enables accelerated data transfers to the bucket. =item * Suspended E Disables accelerated data transfers to the bucket. =back The GetBucketAccelerateConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html) action returns the transfer acceleration state of a bucket. After setting the Transfer Acceleration state of a bucket to Enabled, it might take up to thirty minutes before the data transfer rates to the bucket increase. The name of the bucket used for Transfer Acceleration must be DNS-compliant and must not contain periods ("."). For more information about transfer acceleration, see Transfer Acceleration (https://docs.aws.amazon.com/AmazonS3/latest/dev/transfer-acceleration.html). The following operations are related to C: =over =item * GetBucketAccelerateConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAccelerateConfiguration.html) =item * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) =back =head2 PutBucketAcl =over =item Bucket => Str =item [AccessControlPolicy => L] =item [ACL => Str] =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =item [GrantFullControl => Str] =item [GrantRead => Str] =item [GrantReadACP => Str] =item [GrantWrite => Str] =item [GrantWriteACP => Str] =back Each argument is described in detail in: L Returns: nothing Sets the permissions on an existing bucket using access control lists (ACL). For more information, see Using ACLs (https://docs.aws.amazon.com/AmazonS3/latest/dev/S3_ACLs_UsingACLs.html). To set the ACL of a bucket, you must have C permission. You can use one of the following two ways to set a bucket's permissions: =over =item * Specify the ACL in the request body =item * Specify permissions using request headers =back You cannot specify access permission using both the body and the request headers. Depending on your application needs, you may choose to set the ACL on a bucket using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, then you can continue to use that approach. B You can set access permissions using one of the following methods: =over =item * Specify a canned ACL with the C request header. Amazon S3 supports a set of predefined ACLs, known as I. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of C. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). =item * Specify access permissions explicitly with the C, C, C, and C headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use the C header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). You specify each grantee as a type=value pair, where the type is one of the following: =over =item * C E if the value specified is the canonical user ID of an AWS account =item * C E if you are granting permissions to a predefined group =item * C E if the value specified is the email address of an AWS account Using email addresses to specify a grantee is only supported in the following AWS Regions: =over =item * US East (N. Virginia) =item * US West (N. California) =item * US West (Oregon) =item * Asia Pacific (Singapore) =item * Asia Pacific (Sydney) =item * Asia Pacific (Tokyo) =item * Europe (Ireland) =item * South America (SEo Paulo) =back For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the AWS General Reference. =back For example, the following C header grants create, overwrite, and delete objects permission to LogDelivery group predefined by Amazon S3 and two AWS accounts identified by their email addresses. C =back You can use either a canned ACL or specify access permissions explicitly. You cannot do both. B You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways: =over =item * By the person's ID: CGrantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"EEIDEEEIDEEE/IDEEDisplayNameEEEGranteesEmailEEE/DisplayNameE E/GranteeE> DisplayName is optional and ignored in the request =item * By URI: CGrantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"EEURIEEEhttp://acs.amazonaws.com/groups/global/AuthenticatedUsersEEE/URIEE/GranteeE> =item * By Email address: CGrantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"EEEmailAddressEEEGrantees@email.comEEE/EmailAddressElt;/GranteeE> The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. Using email addresses to specify a grantee is only supported in the following AWS Regions: =over =item * US East (N. Virginia) =item * US West (N. California) =item * US West (Oregon) =item * Asia Pacific (Singapore) =item * Asia Pacific (Sydney) =item * Asia Pacific (Tokyo) =item * Europe (Ireland) =item * South America (SEo Paulo) =back For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the AWS General Reference. =back B =over =item * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) =item * DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) =item * GetObjectAcl (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectAcl.html) =back =head2 PutBucketAnalyticsConfiguration =over =item AnalyticsConfiguration => L =item Bucket => Str =item Id => Str =item [ContentLength => Int] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Sets an analytics configuration for the bucket (specified by the analytics configuration ID). You can have up to 1,000 analytics configurations per bucket. You can choose to have storage class analysis export analysis reports sent to a comma-separated values (CSV) flat file. See the C request element. Reports are updated daily and are based on the object filters that you configure. When selecting data export, you specify a destination bucket and an optional destination prefix where the file is written. You can export the data to a destination bucket in a different account. However, the destination bucket must be in the same Region as the bucket that you are making the PUT analytics configuration to. For more information, see Amazon S3 Analytics E Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/analytics-storage-class.html). You must create a bucket policy on the destination bucket where the exported file is written to grant permissions to Amazon S3 to write objects to the bucket. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9). To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). B =over =item * =over =item * I =item * I =item * I =back =item * =over =item * I =item * I =item * I =back =item * =over =item * I =item * I =item * I =back =back B =over =item * GetBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketAnalyticsConfiguration.html) =item * DeleteBucketAnalyticsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketAnalyticsConfiguration.html) =item * ListBucketAnalyticsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketAnalyticsConfigurations.html) =back =head2 PutBucketCors =over =item Bucket => Str =item CORSConfiguration => L =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Sets the C configuration for your bucket. If the configuration exists, Amazon S3 replaces it. To use this operation, you must be allowed to perform the C action. By default, the bucket owner has this permission and can grant it to others. You set this configuration on a bucket so that the bucket can service cross-origin requests. For example, you might want to enable a request whose origin is C to access your Amazon S3 bucket at C by using the browser's C capability. To enable cross-origin resource sharing (CORS) on a bucket, you add the C subresource to the bucket. The C subresource is an XML document in which you configure rules that identify origins and the HTTP methods that can be executed on your bucket. The document is limited to 64 KB in size. When Amazon S3 receives a cross-origin request (or a pre-flight OPTIONS request) against a bucket, it evaluates the C configuration on the bucket and uses the first C rule that matches the incoming browser request to enable a cross-origin request. For a rule to match, the following conditions must be met: =over =item * The request's C header must match C elements. =item * The request method (for example, GET, PUT, HEAD, and so on) or the C header in case of a pre-flight C request must be one of the C elements. =item * Every header specified in the C request header of a pre-flight request must match an C element. =back For more information about CORS, go to Enabling Cross-Origin Resource Sharing (https://docs.aws.amazon.com/AmazonS3/latest/dev/cors.html) in the I. B =over =item * GetBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketCors.html) =item * DeleteBucketCors (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketCors.html) =item * RESTOPTIONSobject (https://docs.aws.amazon.com/AmazonS3/latest/API/RESTOPTIONSobject.html) =back =head2 PutBucketEncryption =over =item Bucket => Str =item ServerSideEncryptionConfiguration => L =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing This action uses the C subresource to configure default encryption and Amazon S3 Bucket Key for an existing bucket. Default encryption for a bucket can use server-side encryption with Amazon S3-managed keys (SSE-S3) or AWS KMS customer master keys (SSE-KMS). If you specify default encryption using SSE-KMS, you can also configure Amazon S3 Bucket Key. For information about default encryption, see Amazon S3 default bucket encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-encryption.html) in the I. For more information about S3 Bucket Keys, see Amazon S3 Bucket Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the I. This action requires AWS Signature Version 4. For more information, see Authenticating Requests (AWS Signature Version 4) (https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html). To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) in the Amazon S3 User Guide. B =over =item * GetBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketEncryption.html) =item * DeleteBucketEncryption (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketEncryption.html) =back =head2 PutBucketIntelligentTieringConfiguration =over =item Bucket => Str =item Id => Str =item IntelligentTieringConfiguration => L =back Each argument is described in detail in: L Returns: nothing Puts a S3 Intelligent-Tiering configuration to the specified bucket. You can have up to 1,000 S3 Intelligent-Tiering configurations per bucket. The S3 Intelligent-Tiering storage class is designed to optimize storage costs by automatically moving data to the most cost-effective storage access tier, without additional operational overhead. S3 Intelligent-Tiering delivers automatic cost savings by moving data between access tiers, when access patterns change. The S3 Intelligent-Tiering storage class is suitable for objects larger than 128 KB that you plan to store for at least 30 days. If the size of an object is less than 128 KB, it is not eligible for auto-tiering. Smaller objects can be stored, but they are always charged at the frequent access tier rates in the S3 Intelligent-Tiering storage class. If you delete an object before the end of the 30-day minimum storage duration period, you are charged for 30 days. For more information, see Storage class for automatically optimizing frequently and infrequently accessed objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html#sc-dynamic-data-access). Operations related to C include: =over =item * DeleteBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketIntelligentTieringConfiguration.html) =item * GetBucketIntelligentTieringConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketIntelligentTieringConfiguration.html) =item * ListBucketIntelligentTieringConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketIntelligentTieringConfigurations.html) =back You only need S3 Intelligent-Tiering enabled on a bucket if you want to automatically move objects stored in the S3 Intelligent-Tiering storage class to the Archive Access or Deep Archive Access tier. B =over =item * B =over =item * I InvalidArgument =item * I Invalid Argument =back =item * B =over =item * I TooManyConfigurations =item * I You are attempting to create a new configuration but have already reached the 1,000-configuration limit. =back =item * B =over =item * I AccessDenied =item * I You are not the owner of the specified bucket, or you do not have the C bucket permission to set the configuration on the bucket. =back =back =head2 PutBucketInventoryConfiguration =over =item Bucket => Str =item Id => Str =item InventoryConfiguration => L =item [ContentLength => Int] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing This implementation of the C action adds an inventory configuration (identified by the inventory ID) to the bucket. You can have up to 1,000 inventory configurations per bucket. Amazon S3 inventory generates inventories of the objects in the bucket on a daily or weekly basis, and the results are published to a flat file. The bucket that is inventoried is called the I bucket, and the bucket where the inventory flat file is stored is called the I bucket. The I bucket must be in the same AWS Region as the I bucket. When you configure an inventory for a I bucket, you specify the I bucket where you want the inventory to be stored, and whether to generate the inventory daily or weekly. You can also configure what object metadata to include and whether to inventory all object versions or only current versions. For more information, see Amazon S3 Inventory (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-inventory.html) in the Amazon S3 User Guide. You must create a bucket policy on the I bucket to grant permissions to Amazon S3 to write objects to the bucket in the defined location. For an example policy, see Granting Permissions for Amazon S3 Inventory and Storage Class Analysis (https://docs.aws.amazon.com/AmazonS3/latest/dev/example-bucket-policies.html#example-bucket-policies-use-case-9). To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) in the Amazon S3 User Guide. B =over =item * B =over =item * I InvalidArgument =item * I Invalid Argument =back =item * B =over =item * I TooManyConfigurations =item * I You are attempting to create a new configuration but have already reached the 1,000-configuration limit. =back =item * B =over =item * I AccessDenied =item * I You are not the owner of the specified bucket, or you do not have the C bucket permission to set the configuration on the bucket. =back =back B =over =item * GetBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html) =item * DeleteBucketInventoryConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketInventoryConfiguration.html) =item * ListBucketInventoryConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketInventoryConfigurations.html) =back =head2 PutBucketLifecycle =over =item Bucket => Str =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =item [LifecycleConfiguration => L] =back Each argument is described in detail in: L Returns: nothing For an updated version of this API, see PutBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html). This version has been deprecated. Existing lifecycle configurations will work. For new lifecycle configurations, use the updated API. Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) in the I. By default, all Amazon S3 resources, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration) are private. Only the resource owner, the AWS account that created the resource, can access it. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, users must get the C permission. You can also explicitly deny permissions. Explicit denial also supersedes any other permissions. If you want to prevent users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: =over =item * C =item * C =item * C =back For more information about permissions, see Managing Access Permissions to your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) in the I. For more examples of transitioning objects to storage classes such as STANDARD_IA or ONEZONE_IA, see Examples of Lifecycle Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html#lifecycle-configuration-examples). B =over =item * GetBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycle.html)(Deprecated) =item * GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) =item * RestoreObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html) =item * By default, a resource ownerEin this case, a bucket owner, which is the AWS account that created the bucketEcan perform any of the operations. A resource owner can also grant others permission to perform the operation. For more information, see the following topics in the Amazon S3 User Guide: =over =item * Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) =item * Managing Access Permissions to your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html) =back =back =head2 PutBucketLifecycleConfiguration =over =item Bucket => Str =item [ExpectedBucketOwner => Str] =item [LifecycleConfiguration => L] =back Each argument is described in detail in: L Returns: nothing Creates a new lifecycle configuration for the bucket or replaces an existing lifecycle configuration. For information about lifecycle configuration, see Managing your storage lifecycle (https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-lifecycle-mgmt.html). Bucket lifecycle configuration now supports specifying a lifecycle rule using an object key name prefix, one or more object tags, or a combination of both. Accordingly, this section describes the latest API. The previous version of the API supported filtering based only on an object key name prefix, which is supported for backward compatibility. For the related API description, see PutBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycle.html). B You specify the lifecycle configuration in your request body. The lifecycle configuration is specified as XML consisting of one or more rules. Each rule consists of the following: =over =item * Filter identifying a subset of objects to which the rule applies. The filter can be based on a key name prefix, object tags, or a combination of both. =item * Status whether the rule is in effect. =item * One or more lifecycle transition and expiration actions that you want Amazon S3 to perform on the objects identified by the filter. If the state of your bucket is versioning-enabled or versioning-suspended, you can have many versions of the same object (one current version and zero or more noncurrent versions). Amazon S3 provides predefined actions that you can specify for current and noncurrent object versions. =back For more information, see Object Lifecycle Management (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html) and Lifecycle Configuration Elements (https://docs.aws.amazon.com/AmazonS3/latest/dev/intro-lifecycle-rules.html). B By default, all Amazon S3 resources are private, including buckets, objects, and related subresources (for example, lifecycle configuration and website configuration). Only the resource owner (that is, the AWS account that created it) can access the resource. The resource owner can optionally grant access permissions to others by writing an access policy. For this operation, a user must get the s3:PutLifecycleConfiguration permission. You can also explicitly deny permissions. Explicit deny also supersedes any other permissions. If you want to block users or accounts from removing or deleting objects from your bucket, you must deny them permissions for the following actions: =over =item * s3:DeleteObject =item * s3:DeleteObjectVersion =item * s3:PutLifecycleConfiguration =back For more information about permissions, see Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). The following are related to C: =over =item * Examples of Lifecycle Configuration (https://docs.aws.amazon.com/AmazonS3/latest/dev/lifecycle-configuration-examples.html) =item * GetBucketLifecycleConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLifecycleConfiguration.html) =item * DeleteBucketLifecycle (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketLifecycle.html) =back =head2 PutBucketLogging =over =item Bucket => Str =item BucketLoggingStatus => L =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Set the logging parameters for a bucket and to specify permissions for who can view and modify the logging parameters. All logs are saved to buckets in the same AWS Region as the source bucket. To set the logging status of a bucket, you must be the bucket owner. The bucket owner is automatically granted FULL_CONTROL to all logs. You use the C request element to grant access to other people. The C request element specifies the kind of access the grantee has to the logs. B You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways: =over =item * By the person's ID: CGrantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"EEIDEEEIDEEE/IDEEDisplayNameEEEGranteesEmailEEE/DisplayNameE E/GranteeE> DisplayName is optional and ignored in the request. =item * By Email address: CGrantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"EEEmailAddressEEEGrantees@email.comEEE/EmailAddressEE/GranteeE> The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. =item * By URI: CGrantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"EEURIEEEhttp://acs.amazonaws.com/groups/global/AuthenticatedUsersEEE/URIEE/GranteeE> =back To enable logging, you use LoggingEnabled and its children request elements. To disable logging, you use an empty BucketLoggingStatus request element: CBucketLoggingStatus xmlns="http://doc.s3.amazonaws.com/2006-03-01" /E> For more information about server access logging, see Server Access Logging (https://docs.aws.amazon.com/AmazonS3/latest/dev/ServerLogs.html). For more information about creating a bucket, see CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html). For more information about returning the logging status of a bucket, see GetBucketLogging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html). The following operations are related to C: =over =item * PutObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html) =item * DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) =item * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) =item * GetBucketLogging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketLogging.html) =back =head2 PutBucketMetricsConfiguration =over =item Bucket => Str =item Id => Str =item MetricsConfiguration => L =item [ContentLength => Int] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Sets a metrics configuration (specified by the metrics configuration ID) for the bucket. You can have up to 1,000 metrics configurations per bucket. If you're updating an existing metrics configuration, note that this is a full replacement of the existing metrics configuration. If you don't include the elements you want to keep, they are erased. To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default. The bucket owner can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). For information about CloudWatch request metrics for Amazon S3, see Monitoring Metrics with Amazon CloudWatch (https://docs.aws.amazon.com/AmazonS3/latest/dev/cloudwatch-monitoring.html). The following operations are related to C: =over =item * DeleteBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketMetricsConfiguration.html) =item * PutBucketMetricsConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketMetricsConfiguration.html) =item * ListBucketMetricsConfigurations (https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListBucketMetricsConfigurations.html) =back C has the following special error: =over =item * Error code: C =over =item * Description: You are attempting to create a new configuration but have already reached the 1,000-configuration limit. =item * HTTP Status Code: HTTP 400 Bad Request =back =back =head2 PutBucketNotification =over =item Bucket => Str =item NotificationConfiguration => L =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing No longer used, see the PutBucketNotificationConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketNotificationConfiguration.html) operation. =head2 PutBucketNotificationConfiguration =over =item Bucket => Str =item NotificationConfiguration => L =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Enables notifications of specified events for a bucket. For more information about event notifications, see Configuring Event Notifications (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). Using this API, you can replace an existing notification configuration. The configuration is an XML file that defines the event types that you want Amazon S3 to publish and the destination where you want Amazon S3 to publish an event notification when it detects an event of the specified type. By default, your bucket has no event notifications configured. That is, the notification configuration will be an empty C. CNotificationConfigurationE> C/NotificationConfigurationE> This action replaces the existing notification configuration with the configuration you include in the request body. After Amazon S3 receives this request, it first verifies that any Amazon Simple Notification Service (Amazon SNS) or Amazon Simple Queue Service (Amazon SQS) destination exists, and that the bucket owner has permission to publish to it by sending a test notification. In the case of AWS Lambda destinations, Amazon S3 verifies that the Lambda function permissions grant Amazon S3 permission to invoke the function from the Amazon S3 bucket. For more information, see Configuring Notifications for Amazon S3 Events (https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html). You can disable notifications by adding the empty NotificationConfiguration element. By default, only the bucket owner can configure notifications on a bucket. However, bucket owners can use a bucket policy to grant permission to other users to set this configuration with C permission. The PUT notification is an atomic operation. For example, suppose your notification configuration includes SNS topic, SQS queue, and Lambda function configurations. When you send a PUT request with this configuration, Amazon S3 sends test messages to your SNS topic. If the message fails, the entire PUT action will fail, and Amazon S3 will not add the configuration to your bucket. B If the configuration in the request body includes only one C specifying only the C event type, the response will also include the C header containing the message ID of the test notification sent to the topic. The following action is related to C: =over =item * GetBucketNotificationConfiguration (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketNotificationConfiguration.html) =back =head2 PutBucketOwnershipControls =over =item Bucket => Str =item OwnershipControls => L =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Creates or modifies C for an Amazon S3 bucket. To use this operation, you must have the C permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). For information about Amazon S3 Object Ownership, see Using Object Ownership (https://docs.aws.amazon.com/AmazonS3/latest/dev/about-object-ownership.html). The following operations are related to C: =over =item * GetBucketOwnershipControls =item * DeleteBucketOwnershipControls =back =head2 PutBucketPolicy =over =item Bucket => Str =item Policy => Str =item [ConfirmRemoveSelfBucketAccess => Bool] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Applies an Amazon S3 bucket policy to an Amazon S3 bucket. If you are using an identity other than the root user of the AWS account that owns the bucket, the calling identity must have the C permissions on the specified bucket and belong to the bucket owner's account in order to use this operation. If you don't have C permissions, Amazon S3 returns a C<403 Access Denied> error. If you have the correct permissions, but you're not using an identity that belongs to the bucket owner's account, Amazon S3 returns a C<405 Method Not Allowed> error. As a security precaution, the root user of the AWS account that owns a bucket can always use this operation, even if the policy explicitly denies the root user the ability to perform this action. For more information about bucket policies, see Using Bucket Policies and User Policies (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-iam-policies.html). The following operations are related to C: =over =item * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) =item * DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) =back =head2 PutBucketReplication =over =item Bucket => Str =item ReplicationConfiguration => L =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =item [Token => Str] =back Each argument is described in detail in: L Returns: nothing Creates a replication configuration or replaces an existing one. For more information, see Replication (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication.html) in the I. To perform this operation, the user or role performing the action must have the iam:PassRole (https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_passrole.html) permission. Specify the replication configuration in the request body. In the replication configuration, you provide the name of the destination bucket or buckets where you want Amazon S3 to replicate objects, the IAM role that Amazon S3 can assume to replicate objects on your behalf, and other relevant information. A replication configuration must include at least one rule, and can contain a maximum of 1,000. Each rule identifies a subset of objects to replicate by filtering the objects in the source bucket. To choose additional subsets of objects to replicate, add a rule for each subset. To specify a subset of the objects in the source bucket to apply a replication rule to, add the Filter element as a child of the Rule element. You can filter objects based on an object key prefix, one or more object tags, or both. When you add the Filter element in the configuration, you must also add the following elements: C, C, and C. If you are using an earlier version of the replication configuration, Amazon S3 handles replication of delete markers differently. For more information, see Backward Compatibility (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-add-config.html#replication-backward-compat-considerations). For information about enabling versioning on a bucket, see Using Versioning (https://docs.aws.amazon.com/AmazonS3/latest/dev/Versioning.html). By default, a resource owner, in this case the AWS account that created the bucket, can perform this operation. The resource owner can also grant others permissions to perform the operation. For more information about permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). B By default, Amazon S3 doesn't replicate objects that are stored at rest using server-side encryption with CMKs stored in AWS KMS. To replicate AWS KMS-encrypted objects, add the following: C, C, C, C, and C. For information about replication configuration, see Replicating Objects Created with SSE Using CMKs stored in AWS KMS (https://docs.aws.amazon.com/AmazonS3/latest/dev/replication-config-for-kms-objects.html). For information on C errors, see List of replication-related error codes (https://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ReplicationErrorCodeList) The following operations are related to C: =over =item * GetBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketReplication.html) =item * DeleteBucketReplication (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketReplication.html) =back =head2 PutBucketRequestPayment =over =item Bucket => Str =item RequestPaymentConfiguration => L =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Sets the request payment configuration for a bucket. By default, the bucket owner pays for downloads from the bucket. This configuration parameter enables the bucket owner (only) to specify that the person requesting the download will be charged for the download. For more information, see Requester Pays Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/RequesterPaysBuckets.html). The following operations are related to C: =over =item * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) =item * GetBucketRequestPayment (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketRequestPayment.html) =back =head2 PutBucketTagging =over =item Bucket => Str =item Tagging => L =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Sets the tags for a bucket. Use tags to organize your AWS bill to reflect your own cost structure. To do this, sign up to get your AWS account bill with tag key values included. Then, to see the cost of combined resources, organize your billing information according to resources with the same tag key values. For example, you can tag several resources with a specific application name, and then organize your billing information to see the total cost of that application across several services. For more information, see Cost Allocation and Tagging (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html) and Using Cost Allocation in Amazon S3 Bucket Tags (https://docs.aws.amazon.com/AmazonS3/latest/dev/CostAllocTagging.html). When this operation sets the tags for a bucket, it will overwrite any current tags the bucket already has. You cannot use this operation to add tags to an existing list of tags. To use this operation, you must have permissions to perform the C action. The bucket owner has this permission by default and can grant this permission to others. For more information about permissions, see Permissions Related to Bucket Subresource Operations (https://docs.aws.amazon.com/AmazonS3/latest/userguide/using-with-s3-actions.html#using-with-s3-actions-related-to-bucket-subresources) and Managing Access Permissions to Your Amazon S3 Resources (https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-access-control.html). C has the following special errors: =over =item * Error code: C =over =item * Description: The tag provided was not a valid tag. This error can occur if the tag did not pass input validation. For information about tag restrictions, see User-Defined Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html) and AWS-Generated Cost Allocation Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/aws-tag-restrictions.html). =back =item * Error code: C =over =item * Description: The XML provided does not match the schema. =back =item * Error code: C =over =item * Description: A conflicting conditional action is currently in progress against this resource. Please try again. =back =item * Error code: C =over =item * Description: The service was unable to apply the provided tag to the bucket. =back =back The following operations are related to C: =over =item * GetBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketTagging.html) =item * DeleteBucketTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucketTagging.html) =back =head2 PutBucketVersioning =over =item Bucket => Str =item VersioningConfiguration => L =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =item [MFA => Str] =back Each argument is described in detail in: L Returns: nothing Sets the versioning state of an existing bucket. To set the versioning state, you must be the bucket owner. You can set the versioning state with one of the following values: BEEnables versioning for the objects in the bucket. All objects added to the bucket receive a unique version ID. BEDisables versioning for the objects in the bucket. All objects added to the bucket receive the version ID null. If the versioning state has never been set on a bucket, it has no versioning state; a GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) request does not return a versioning state value. If the bucket owner enables MFA Delete in the bucket versioning configuration, the bucket owner must include the C header and the C and the C request elements in a request to set the versioning state of the bucket. If you have an object expiration lifecycle policy in your non-versioned bucket and you want to maintain the same permanent delete behavior when you enable versioning, you must add a noncurrent expiration policy. The noncurrent expiration lifecycle policy will manage the deletes of the noncurrent object versions in the version-enabled bucket. (A version-enabled bucket maintains one current and zero or more noncurrent object versions.) For more information, see Lifecycle and Versioning (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-and-other-bucket-config). B =over =item * CreateBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html) =item * DeleteBucket (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html) =item * GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html) =back =head2 PutBucketWebsite =over =item Bucket => Str =item WebsiteConfiguration => L =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Sets the configuration of the website that is specified in the C subresource. To configure a bucket as a website, you can add this subresource on the bucket with website configuration information such as the file name of the index document and any redirect rules. For more information, see Hosting Websites on Amazon S3 (https://docs.aws.amazon.com/AmazonS3/latest/dev/WebsiteHosting.html). This PUT action requires the C permission. By default, only the bucket owner can configure the website attached to a bucket; however, bucket owners can allow other users to set the website configuration by writing a bucket policy that grants them the C permission. To redirect all website requests sent to the bucket's website endpoint, you add a website configuration with the following elements. Because all requests are sent to another website, you don't need to provide index document name for the bucket. =over =item * C =item * C =item * C =item * C =back If you want granular control over redirects, you can use the following elements to add routing rules that describe conditions for redirecting requests and information about the redirect destination. In this case, the website configuration must provide an index document for the bucket, because some requests might not be redirected. =over =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =item * C =back Amazon S3 has a limitation of 50 routing rules per website configuration. If you require more than 50 routing rules, you can use object redirect. For more information, see Configuring an Object Redirect (https://docs.aws.amazon.com/AmazonS3/latest/dev/how-to-page-redirect.html) in the I. =head2 PutObject =over =item Bucket => Str =item Key => Str =item [ACL => Str] =item [Body => Str] =item [BucketKeyEnabled => Bool] =item [CacheControl => Str] =item [ContentDisposition => Str] =item [ContentEncoding => Str] =item [ContentLanguage => Str] =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ContentType => Str] =item [ExpectedBucketOwner => Str] =item [Expires => Str] =item [GrantFullControl => Str] =item [GrantRead => Str] =item [GrantReadACP => Str] =item [GrantWriteACP => Str] =item [Metadata => L] =item [ObjectLockLegalHoldStatus => Str] =item [ObjectLockMode => Str] =item [ObjectLockRetainUntilDate => Str] =item [RequestPayer => Str] =item [ServerSideEncryption => Str] =item [SSECustomerAlgorithm => Str] =item [SSECustomerKey => Str] =item [SSECustomerKeyMD5 => Str] =item [SSEKMSEncryptionContext => Str] =item [SSEKMSKeyId => Str] =item [StorageClass => Str] =item [Tagging => Str] =item [WebsiteRedirectLocation => Str] =back Each argument is described in detail in: L Returns: a L instance Adds an object to a bucket. You must have WRITE permissions on a bucket to add an object to it. Amazon S3 never adds partial objects; if you receive a success response, Amazon S3 added the entire object to the bucket. Amazon S3 is a distributed system. If it receives multiple write requests for the same object simultaneously, it overwrites all but the last object written. Amazon S3 does not provide object locking; if you need this, make sure to build it into your application layer or use versioning instead. To ensure that data is not corrupted traversing the network, use the C header. When you use this header, Amazon S3 checks the object against the provided MD5 value and, if they do not match, returns an error. Additionally, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value. The C header is required for any request to upload an object with a retention period configured using Amazon S3 Object Lock. For more information about Amazon S3 Object Lock, see Amazon S3 Object Lock Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock-overview.html) in the I. B You can optionally request server-side encryption. With server-side encryption, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts the data when you access it. You have the option to provide your own encryption key or use AWS managed encryption keys (SSE-S3 or SSE-KMS). For more information, see Using Server-Side Encryption (https://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html). If you request server-side encryption using AWS Key Management Service (SSE-KMS), you can enable an S3 Bucket Key at the object-level. For more information, see Amazon S3 Bucket Keys (https://docs.aws.amazon.com/AmazonS3/latest/dev/bucket-key.html) in the I. B You can use headers to grant ACL- based permissions. By default, all objects are private. Only the owner has full access control. When adding a new object, you can grant permissions to individual AWS accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) and Managing ACLs Using the REST API (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-using-rest-api.html). B By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes (https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html) in the I. B If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. For more information about versioning, see Adding Objects to Versioning Enabled Buckets (https://docs.aws.amazon.com/AmazonS3/latest/dev/AddingObjectstoVersioningEnabledBuckets.html). For information about returning the versioning state of a bucket, see GetBucketVersioning (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketVersioning.html). B =over =item * CopyObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) =item * DeleteObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html) =back =head2 PutObjectAcl =over =item Bucket => Str =item Key => Str =item [AccessControlPolicy => L] =item [ACL => Str] =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =item [GrantFullControl => Str] =item [GrantRead => Str] =item [GrantReadACP => Str] =item [GrantWrite => Str] =item [GrantWriteACP => Str] =item [RequestPayer => Str] =item [VersionId => Str] =back Each argument is described in detail in: L Returns: a L instance Uses the C subresource to set the access control list (ACL) permissions for a new or existing object in an S3 bucket. You must have C permission to set the ACL of an object. For more information, see What permissions can I grant? (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#permissions) in the I. This action is not supported by Amazon S3 on Outposts. Depending on your application needs, you can choose to set the ACL on an object using either the request body or the headers. For example, if you have an existing application that updates a bucket ACL using the request body, you can continue to use that approach. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html) in the I. B You can set access permissions using one of the following methods: =over =item * Specify a canned ACL with the C request header. Amazon S3 supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions. Specify the canned ACL name as the value of Cl. If you use this header, you cannot use other access control-specific headers in your request. For more information, see Canned ACL (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#CannedACL). =item * Specify access permissions explicitly with the C, C, C, and C headers. When using these headers, you specify explicit access permissions and grantees (AWS accounts or Amazon S3 groups) who will receive the permission. If you use these ACL-specific headers, you cannot use C header to set a canned ACL. These parameters map to the set of permissions that Amazon S3 supports in an ACL. For more information, see Access Control List (ACL) Overview (https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html). You specify each grantee as a type=value pair, where the type is one of the following: =over =item * C E if the value specified is the canonical user ID of an AWS account =item * C E if you are granting permissions to a predefined group =item * C E if the value specified is the email address of an AWS account Using email addresses to specify a grantee is only supported in the following AWS Regions: =over =item * US East (N. Virginia) =item * US West (N. California) =item * US West (Oregon) =item * Asia Pacific (Singapore) =item * Asia Pacific (Sydney) =item * Asia Pacific (Tokyo) =item * Europe (Ireland) =item * South America (SEo Paulo) =back For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the AWS General Reference. =back For example, the following C header grants list objects permission to the two AWS accounts identified by their email addresses. C =back You can use either a canned ACL or specify access permissions explicitly. You cannot do both. B You can specify the person (grantee) to whom you're assigning access rights (using request elements) in the following ways: =over =item * By the person's ID: CGrantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="CanonicalUser"EEIDEEEIDEEE/IDEEDisplayNameEEEGranteesEmailEEE/DisplayNameE E/GranteeE> DisplayName is optional and ignored in the request. =item * By URI: CGrantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="Group"EEURIEEEhttp://acs.amazonaws.com/groups/global/AuthenticatedUsersEEE/URIEE/GranteeE> =item * By Email address: CGrantee xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="AmazonCustomerByEmail"EEEmailAddressEEEGrantees@email.comEEE/EmailAddressElt;/GranteeE> The grantee is resolved to the CanonicalUser and, in a response to a GET Object acl request, appears as the CanonicalUser. Using email addresses to specify a grantee is only supported in the following AWS Regions: =over =item * US East (N. Virginia) =item * US West (N. California) =item * US West (Oregon) =item * Asia Pacific (Singapore) =item * Asia Pacific (Sydney) =item * Asia Pacific (Tokyo) =item * Europe (Ireland) =item * South America (SEo Paulo) =back For a list of all the Amazon S3 supported Regions and endpoints, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region) in the AWS General Reference. =back B The ACL of an object is set at the object version level. By default, PUT sets the ACL of the current version of an object. To set the ACL of a different version, use the C subresource. B =over =item * CopyObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html) =item * GetObject (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html) =back =head2 PutObjectLegalHold =over =item Bucket => Str =item Key => Str =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =item [LegalHold => L] =item [RequestPayer => Str] =item [VersionId => Str] =back Each argument is described in detail in: L Returns: a L instance Applies a Legal Hold configuration to the specified object. For more information, see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). This action is not supported by Amazon S3 on Outposts. =head2 PutObjectLockConfiguration =over =item Bucket => Str =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =item [ObjectLockConfiguration => L] =item [RequestPayer => Str] =item [Token => Str] =back Each argument is described in detail in: L Returns: a L instance Places an Object Lock configuration on the specified bucket. The rule specified in the Object Lock configuration will be applied by default to every new object placed in the specified bucket. For more information, see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). =over =item * The C settings require both a mode and a period. =item * The C period can be either C or C but you must select one. You cannot specify C and C at the same time. =item * You can only enable Object Lock for new buckets. If you want to turn on Object Lock for an existing bucket, contact AWS Support. =back =head2 PutObjectRetention =over =item Bucket => Str =item Key => Str =item [BypassGovernanceRetention => Bool] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =item [RequestPayer => Str] =item [Retention => L] =item [VersionId => Str] =back Each argument is described in detail in: L Returns: a L instance Places an Object Retention configuration on an object. For more information, see Locking Objects (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html). This action is not supported by Amazon S3 on Outposts. =head2 PutObjectTagging =over =item Bucket => Str =item Key => Str =item Tagging => L =item [ContentLength => Int] =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =item [RequestPayer => Str] =item [VersionId => Str] =back Each argument is described in detail in: L Returns: a L instance Sets the supplied tag-set to an object that already exists in a bucket. A tag is a key-value pair. You can associate tags with an object by sending a PUT request against the tagging subresource that is associated with the object. You can retrieve tags by sending a GET request. For more information, see GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html). For tagging-related restrictions related to characters and encodings, see Tag Restrictions (https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html). Note that Amazon S3 limits the maximum number of tags to 10 tags per object. To use this operation, you must have permission to perform the C action. By default, the bucket owner has this permission and can grant this permission to others. To put tags of any other version, use the C query parameter. You also need permission for the C action. For information about the Amazon S3 object tagging feature, see Object Tagging (https://docs.aws.amazon.com/AmazonS3/latest/dev/object-tagging.html). B =over =item * =over =item * I =item * I =back =item * =over =item * I =item * I =back =item * =over =item * I =item * I =back =item * =over =item * I =item * I =back =back B =over =item * GetObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectTagging.html) =item * DeleteObjectTagging (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjectTagging.html) =back =head2 PutPublicAccessBlock =over =item Bucket => Str =item PublicAccessBlockConfiguration => L =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =back Each argument is described in detail in: L Returns: nothing Creates or modifies the C configuration for an Amazon S3 bucket. To use this operation, you must have the C permission. For more information about Amazon S3 permissions, see Specifying Permissions in a Policy (https://docs.aws.amazon.com/AmazonS3/latest/dev/using-with-s3-actions.html). When Amazon S3 evaluates the C configuration for a bucket or an object, it checks the C configuration for both the bucket (or the bucket that contains the object) and the bucket owner's account. If the C configurations are different between the bucket and the account, Amazon S3 uses the most restrictive combination of the bucket-level and account-level settings. For more information about when Amazon S3 considers a bucket or an object public, see The Meaning of "Public" (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html#access-control-block-public-access-policy-status). B =over =item * GetPublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetPublicAccessBlock.html) =item * DeletePublicAccessBlock (https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeletePublicAccessBlock.html) =item * GetBucketPolicyStatus (https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketPolicyStatus.html) =item * Using Amazon S3 Block Public Access (https://docs.aws.amazon.com/AmazonS3/latest/dev/access-control-block-public-access.html) =back =head2 RestoreObject =over =item Bucket => Str =item Key => Str =item [ContentMD5 => Str] =item [ExpectedBucketOwner => Str] =item [RequestPayer => Str] =item [RestoreRequest => L] =item [VersionId => Str] =back Each argument is described in detail in: L Returns: a L instance Restores an archived copy of an object back into Amazon S3 This action is not supported by Amazon S3 on Outposts. This action performs the following types of requests: =over =item * C type of restoration for your query in the request body's C structure. You can use expressions like the following examples. =over =item * The following expression returns all records from the specified object. C 100> =item * If you have headers and you set the C in the C structure in the request body to C, you can specify headers in the query. (If you set the C field to C, the first row is skipped for the query.) You cannot mix ordinal positions with header column names. C