.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Net::Amazon::S3::Features 3pm" .TH Net::Amazon::S3::Features 3pm "2022-07-18" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Net::Amazon::S3::Features \- Features available in Net::Amazon::S3 .SH "VERSION" .IX Header "VERSION" version 0.991 .SH "AUTHOR" .IX Header "AUTHOR" Branislav Zahradník .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2022 by Amazon Digital Services, Leon Brocard, Brad Fitzpatrick, Pedro Figueiredo, Rusty Conover, Branislav Zahradník. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. .SH "API COMPARISON" .IX Header "API COMPARISON" Net::Amazon::S3 supports two APIs with different feature support. .PP This document describes current behaviour. .SS "Error reporting" .IX Subsection "Error reporting" Default error reporting method. .IP "set S3 err" 4 .IX Item "set S3 err" Operation returns expression evaluated as false and \f(CW\*(C`err\*(C'\fR with \f(CW\*(C`errstr\*(C'\fR are populated from response content .Sp See Net::Amazon::S3::Error::Handler::Status, Net::Amazon::S3::Error::Handler::Legacy .IP "set network error" 4 .IX Item "set network error" Populates S3 err with \f(CW\*(C`network_error\*(C'\fR constant and S3 errstr with http status line (eg: \f(CW\*(C`404 Not Found\*(C'\fR) and throws. .Sp See Net::Amazon::S3::Error::Handler::Legacy .IP "confess" 4 .IX Item "confess" Operation throws using \f(CW\*(C`confess\*(C'\fR .Sp See Net::Amazon::S3::Error::Handler::Confess .SS "Feature support" .IX Subsection "Feature support" For details see corresponding \f(CW\*(C`api\-operation\*(C'\fR / \f(CW\*(C`client\-operation\*(C'\fR test file .PP List of \*(L"Amazon S3 Operations\*(R" .PP .Vb 10 \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | operation | Net::Amazon::S3 (API) | Net::Amazon::S3::Client | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | AbortMultipartUpload | ❌ | object\->abort_multipart_upload | \& | returns | ❌ | http response | \& | errors | ❌ | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | CompleteMultipartUpload | ❌ | object\->complete_multipart_upload | \& | returns | ❌ | http response | \& | errors | ❌ | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | CreateBucket | s3\->add_bucket | client\->create_bucket | \& | \- with region | ✅ | ✅ | \& | returns | Bucket instance | Bucket instance | \& | errors | set S3 err | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | CreateMultipartUpload | ❌ | object\->initiate_multipart_upload | \& | returns | ❌ | http response | \& | errors | ❌ | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | DeleteBucket | s3\->delete_bucket | bucket\->delete | \& | returns | boolean | boolean | \& | errors | set S3 err | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | DeleteBucketTagging | bucket\->delete_tags | bucket\->delete_tags | \& | returns | boolean | boolean | \& | errors | set S3 err | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | DeleteObject | bucket\->delete_key | bucket\->object\->delete | \& | returns | boolean | boolean | \& | errors | set S3 err | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | DeleteObjects | bucket\->delete_multi_object | bucket\->delete_multi_object | \& | \- auto chunks | ✅ | ✅ | \& | returns | boolean | HTTP::Response object | \& | errors | set S3 err | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | DeleteObjectTagging | bucket\->delete_tags | bucket\->object\->delete_tags | \& | returns | boolean | boolean | \& | errors | set S3 err | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | GetBucketAcl | bucket\->get_acl | bucket\->acl | \& | returns | response body (XML) | response body (XML) | \& | | (undef on Not Found) | | \& | errors | set network error | confess | \& | | (none on Not Found) | | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | GetBucketLocation | bucket\->get_location_constraint | bucket\->get_location_constraint | \& | returns | location (Str) | location (Str) | \& | errors | set S3 err | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | GetObject | bucket\->get_key | bucket\->object\->get | \& | \- into file | ✅, bucket\->get_key_filename | ✅, bucket\->object\->get_filename | \& | \- into callback | ❌ | ✅, bucket\->object\->get_callback | \& | returns | struct with value | value | \& | | (undef on Not Found) | | \& | errors | set network error | confess | \& | | (none on Not Found) | | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | GetObjectAcl | bucket\->get_acl | ❌ | \& | returns | response body (XML) | ❌ | \& | | (undef on Not Found) | ❌ | \& | errors | set network error | ❌ | \& | | (none on Not Found) | ❌ | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | ListBuckets | s3\->buckets | client\->buckets | \& | returns | Bucket instances in struct | Bucket instances (list) | \& | errors | set S3 err | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | ListObjects | s3\->list_bucket | bucket\->list | \& | \- common prefixes | ✅ | ❌ | \& | \- list all | ✅, s3\->list_bucket_all | ✅ | \& | returns | struct with list | iterator (Object list) | \& | errors | set S3 err | confess during iteration | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | ListObjectsV2 | ❌ | ❌ | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | ListParts | ❌ | ❌ | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | PutBucketAcl | bucket\->set_acl | bucket\->set_acl | \& | \- with canned acl | ✅, as acl | ✅, as acl | \& | \- with explicit acl | ✅, as acl | ✅, as acl | \& | \- with xml acl | ✅, as acl_xml | ✅, as acl_xml | \& | returns | boolean | boolean | \& | errors | set S3 err | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | PutBucketTagging | bucket\->add_tags | bucket\->add_tags | \& | \- with canned acl | ✅, as acl | ✅, as acl | \& | \- with explicit acl | ✅, as acl | ✅, as acl | \& | \- with xml acl | ✅, as acl_xml | ✅, as acl_xml | \& | returns | boolean | boolean | \& | errors | set S3 err | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | PutObject | bucket\->add_key | bucket\->object\->put | \& | returns | boolean | empty string | \& | errors | set S3 err | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | PutObjectAcl | bucket\->set_acl | object\->set_acl | \& | \- with canned acl | ✅, as acl | ✅, as acl | \& | \- with explicit acl | ✅, as acl | ✅, as acl | \& | \- with xml acl | ✅, as acl_xml | ✅, as acl_xml | \& | returns | boolean | boolean | \& | errors | set S3 err | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | PutObjectTagging | bucket\->add_tags | bucket\->object\->add_tags | \& | \- with canned acl | ✅, as acl | ✅, as acl | \& | \- with explicit acl | ✅, as acl | ✅, as acl | \& | \- with xml acl | ✅, as acl_xml | ✅, as acl_xml | \& | returns | boolean | boolean | \& | errors | set S3 err | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | RestoreObject | ❌ | bucket\->object\->restore | \& | returns | ❌ | http response | \& | errors | ❌ | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | UploadPart | ❌ | bucket\->object\->put_part | \& | \- from value | ❌ | ✅ | \& | \- from file | ❌ | ❌ | \& | \- from file chunk | ❌ | ❌ | \& | returns | ❌ | http response | \& | errors | ❌ | confess | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | object\-copy | bucket\->copy_key | ❌ | \& | returns | boolean | ❌ | \& | errors | set S3 err | ❌ | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| \& | object\-head | | ❌ | \& | returns | boolean | ❌ | \& | errors | set S3 err | ❌ | \& |\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-+\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-| .Ve .SS "\s-1TODO\s0 plan (asorted, without time-plan)" .IX Subsection "TODO plan (asorted, without time-plan)" .IP "unify features" 4 .IX Item "unify features" Both APIs should support same set of operations .IP "support all \s-1AWS S3\s0 operations and x\-amz\-* headers" 4 .IX Item "support all AWS S3 operations and x-amz-* headers" https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html .IP "add async \s-1API\s0 (AnyEvent / IO::Async)" 4 .IX Item "add async API (AnyEvent / IO::Async)"