.\" 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::Client 3pm"
.TH Net::Amazon::S3::Client 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::Client \- An easy\-to\-use Amazon S3 client
.SH "VERSION"
.IX Header "VERSION"
version 0.991
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\&        # Build Client instance
\&        my $client = Net::Amazon::S3::Client\->new (
\&                # accepts all Net::Amazon::S3\*(Aqs arguments
\&                aws_access_key_id     => $aws_access_key_id,
\&                aws_secret_access_key => $aws_secret_access_key,
\&                retry                 => 1,
\&        );
\&
\&        # or reuse an existing S3 connection
\&        my $client = Net::Amazon::S3::Client\->new (s3 => $s3);
\&
\&        # list all my buckets
\&        # returns a list of L<Net::Amazon::S3::Client::Bucket> objects
\&        my @buckets = $client\->buckets;
\&        foreach my $bucket (@buckets) {
\&                print $bucket\->name . "\en";
\&        }
\&
\&        # create a new bucket
\&        # returns a L<Net::Amazon::S3::Client::Bucket> object
\&        my $bucket = $client\->create_bucket(
\&                name                => $bucket_name,
\&                acl_short           => \*(Aqprivate\*(Aq,
\&                location_constraint => \*(Aqus\-east\-1\*(Aq,
\&        );
\&
\&        # or use an existing bucket
\&        # returns a L<Net::Amazon::S3::Client::Bucket> object
\&        my $bucket = $client\->bucket( name => $bucket_name );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Net::Amazon::S3 module was written when the Amazon S3 service
had just come out and it is a light wrapper around the APIs. Some
bad \s-1API\s0 decisions were also made. The
Net::Amazon::S3::Client, Net::Amazon::S3::Client::Bucket and
Net::Amazon::S3::Client::Object classes are designed after years
of usage to be easy to use for common tasks.
.PP
These classes throw an exception when a fatal error occurs. It
also is very careful to pass an \s-1MD5\s0 of the content when uploaded
to S3 and check the resultant ETag.
.PP
\&\s-1WARNING:\s0 This is an early release of the Client classes, the APIs
may change.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
.IP "s3" 4
.IX Item "s3"
Net::Amazon::S3 instance
.IP "error_handler_class" 4
.IX Item "error_handler_class"
Error handler class name (package name), see Net::Amazon::S3::Error::Handler
for more. Overrides one available in \f(CW\*(C`s3\*(C'\fR.
.Sp
Default: Net::Amazon::S3::Error::Handler::Confess
.IP "error_handler" 4
.IX Item "error_handler"
Instance of error handler class.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
Net::Amazon::S3::Client can be constructed two ways.
.PP
Historically it wraps S3 \s-1API\s0 instance
.PP
.Vb 1
\&        use Net::Amazon::S3::Client;
\&
\&        my $client = Net::Amazon::S3::Client\->new (
\&                s3 => .... # Net::Amazon::S3 instance
\&        );
.Ve
.SS "new (since v0.92)"
.IX Subsection "new (since v0.92)"
Since v0.92 explicit creation of S3 \s-1API\s0 instance is no longer necessary.
Net::Amazon::S3::Client's constructor accepts same parameters as Net::Amazon::S3
.PP
.Vb 1
\&        use Net::Amazon::S3::Client v0.92;
\&
\&        my $client = Net::Amazon::S3::Client\->new (
\&                aws_access_key_id     => ...,
\&                aws_secret_access_key => ...,
\&                ...,
\&        );
.Ve
.SS "buckets"
.IX Subsection "buckets"
.Vb 6
\&  # list all my buckets
\&  # returns a list of L<Net::Amazon::S3::Client::Bucket> objects
\&  my @buckets = $client\->buckets;
\&  foreach my $bucket (@buckets) {
\&    print $bucket\->name . "\en";
\&  }
.Ve
.SS "create_bucket"
.IX Subsection "create_bucket"
.Vb 7
\&  # create a new bucket
\&  # returns a L<Net::Amazon::S3::Client::Bucket> object
\&  my $bucket = $client\->create_bucket(
\&    name                => $bucket_name,
\&    acl_short           => \*(Aqprivate\*(Aq,
\&    location_constraint => \*(Aqus\-east\-1\*(Aq,
\&  );
.Ve
.SS "bucket"
.IX Subsection "bucket"
.Vb 3
\&  # or use an existing bucket
\&  # returns a L<Net::Amazon::S3::Client::Bucket> object
\&  my $bucket = $client\->bucket( name => $bucket_name );
.Ve
.SS "bucket_class"
.IX Subsection "bucket_class"
.Vb 3
\&  # returns string "Net::Amazon::S3::Client::Bucket"
\&  # subclasses will want to override this.
\&  my $bucket_class = $client\->bucket_class
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Branislav Zahradník <barney@cpan.org>
.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.