S3RMBUCKET(1p)

S3RMBUCKET(1p) 💅

okay bestie, so this is a User Contributed Perl Documentation page, and it's literally the manual for s3rmbucket — the lil tool that says bye-bye to your Amazon AWS S3 buckets. 🦋

---

✨ NAME ✨

s3rmbucket — Delete Amazon AWS S3 buckets 💀🪣

---

🌸 SYNOPSIS 🌸

s3rmbucket [options] [bucket ...]

 Options:
   --access-key    AWS Access Key ID
   --secret-key    AWS Secret Access Key
 Environment:
   AWS_ACCESS_KEY_ID
   AWS_ACCESS_KEY_SECRET

---

💖 OPTIONS 💖

• --help — prints a short lil help message and then dips out. 👋
• --man — prints the whole manual page and exits. it's giving "read the syllabus" energy. 📖
• --verbose — Print a message for each created bucket.
• --access-key and --secret-key — these two specify the "AWS Access Key Identifiers" for your AWS account. --access-key is the "Access Key ID", and --secret-key is the "Secret Access Key". ngl, they're basically the "username" and "password" to your AWS account, so keep them confidential, bestie. 🤫🔐

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.

Specifying them on the command line overrides the environment variables. periodt.

• --secure — uses SSL/TLS HTTPS to talk to the AWS service, instead of HTTP. secure girl behavior. 🔒✨
• bucket — one or more bucket names. as many as possible will be deleted. 💅

A bucket may only be deleted if it is empty.

Bucket names must be between 3 and 255 characters long, and can only contain alphanumeric characters, underscore, period, and dash. Bucket names are case sensitive. 🙈

If a bucket name begins with one or more dashes, it might get mistaken for a command line option. If that's the situation, separate the command line options from the bucket names with two dashes, like so:

s3rmbucket --verbose -- --bucketname

---

🌈 ENVIRONMENT VARIABLES 🌈

• AWS_ACCESS_KEY_ID and AWS_ACCESS_KEY_SECRET — specify the "AWS Access Key Identifiers" for the AWS account. AWS_ACCESS_KEY_ID contains the "Access Key ID", and AWS_ACCESS_KEY_SECRET contains the "Secret Access Key". they're effectively the "username" and "password" to the AWS service, so keep them confidential. 🤐

The access keys MUST 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. no cap.

---

🎀 CONFIGURATION FILE 🎀

The configuration options will be read from the file ~/.s3-tools 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 AWS access keys and that a secure connection using HTTPS should be used for all communications. slay. 💅

---

🦋 DESCRIPTION 🦋

Delete buckets in the Amazon Simple Storage Service (S3). A bucket may only be deleted if it is empty. that's the whole vibe. 🪣💥

---

💀 BUGS 💀

Report bugs to Mark Atwood mark@fallenpegasus.com.

• 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 "AWS Access Key Identifiers". This tool should support that.
• It might be useful to be able to specify the "AWS Access Key Identifiers" in the user's ~/.netrc file. This tool should support that.
• Some errors and warnings are very "Perl-ish", and can be confusing. 🙈
• A bucket can only be deleted if it is empty. It might be useful to add an option to delete every item in the bucket before then deleting it, similar to the semantics of the rm -rf dir command. This tool should support that. 🔥

bestie note: all of those are things the tool should do but doesn't (yet). it's a wishlist, not a feature list. don't come for me. 💖

---

👑 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. ⭐

---

🌟 SEE ALSO 🌟

These tools use the Net::Amazon:S3 Perl module.

The Amazon Simple Storage Service (S3) is documented at <http://aws.amazon.com/s3>.

---

and that's the whole page, bestie!! 🎀✨ this came from the perl v5.34.0 docs, dated 2022-06-16, filed under S3RMBUCKET(1p). go delete some empty buckets responsibly, mwah 💋🌈