man > Amazon::S3

man perldoc info pydoc3 ri search

📖 NAME

Amazon::S3 — A portable client library for working with and managing Amazon S3 buckets and keys.

🚀 Quick Reference

Use Case	Command	Description
🔐 Connect to S3	Amazon::S3->new({ aws_access_key_id => $key, aws_secret_access_key => $secret })	Create a new S3 client object
🪣 List buckets	$s3->buckets	Retrieve all buckets for the account
➕ Create bucket	$s3->add_bucket({ bucket => $name })	Add a new bucket to the account
📄 Upload key	$bucket->add_key($keyname, $value, { content_type => 'text/plain' })	Store a key with optional metadata
📋 List keys	$bucket->list	List all keys in a bucket
❌ Delete key	$bucket->delete_key($keyname)	Remove a key from a bucket
🗑️ Delete bucket	$bucket->delete_bucket	Remove an empty bucket
🔍 Paginate results	$s3->list_bucket({ bucket => $name, marker => $last_key })	List keys with pagination support

📝 SYNOPSIS

#!/usr/bin/perl
use warnings;
use strict;

use Amazon::S3;

use vars qw/$OWNER_ID $OWNER_DISPLAYNAME/;

my $aws_access_key_id     = "Fill me in!";
my $aws_secret_access_key = "Fill me in too!";

my $s3 = Amazon::S3->new(
    {   aws_access_key_id     => $aws_access_key_id,
        aws_secret_access_key => $aws_secret_access_key,
        retry                 => 1
    }
);

my $response = $s3->buckets;

# create a bucket
my $bucket_name = $aws_access_key_id . '-net-amazon-s3-test';
my $bucket = $s3->add_bucket( { bucket => $bucket_name } )
    or die $s3->err . ": " . $s3->errstr;

# store a key with a content-type and some optional metadata
my $keyname = 'testing.txt';
my $value   = 'T';
$bucket->add_key(
    $keyname, $value,
    {   content_type        => 'text/plain',
        'x-amz-meta-colour' => 'orange',
    }
);

# list keys in the bucket
$response = $bucket->list
    or die $s3->err . ": " . $s3->errstr;
print $response->{bucket}."\n";
for my $key (@{ $response->{keys} }) {
      print "\t".$key->{key}."\n";
}

# delete key from bucket
$bucket->delete_key($keyname);

# delete bucket
$bucket->delete_bucket;

🔍 DESCRIPTION

Amazon::S3 provides a portable client interface to Amazon Simple Storage System (S3).

"Amazon S3 is storage for the Internet. It is designed to make web-scale computing easier for developers. Amazon S3 provides a simple web services interface that can be used 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".

To sign up for an Amazon Web Services account, required to use this library and the S3 service, please visit the Amazon Web Services web site at http://www.amazonaws.com/.

You will be billed accordingly by Amazon when you use this module and must be responsible for these costs.

To learn more about Amazon's S3 service, please visit: http://s3.amazonaws.com/.

This need for this module arose from some work that needed to work with S3 and would be distributed, installed and used on many various environments where compiled dependencies may not be an option. Net::Amazon::S3 used XML::LibXML tying it to that specific and often difficult to install option. In order to remove this potential barrier to entry, this module is forked and then modified to use XML::SAX via XML::Simple.

Amazon::S3 is intended to be a drop-in replacement for <Net:Amazon::S3> that trades some performance in return for portability.

🛠️ METHODS

🆕 new

Create a new S3 client object. Takes some arguments:

