Bucket names with dots, HTTPS, and Signature V4

Due the current implementation of Signature V4 handling you should use workaround consisting of usage of region hostnames

        my $bucket_region = $global_s3->bucket ($bucket)->_head_region;

        my $region_s3 = Net::Amazon:S3->new (
                ...,
                vendor => Net::Amazon::S3::Vendor::Amazon->new (
                        host => "s3-$bucket_region.amazonaws.com",
                        use_virtual_host => 0,
                ),
        );

        my $bucket = $region_s3->bucket ($bucket);

And use bucket instance / region s3 connection.

new

authorization_context

Class that provides authorization information.

See one of available implementations for more

vendor

Instance of Net::Amazon::S3::Vendor holding vendor specific deviations.

S3 became widely used object storage protocol with many vendors providing different feature sets and different compatibility level.

One common difference is bucket's HEAD request to determine its region.

To maintain currently known differences along with any differencies that may rise in feature it's better to hold vendor specification in dedicated classes. This also allows users to build their own fine-tuned vendor classes.

aws_access_key_id

Deprecated.

When used it's used to create authorization context.

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

Deprecated.

When used it's used to create authorization context.

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

aws_session_token

Deprecated.

When used it's used to create authorization context.

If you are using temporary credentials provided by the AWS Security Token Service, set the token here, and it will be added to the request in order to authenticate it.

use_iam_role

Deprecated.

When used it's used to create authorization context.

If you'd like to use IAM provided temporary credentials, pass this option with a true value.

secure

Deprecated.

Set this to 0 if you don't want to use SSL-encrypted connections when talking to S3. Defaults to 1.

To use SSL-encrypted connections, LWP::Protocol::https is required.

See #vendor and Net::Amazon::S3::Vendor.

keep_alive_cache_size

Set this to 0 to disable Keep-Alives. Default is 10.

timeout

How many seconds should your script wait before bailing on a request to S3? Defaults to 30.

retry

If this library should retry upon errors. This option is recommended. This uses exponential backoff with retries after 1, 2, 4, 8, 16, 32 seconds, as recommended by Amazon. Defaults to off.

host

Deprecated.

The S3 host endpoint to use. Defaults to 's3.amazonaws.com'. This allows you to connect to any S3-compatible host.

See #vendor and Net::Amazon::S3::Vendor.

use_virtual_host

Deprecated.

Use the virtual host method ('bucketname.s3.amazonaws.com') instead of specifying the bucket at the first part of the path. This is particularly useful if you want to access buckets not located in the US-Standard region (such as EU, Asia Pacific or South America). See <http://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html> for the pros and cons.

See #vendor and Net::Amazon::S3::Vendor.

authorization_method

Deprecated.

Authorization implementation package name.

This library provides Net::Amazon::S3::Signature::V2 and Net::Amazon::S3::Signature::V4

Default is Signature 4 if host is "s3.amazonaws.com", Signature 2 otherwise

See #vendor and Net::Amazon::S3::Vendor.

error_handler_class

Error handler class name (package name), see Net::Amazon::S3::Error::Handler for more.

Default: Net::Amazon::S3::Error::Handler::Legacy

error_handler

Instance of error handler class.

Notes

When using Net::Amazon::S3 in child processes using fork (such as in combination with the excellent Parallel::ForkManager) you should create the S3 object in each child, use a fresh LWP::UserAgent in each child, or disable the LWP::ConnCache in the parent:

    $s3->ua( LWP::UserAgent->new( 
        keep_alive => 0, requests_redirectable => [qw'GET HEAD DELETE PUT POST'] );

buckets

add_bucket

        # Create new bucket with default location
        my $bucket = $s3->add_bucket ('new-bucket');

        # Create new bucket in another location
        my $bucket = $s3->add_bucket ('new-bucket', location_constraint => 'eu-west-1');
        my $bucket = $s3->add_bucket ('new-bucket', { location_constraint => 'eu-west-1' });
        my $bucket = $s3->add_bucket (bucket => 'new-bucket', location_constraint => 'eu-west-1');
        my $bucket = $s3->add_bucket ({ bucket => 'new-bucket', location_constraint => 'eu-west-1' });

Method creates and returns new bucket.

In case of error it reports it and returns "undef" (refer "ERROR HANDLING").

Recognized positional arguments (refer "CALLING CONVENTION")

bucket

Required, recognized as positional.

The name of the bucket you want to add.

Recognized optional arguments

acl

        acl => 'private'
        acl => Net::Amazon::S3::ACL::Canned->PRIVATE
        acl => Net::Amazon::S3::ACL::Set->grant_read (email => 'foo@bar.baz')
    

Available since v0.94

Set ACL to the newly created bucket. Refer Net::Amazon::S3::ACL for possibilities.

acl_short (deprecated)

Deprecated since v0.94

When specified its value is used to populate "acl" argument (unless it exists).

location_constraint

Optional.

Sets the location constraint of the new bucket. If left unspecified, the default S3 datacenter location will be used.

This library recognizes regions according Amazon S3 documentation

Provides operation CreateBucket <https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateBucket.html>.

bucket BUCKET

Returns an (unverified) bucket object from an account. Does no network access.

delete_bucket

        $s3->delete_bucket ($bucket);
        $s3->delete_bucket (bucket => $bucket);

Deletes bucket from account.

Returns "true" if the bucket is successfully deleted.

Returns "false" and reports an error otherwise (refer "ERROR HANDLING")

Positional arguments (refer "CALLING CONVENTION")

bucket

Required.

The name of the bucket or Net::Amazon::S3::Bucket instance you want to delete.

Provides operation "DeleteBucket" <https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteBucket.html>

list_bucket

Takes a hashref of arguments:

MANDATORY

bucket

The name of the bucket you want to list keys on

OPTIONAL

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 be 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.

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,
        common_prefixes => [$prefix1,$prefix2,...]
        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:

common_prefixes

If list_bucket was requested with a delimiter, common_prefixes will contain a list of prefixes matching that delimiter. Drill down into these prefixes by making another request with the prefix parameter.

is_truncated

B 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 # Doc?
        owner_id      => $owner_id,
        owner_displayname => $owner_name
    }

list_bucket_all

Takes the same arguments as list_bucket.

_perform_operation

    my $response = $s3->_perform_operation ('Operation' => (
        # ... operation request parameters
    ));

Internal operation implementation method, takes request construction parameters, performs necessary HTTP requests(s) and returns Response instance.

Method takes same named parameters as realted Request class.

Method provides available contextual parameters by default (eg s3, bucket)

Method invokes contextual error handler.