EC2-DESCRIBE-SNAPSHOTS(1)

📦 version 1.6.14.1, in ubuntu jammy, ubuntu noble

✨ EC2-DESCRIBE-SNAPSHOTS ✨

okay bestie so this is a page from the EC2 API command line tools manual — section 1, User Commands, iykyk — and it's literally all about ec2-describe-snapshots, aka ec2dsnap. let's get into it 💖

🌸 NAME 🌸

ec2-describe-snapshots — describe snapshots. that's it. that's the name. iconic, concise, we love her 👑

🎀 SYNOPSIS 🎀

 ec2dsnap ([ec2-describe-snapshots])
 ec2dsnap [GENERAL OPTIONS] [SNAPSHOT [...]] [-a] [-o OWNER [...]] [-r
USER [...]]

so yeah, you can call her ec2dsnap, you can call her ec2-describe-snapshots, she answers to both 💅

🦋 GENERAL NOTES 🦋

  • any command option/parameter can be handed a value of - — and that means "bestie, read the values for this option from stdin instead". handy af. 🍓

💜 DESCRIPTION 💜

okay so what does she actually do? she lists and describes snapshots you made before, plus any snapshots you have CreateVolume permissions for. yes ma'am. 🔥

  • the SNAPSHOT parameters, if you specify them, list the specific snapshot(s) you want described. ✨
  • if you pass no parameters at all, she describes all snapshots owned by you, or explicitly shared with you. no cap.
  • with parameters, the result set is the intersection of: the snapshots explicitly named, the snapshots owned by the specified owner(s), and the snapshots with CreateVolume permissions as specified. intersection. like a venn diagram. 🫶

Examples — the -o / -r combo lore 📖:

  • -o self, -r self or <null> → only your snapshots
  • -o self, -r all → snapshots you have shared publicly
  • -o self, -r <userid> → snapshots you have shared with <userid>
  • -o <userid>, -r self → snapshots <userid> has shared with you
  • -o <userid>, -r all → snapshots <userid> has shared publicly
  • -o <userid>, -r <null> → snapshots <userid> has shared publicly or with you
  • -o <null>, -r self → your snapshots and snapshots any other user has shared with you
  • -o <null>, -r all → all public snapshots
  • -o <null>, -r <null> → your snapshots, public snapshots, and any other snapshots shared with you

✨ GENERAL OPTIONS ✨

the whole squad of shared flags, periodt:

  • -O, --aws-access-key KEY — AWS Access Key ID. defaults to whatever the AWS_ACCESS_KEY environment variable is (if it's set). 🔑
  • -W, --aws-secret-key KEY — AWS Secret Access Key. defaults to the AWS_SECRET_KEY environment variable (if set). 🤫
  • -T, --security-token TOKEN — AWS delegation token. defaults to the AWS_DELEGATION_TOKEN environment variable (if set). 🎟️
  • -K, --private-key KEY — [DEPRECATED] specify KEY as the private key to use. defaults to the value of the EC2_PRIVATE_KEY environment variable (if set). overrides the default. ⚠️ girl she's deprecated, proceed accordingly
  • -C, --cert CERT — [DEPRECATED] specify CERT as the X509 certificate to use. defaults to the value of the EC2_CERT environment variable (if set). overrides the default. ⚠️ also deprecated, just so you know
  • -U, --url URL — specify URL as the web service URL to use. defaults to the value of https://ec2.amazonaws.com (us-east-1) or to that of the EC2_URL environment variable (if set). overrides the default. 🌐
  • --region REGION — specify REGION as the web service region to use. this option will override the URL specified by the -U URL option and the EC2_URL environment variable. it defaults to the region specified by the EC2_URL environment variable, or us-east-1 if that environment variable is not set. 🗺️
  • -D, --auth-dry-run — check if you can perform the requested action instead of actually performing it. a little vibe check, not a commitment. 🧚
  • -v, --verbose — verbose output. she will overshare. 💬
  • -?, --help — display this help. hi, this is her. 👋
  • -H, --headers — display column headers. 👑
  • --debug — display additional debugging information. 🔍
  • --show-empty-fields — indicate empty fields. 🙈
  • --hide-tags — do not display tags for tagged resources. 🏷️
  • --connection-timeout TIMEOUT — specify a connection timeout TIMEOUT (in seconds). ⏳
  • --request-timeout TIMEOUT — specify a request timeout TIMEOUT (in seconds). ⌛

🎀 SPECIFIC OPTIONS 🎀

the main-character flags, just for snapshots 💖:

  • -a, --all — describe all snapshots, public, private or shared, to which you have access. everything. the whole buffet. 🍽️
  • -o, --owner OWNER — only snapshots owned by the specified users are described. OWNER may be:
    • a user's account id — for snapshots owned by that user,
    • 'self' — for snapshots owned by you, or
    • 'amazon' — for snapshots owned by Amazon.
  • -r, --restorable-by USER — only snapshsots with restorable permissions as specified are described. USER may be any of the following: (yes bestie the original really does say "snapshsots", we're keeping it, no notes 😭*)*
    • a user's account id
      • snapshots owned by you for which you have granted explicit CreateVolume permissions to that user.
    • self
      • snapshots for which you have explicit CreateVolume permissions
    • all
      • snapshots with public CreateVolume permissions.
  • -F, --filter FILTER — add a filter criterion for the result-set. 🧃

🌈 SEE ALSO 🌈

go read the lore, bestie:

💀 quick reminder: those -K and -C flags are DEPRECATED. i'm not saying don't, i'm saying she's deprecated and i'm telling you she's deprecated. 🫶

okay that's the whole page, we ate and left no crumbs 💅✨ this was the EC2 API command line tools, version 1.6.14.1, api=2014-05-01 — stan forever, bye bestie! 💖🎀🦋🌸

📦 where this page comes from