• aws_access_key_id — Use your Access Key ID as the value of the AWSAccessKeyId parameter in requests you send to Amazon Web Services (when required). Your Access Key ID identifies you as the party responsible for the request.
• aws_secret_access_key — Since your Access Key ID is not encrypted in requests to AWS, it could be discovered and used by anyone. Services that are not free require you to provide additional information, a request signature, to verify that a request containing your unique Access Key ID could only have come from you. DO NOT INCLUDE THIS IN SCRIPTS OR APPLICATIONS YOU DISTRIBUTE. YOU'LL BE SORRY.
• secure — Set this to 1 if you want to use SSL-encrypted connections when talking to S3. Defaults to 0.
• timeout — Defines the time, in seconds, your script should wait for a response before bailing. Defaults is 30 seconds.
• retry — Enables or disables the library to retry upon errors. This uses exponential backoff with retries after 1, 2, 4, 8, 16, 32 seconds, as recommended by Amazon. Defaults to off, no retries.
• host — Defines the S3 host endpoint to use. Defaults to 's3.amazonaws.com'.

📦 buckets

Returns undef on error, else HASHREF of results:

• owner_id — The owner's ID of the buckets owner.
• owner_display_name — The name of the owner account.
• buckets — An ARRAYREF of Amazon::SimpleDB::Bucket objects for the account.

➕ add_bucket

Takes a HASHREF:

• bucket — The name of the bucket you want to add
• acl_short (optional) — See the set_acl subroutine for documentation on the acl_short options

Returns 0 on failure or a Amazon::S3::Bucket object on success

🪣 bucket BUCKET

Takes a scalar argument, the name of the bucket you're creating

Returns an (unverified) bucket object from an account. This method does not access the network.

🗑️ delete_bucket

Takes either a Amazon::S3::Bucket object or a HASHREF containing

• bucket — The name of the bucket to remove

Returns false (and fails) if the bucket isn't empty.

Returns true if the bucket is successfully deleted.

📋 list_bucket

List all keys in this bucket.

Takes a HASHREF of arguments:

• bucket — REQUIRED. The name of the bucket you want to list keys on.
• prefix — Restricts the response to only contain results that begin with the specified prefix. If you omit this optional argument, the value of prefix for your query will be the empty string. In other words, the results will not be restricted by prefix.
• delimiter — If this optional, Unicode string parameter is included with your request, then keys that contain the same string between the prefix and the first occurrence of the delimiter will be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. For example, with prefix="USA/" and delimiter="/", the matching keys "USA/Oregon/Salem" and "USA/Oregon/Portland" would be summarized in the response as a single "USA/Oregon" element in the CommonPrefixes collection. If an otherwise matching key does not contain the delimiter after the prefix, it appears in the Contents collection. Each element in the CommonPrefixes collection counts as one against the MaxKeys limit. The rolled-up keys represented by each CommonPrefixes element do not. If the Delimiter parameter is not present in your request, keys in the result set will not be rolled-up and neither the CommonPrefixes collection nor the NextMarker element will be present in the response. NOTE: CommonPrefixes isn't currently supported by Amazon::S3.
• max-keys — This optional argument limits the number of results returned in response to your query. Amazon S3 will return no more than this number of results, but possibly less. Even if max-keys is not specified, Amazon S3 will limit the number of results in the response. Check the IsTruncated flag to see if your results are incomplete. If so, use the Marker parameter to request the next page of results. For the purpose of counting max-keys, a 'result' is either a key in the 'Contents' collection, or a delimited prefix in the 'CommonPrefixes' collection. So for delimiter requests, max-keys limits the total number of list results, not just the number of keys.
• marker — This optional parameter enables pagination of large result sets. "marker" specifies where in the result set to resume listing. It restricts the response to only contain results that occur alphabetically after the value of marker. To retrieve the next page of results, use the last key from the current page of results as the marker in your next request. See also "next_marker", below. If "marker" is omitted, the first page of results is returned.

Returns undef on error and a HASHREF of data on success:

The HASHREF looks like this:

{
      bucket       => $bucket_name,
      prefix       => $bucket_prefix,
      marker       => $bucket_marker,
      next_marker  => $bucket_next_available_marker,
      max_keys     => $bucket_max_keys,
      is_truncated => $bucket_is_truncated_boolean
      keys          => [$key1,$key2,...]
 }

