.\" 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::Bucket 3pm"
.TH Net::Amazon::S3::Client::Bucket 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::Bucket \- An easy\-to\-use Amazon S3 client bucket
.SH "VERSION"
.IX Header "VERSION"
version 0.991
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  # return the bucket name
\&  print $bucket\->name . "\en";
\&
\&  # return the bucket location constraint
\&  print "Bucket is in the " . $bucket\->location_constraint . "\en";
\&
\&  # return the ACL XML
\&  my $acl = $bucket\->acl;
\&
\&  # list objects in the bucket
\&  # this returns a L<Data::Stream::Bulk> object which returns a
\&  # stream of L<Net::Amazon::S3::Client::Object> objects, as it may
\&  # have to issue multiple API requests
\&  my $stream = $bucket\->list;
\&  until ( $stream\->is_done ) {
\&    foreach my $object ( $stream\->items ) {
\&      ...
\&    }
\&  }
\&
\&  # or list by a prefix
\&  my $prefix_stream = $bucket\->list( { prefix => \*(Aqlogs/\*(Aq } );
\&
\&  # returns a L<Net::Amazon::S3::Client::Object>, which can then
\&  # be used to get or put
\&  my $object = $bucket\->object( key => \*(Aqthis is the key\*(Aq );
\&
\&  # delete the bucket (it must be empty)
\&  $bucket\->delete;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module represents buckets.
.SH "METHODS"
.IX Header "METHODS"
.SS "acl"
.IX Subsection "acl"
.Vb 2
\&  # return the ACL XML
\&  my $acl = $bucket\->acl;
.Ve
.SS "add_tags"
.IX Subsection "add_tags"
.Vb 3
\&        $bucket\->add_tags (
\&                tags => { tag1 => \*(Aqval1\*(Aq, ... },
\&        )
.Ve
.SS "delete_tags"
.IX Subsection "delete_tags"
.Vb 1
\&        $bucket\->delete_tags;
.Ve
.SS "delete"
.IX Subsection "delete"
.Vb 2
\&  # delete the bucket (it must be empty)
\&  $bucket\->delete;
.Ve
.SS "list"
.IX Subsection "list"
.Vb 10
\&  # list objects in the bucket
\&  # this returns a L<Data::Stream::Bulk> object which returns a
\&  # stream of L<Net::Amazon::S3::Client::Object> objects, as it may
\&  # have to issue multiple API requests
\&  my $stream = $bucket\->list;
\&  until ( $stream\->is_done ) {
\&    foreach my $object ( $stream\->items ) {
\&      ...
\&    }
\&  }
\&
\&  # or list by a prefix
\&  my $prefix_stream = $bucket\->list( { prefix => \*(Aqlogs/\*(Aq } );
\&
\&  # you can emulate folders by using prefix with delimiter
\&  # which shows only entries starting with the prefix but
\&  # not containing any more delimiter (thus no subfolders).
\&  my $folder_stream = $bucket\->list( { prefix => \*(Aqlogs/\*(Aq, delimiter => \*(Aq/\*(Aq } );
.Ve
.SS "location_constraint"
.IX Subsection "location_constraint"
.Vb 2
\&  # return the bucket location constraint
\&  print "Bucket is in the " . $bucket\->location_constraint . "\en";
.Ve
.SS "name"
.IX Subsection "name"
.Vb 2
\&  # return the bucket name
\&  print $bucket\->name . "\en";
.Ve
.SS "object"
.IX Subsection "object"
.Vb 3
\&  # returns a L<Net::Amazon::S3::Client::Object>, which can then
\&  # be used to get or put
\&  my $object = $bucket\->object( key => \*(Aqthis is the key\*(Aq );
.Ve
.SS "delete_multi_object"
.IX Subsection "delete_multi_object"
.Vb 3
\&  # delete multiple objects using a multi object delete operation
\&  # Accepts a list of L<Net::Amazon::S3::Client::Object or String> objects.
\&  $bucket\->delete_multi_object($object1, $object2)
.Ve
.SS "object_class"
.IX Subsection "object_class"
.Vb 3
\&  # returns string "Net::Amazon::S3::Client::Object"
\&  # allowing subclasses to add behavior.
\&  my $object_class = $bucket\->object_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.