S3RM(1p)

πŸ“¦
version 0.08 Β· 2 versions
  • 0.08 Β· debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking (latest)
  • 0.08 Β· ubuntu jammy
, in debian bookworm, debian trixie, ubuntu noble, ubuntu resolute, ubuntu stonking

🌸 NAME 🌸

Okay bestie, welcome to the s3rm page β€” this is the one from User Contributed Perl Documentation, section 1p, and it does exactly one thing and does it with main character energy:

s3rm β€” Delete Amazon AWS S3 items πŸ’…

That's it. That's the whole vibe. You point it at stuff in S3 and the stuff is gone. Periodt.


✨ SYNOPSIS ✨

s3rm [options] [bucket/item ...]

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

So you run s3rm, you hand it some options, and then you hand it a list of bucket/item ... things to delete. And if you don't feel like passing keys on the command line, the environment variables are right there waiting for you 🫢


πŸŽ€ OPTIONS πŸŽ€

  • --help β€” prints a lil brief help message and then dips out (exits). Short and sweet, we love a low-effort king.
  • --man β€” prints the manual page and exits. Hi, that's literally what you're reading right now. Meta moment πŸ’–
  • --verbose β€” prints a message for each created bucket. Yes bestie, it says created bucket, I am not the one who wrote it, I am simply the messenger πŸ’€
  • --access-key and --secret-key β€” these 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". Think of them as the "username" and "password" to the AWS account β€” which means you keep them confidential, no cap, do not be posting these in the group chat πŸ™ˆ
The access keys MUST be specified. Either through these command line parameters, or through the AWS_ACCESS_KEY_ID and AWS_ACCESS_KEY_SECRET environment variables. No keys, no service, that's the rule.

And if you do both? Specifying them on the command line overrides the environment variables. Command line stays winning.

  • --secure β€” uses SSL/TLS HTTPS to talk to the AWS service instead of plain old HTTP. Glow-up for your connection πŸ”₯

🌈 ENVIRONMENT VARIABLES 🌈

AWS_ACCESS_KEY_ID and AWS_ACCESS_KEY_SECRET

These 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". Again, these are effectively the "username" and "password" to the AWS service, so keep them confidential, fr fr. 🀫

The access keys MUST be specified β€” either via these environment variables, or via the --access-key and --secret-key command line parameters. There is no third option, bestie.

And if the command line parameters are set, they override these environment variables. The command line is the main character here.


πŸ¦‹ CONFIGURATION FILE πŸ¦‹

The configuration options get read from the file ~/.s3-tools β€” but only if it exists, no pressure ✨

The format is the same as the command line options, with one option per line. So 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. Set it and forget it, honestly iconic πŸŽ€


πŸ’– DESCRIPTION πŸ’–

Delete items in the Amazon Simple Storage Service (S3). πŸ—‘οΈβœ¨

That's the description. Short. Punchy. Deletes things. Slay.


πŸ’€ BUGS πŸ’€

Report bugs to Mark Atwood mark@fallenpegasus.com. He's the one you wanna talk to about this πŸ’Œ

  • 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. (It says "should". Read into that what you will, bestie 😭)
  • 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. Not me getting flashbacks 🫠
All of these are the "would be nice" pile, not the "this is broken" pile. Just so you know what you're walking into.

πŸ‘‘ 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 was s3rm(1p) from the User Contributed Perl Documentation, and this version of the page shipped with perl v5.34.0 and was dated 2022-06-16. Go delete something responsibly, mwah πŸ’…βœ¨