Net::A...:Tools(3pm)

💖 Net::Amazon::S3::Tools 💖

okay so bestie, welcome to your new fave lil corner of the perl docs — this is the page for Net::Amazon::S3::Tools, from the User Contributed Perl Documentation, man section 3pm. it's giving "tiny module, huge energy" ✨

---

🌸 NAME 🌸

Net::Amazon::S3::Tools — command line tools for Amazon S3

like, that's it. that's the whole name. short. iconic. no notes. 💅

---

✨ SYNOPSIS ✨

  s3acl [options] [[bucket|bucket/key] ...]
  s3ls [options]
  s3ls [options] [ bucket/item ... ]
  s3get [options] [ bucket/item ... ]
  s3put [options] [ bucket/item ... ]
  s3mkbucket [options] [ bucket ... ]
  s3rmbucket [options] [ bucket ... ]

six whole lil tools and they're all right here living their best lives 🦋

---

🔥 OPTIONS 🔥

every single one of these tools has its own special command line options, but they ALSO all share some common ones, and the common ones are what we're describing right here — together, as a group chat. 🫶

• --help — prints a brief help message and then dips out. exits. bye. 👋
• --man — prints the manual page and exits. (hi, that's this. you're literally inside the man page rn. 🎀)
• --verbose — outputs what is being done as it is being done. very "narrating my own life" of it.
• --access-key and --secret-key — these specify the "AWS Access Key Identifiers" for the AWS account. --access-key is the "Access Key ID", and --secret-key is the "Secret Access Key". lowkey these are basically the "username" and "password" to the AWS account, so keep them CONFIDENTIAL, bestie. do not be posting these anywhere. 🙈
  • the access keys MUST be specified, either via these command line parameters, or via the AWS_ACCESS_KEY_ID and AWS_ACCESS_KEY_SECRET environment variables. no key, no vibes.
  • specifying them on the command line overrides the environment variables. command line stays winning. 👑
• --secure — uses SSL/TLS HTTPS to communicate with the AWS service, instead of HTTP. secure the bag. 💜✨

---

🌈 DESCRIPTION 🌈

these S3 command line tools let you manipulate and populate an S3 account. for the deets on each individual tool, go read the documentation (pod and man) for that specific tool — each one has its own moment. 💖

this Net::Amazon::S3::Tools module is mostly just a stub, and honestly? it said "I'm not the main character, I'm the stage manager." its whole job is to hoist the bundling and installation of the executable scripts that make up the actual tools. supporting role, but it ate. 🎬

---

💀 BUGS 💀

report bugs to Mark Atwood mark@fallenpegasus.com.

okay so the real tea:

• occasionally the S3 service will randomly fail for no externally apparent reason 😭 when that happens, these tools should retry, with a delay and a backoff. (should. as in, that's the wishlist. not a promise.)
• access to the S3 service can be authenticated with a X.509 certificate, instead of via the "AWS Access Key Identifiers". these tools should support that too.
• it might be useful to be able to specify the "AWS Access Key Identifiers" in the user's ~/.netrc file. these tools should support that as well.
• errors and warnings are very "Perl-ish", and can be confusing. ngl bestie, they really can. 💅

---

🔍 SEE ALSO 🔍

• these tools use the Net::Amazon::S3 Perl module.
• the Amazon Simple Storage Service is documented at http://aws.amazon.com/s3.
• these tools are hosted at http://fallenpegasus.com/code/s3-tools.

---

👑 AUTHOR 👑

written by Mark Atwood mark@fallenpegasus.com.

many thanks to Wotan LLC http://wotanllc.com, for supporting the development of these S3 tools. 🫶

many thanks to the Amazon AWS engineers for developing S3. absolute legends, no cap.

---

🎀 COPYRIGHT AND LICENSE 🎀

Copyright (C) 2007,2008 by Mark Atwood

this module is not an official Amazon product or service. information used to create this module was obtained only from publicly available information, mainly from the published Amazon documentation. (transparency queen. we love to see it.)

This module is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 2.1 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License and the GNU Lesser General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

---

and that's the whole page, bestie!! 💖✨ this one came from perl v5.34.0, dated 2022-06-16, and the page itself is Net::A...:Tools(3pm) — go forth and s3 responsibly. mwah. 🎀🦋💅