List s3 buckets and bucket contents
s3ls [options]
s3ls [options] [ [ bucket | bucket/item ] ...]
Options: --access-key AWS Access Key ID --secret-key AWS Secret Access Key --long Environment: AWS_ACCESS_KEY_ID AWS_ACCESS_KEY_SECRET
Print a brief help message and exits.
Prints the manual page and exits.
Output what is being done as it is done.
Specify the \*(L"\s-1AWS\s0 Access Key Identifiers\*(R" for the \s-1AWS\s0 account. --access-key is the \*(L"Access Key \s-1ID\s0\*(R", and --secret-key is the \*(L"Secret Access Key\*(R". These are effectively the \*(L"username\*(R" and \*(L"password\*(R" to the \s-1AWS\s0 account, and should be kept confidential. The access keys \s-1MUST\s0 be specified, either via these command line parameters, or via the \s-1AWS_ACCESS_KEY_ID\s0 and \s-1AWS_ACCESS_KEY_SECRET\s0 environment variables. Specifying them on the command line overrides the environment variables.
Uses \s-1SSL/TLS\s0 \s-1HTTPS\s0 to communicate with the \s-1AWS\s0 service, instead of \s-1HTTP\s0.
Specify the \*(L"\s-1AWS\s0 Access Key Identifiers\*(R" for the \s-1AWS\s0 account. \s-1AWS_ACCESS_KEY_ID\s0 contains the \*(L"Access Key \s-1ID\s0\*(R", and \s-1AWS_ACCESS_KEY_SECRET\s0 contains the \*(L"Secret Access Key\*(R". These are effectively the \*(L"username\*(R" and \*(L"password\*(R" to the \s-1AWS\s0 service, and should be kept confidential. The access keys \s-1MUST\s0 be specified, either via these environment variables, or via the --access-key and --secret-key command line parameters. If the command line parameters are set, they override these environment variables.
The configuration options will be read from the file \*(C`~/.s3-tools\*(C' if it exists. The format is the same as the command line options with one option per line. For example, the file could contain:
--access-key <AWS access key> --secret-key <AWS secret key> --secure
This example configuration file would specify the \s-1AWS\s0 access keys and that a secure connection using \s-1HTTPS\s0 should be used for all communications.
Lists the buckets owned by the user, or all the item keys in a given bucket, or attributes associated with a given item.
If no buckets or bucket/itemkey is specified on the command line, all the buckets owned by the user are listed.
If the \*(C`--long\*(C' option is specified, the creation date of each bucket is also output.
If a bucket name is specified on the command line, all the item keys in that bucket are listed.
If the \*(C`--long\*(C' option is specified, the \s-1ID\s0 and display string of the item owner, the creation date, the \s-1MD5\s0, and the size of the item are also output.
If a bucket name and an item key, seperated by a slash character, is specified on the command line, then the bucket name and the item key are output. This is useful to check that the item actually exists.
If the \*(C`--long\*(C' option is specified, all the \s-1HTTP\s0 attributes of the item are also output. This will include Content-Length, Content-Type, ETag (which is the \s-1MD5\s0 of the item contents), and Last-Modifed.
It may also include the \s-1HTTP\s0 attributes Content-Language, Expires, Cache-Control, Content-Disposition, and Content-Encoding.
It will also include any x-amz- metadata headers.
Report bugs to Mark Atwood [email protected].
Occasionally the S3 service will randomly fail for no externally apparent reason. When that happens, this tool should retry, with a delay and a backoff.
Access to the S3 service can be authenticated with a X.509 certificate, instead of via the \*(L"\s-1AWS\s0 Access Key Identifiers\*(R". This tool should support that.
It might be useful to be able to specify the \*(L"\s-1AWS\s0 Access Key Identifiers\*(R" in the user's \*(C`~/.netrc\*(C' file. This tool should support that.
Errors and warnings are very \*(L"Perl-ish\*(R", and can be confusing.
Trying to access a bucket or item that does not exist or is not accessable by the user generates less than helpful error messages.
This tool does not efficiently handle listing huge buckets, as it downloads and parses the entire bucket listing, before it outputs anything.
This tool does not take advantage of the prefix, delimiter, and hierarchy features of the \s-1AWS\s0 S3 key listing \s-1API\s0.
Written by Mark Atwood [email protected].
Many thanks to Wotan \s-1LLC\s0 <http://wotanllc.com>, for supporting the development of these S3 tools.
Many thanks to the Amazon \s-1AWS\s0 engineers for developing S3.
These tools use the Net::Amazon:S3 Perl module.
The Amazon Simple Storage Service (S3) is documented at <http://aws.amazon.com/s3>.