Explanation of bits of that:

• is_truncated — A flag that indicates whether or not all results of your query were returned in this response. If your results were truncated, you can make a follow-up paginated request using the Marker parameter to retrieve the rest of the results.
• next_marker — A convenience element, useful when paginating with delimiters. The value of "next_marker", if present, is the largest (alphabetically) of all key names and all CommonPrefixes prefixes in the response. If the "is_truncated" flag is set, request the next page of results by setting "marker" to the value of "next_marker". This element is only present in the response if the "delimiter" parameter was sent with the request.

Each key is a HASHREF that looks like this:

{
     key           => $key,
     last_modified => $last_mod_date,
     etag          => $etag, # An MD5 sum of the stored content.
     size          => $size, # Bytes
     storage_class => $storage_class
     owner_id      => $owner_id,
     owner_displayname => $owner_name
 }

📄 list_bucket_all

List all keys in this bucket without having to worry about 'marker'. This is a convenience method, but may make multiple requests to S3 under the hood.

Takes the same arguments as list_bucket.

ℹ️ ABOUT

This module contains code modified from Amazon that contains the following notice:

#  This software code is made available "AS IS" without warranties of any
#  kind.  You may copy, display, modify and redistribute the software
#  code either by itself or as incorporated into your code; provided that
#  you do not remove any proprietary notices.  Your use of this software
#  code is at your own risk and you waive any claim against Amazon
#  Digital Services, Inc. or its affiliates with respect to your use of
#  this software code. (c) 2006 Amazon Digital Services, Inc. or its
#  affiliates.

🧪 TESTING

Testing S3 is a tricky thing. Amazon wants to charge you a bit of money each time you use their service. And yes, testing counts as using. Because of this, the application's test suite skips anything approaching a real test unless you set these three environment variables:

• AMAZON_S3_EXPENSIVE_TESTS — Doesn't matter what you set it to. Just has to be set
• AWS_ACCESS_KEY_ID — Your AWS access key
• AWS_ACCESS_KEY_SECRET — Your AWS sekkr1t passkey. Be forewarned that setting this environment variable on a shared system might leak that information to another user. Be careful.

📋 TO DO

• Continued to improve and refine of documentation.
• Reduce dependencies wherever possible.
• Implement debugging mode
• Refactor and consolidate request code in Amazon::S3
• Refactor URI creation code to make use of URI.

🆘 SUPPORT

Bugs should be reported via the CPAN bug tracker at

<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Amazon-S3>

For other issues, contact the author.

👤 AUTHOR

Timothy Appnel <tima AT cpan.org>

🔗 SEE ALSO

• Amazon::S3::Bucket
• Net::Amazon::S3

📜 COPYRIGHT AND LICENCE

This module was initially based on Net::Amazon::S3 0.41, by Leon Brocard. Net::Amazon::S3 was based on example code from Amazon with this notice:

#  This software code is made available "AS IS" without warranties of any
#  kind.  You may copy, display, modify and redistribute the software
#  code either by itself or as incorporated into your code; provided that
#  you do not remove any proprietary notices.  Your use of this software
#  code is at your own risk and you waive any claim against Amazon
#  Digital Services, Inc. or its affiliates with respect to your use of
#  this software code. (c) 2006 Amazon Digital Services, Inc. or its
#  affiliates.

The software is released under the Artistic License. The terms of the Artistic License are described at http://www.perl.com/language/misc/Artistic.html. Except where otherwise noted, Amazon::S3 is Copyright 2008, Timothy Appnel, tima AT cpan.org. All rights reserved.

📖 NAME 🚀 Quick Reference 📝 SYNOPSIS 🔍 DESCRIPTION 🛠️ METHODS ℹ️ ABOUT 🧪 TESTING 📋 TO DO 🆘 SUPPORT 👤 AUTHOR 🔗 SEE ALSO 📜 COPYRIGHT AND LICENCE