Let's document: aws

[Waples]

• accessanalyzer →
• acm →
• acm-pca →
• alexaforbusiness →
• amplify →
• amplifybackend →
• apigateway →
• apigatewaymanagementapi →
• apigatewayv2 →
• appconfig →
• appflow →
• appintegrations →
• application-autoscaling →
• application-insights →
• appmesh →
• appstream →
• appsync →
• athena →
• auditmanager →
• autoscaling →
• autoscaling-plans →
• backup → aws-backup: add page #9369
• batch → aws-batch: add page #10570, aws-batch: add page #10591
• braket →
• budgets →
• ce →
• chime →
• cloud9 → aws-cloud9: add page #10627
• clouddirectory
• cloudformation → aws-cloudformation: add page #10116
• cloudfront →
• cloudhsm →
• cloudhsmv2 →
• cloudsearch →
• cloudsearchdomain →
• cloudtrail →
• cloudwatch → aws-cloudwatch: add page #10614
• codeartifact → aws codeartifact: add page; pt_BR translation #11224
• codebuild →
• codecommit → aws-codecommit: add page #9202
• codeguru-reviewer →
• codeguruprofiler →
• codepipeline →
• codestar →
• codestar-connections →
• codestar-notifications →
• cognito-identity →
• cognito-idp → aws-cognito-idp: add page #9032
• cognito-sync →
• comprehend →
• comprehendmedical →
• compute-optimizer →
• configservice →
• configure → aws-configure: add page #8808
• connect →
• connect-contact-lens →
• connectparticipant →
• cur → aws-cur: add page #6133
• customer-profiles →
• databrew →
• dataexchange →
• datapipeline →
• datasync →
• dax →
• deploy →
• detective →
• devicefarm →
• devops-guru →
• directconnect →
• discovery →
• dlm →
• dms →
• docdb →
• ds →
• dynamodb → aws-dynamodb: add page #11570
• dynamodbstreams →
• ebs →
• ec2 →
• ec2-instance-connect →
• ecr → aws-ecr: add page #6134
• ecr-public →
• ecs → aws-ec2: add page #4661
• efs →
• eks → aws-eks: add page #11577
• elastic-inference →
• elasticache →
• elasticbeanstalk →
• elastictranscoder →
• elb →
• elbv2 →
• emr →
• emr-containers →
• es →
• events →
• firehose →
• fms →
• forecast →
• forecastquery →
• frauddetector →
• fsx →
• gamelift →
• glacier →
• globalaccelerator →
• glue → aws-glue: add page #4740
• greengrass →
• groundstation →
• guardduty →
• health →
• healthlake →
• help → aws-help: add page #6446
• history → aws-history: add page #8805
• honeycode →
• iam → aws-iam: add page #4662
• identitystore →
• imagebuilder →
• importexport →
• inspector →
• iot →
• iot-data →
• iot-jobs-data →
• iot1click-devices →
• iot1click-projects →
• iotanalytics →
• iotevents →
• iotevents-data →
• iotsecuretunneling →
• iotsitewise →
• iotthingsgraph →
• ivs →
• kafka → aws-kafka: add page #11696
• kendra →
• kinesis → aws-kinesis: add page #4510
• kinesis-video-archived-media →
• kinesis-video-media →
• kinesis-video-signaling →
• kinesisanalytics →
• kinesisanalyticsv2 →
• kinesisvideo →
• kms →
• lakeformation →
• lambda → aws-lambda: add page #4774
• lex-models
• lex-runtime
• license-manager
• lightsail → aws-lightsail: add page #8934
• logs →
• lookoutvision →
• machinelearning →
• macie →
• macie2 →
• managedblockchain →
• marketplace-catalog →
• marketplace-entitlement →
• marketplacecommerceanalytics →
• mediaconnect →
• mediaconvert →
• medialive →
• mediapackage →
• mediapackage-vod →
• mediastore →
• mediastore-data →
• mediatailor →
• meteringmarketplace →
• mgh →
• migrationhub-config →
• mobile →
• mq →
• mturk →
• mwaa →
• neptune →
• network-firewall →
• networkmanager →
• opsworks →
• opsworks-cm →
• organizations →
• outposts →
• personalize →
• personalize-events →
• personalize-runtime →
• pi →
• pinpoint →
• pinpoint-email →
• pinpoint-sms-voice →
• polly →
• pricing → aws-pricing: add page #8804
• qldb →
• qldb-session →
• quicksight
• ram →
• rds → aws-rds: add page #6547
• rds-data →
• redshift →
• redshift-data →
• rekognition →
• resource-groups →
• resourcegroupstaggingapi →
• robomaker →
• route53 → aws-route53: add page #8606
• route53domains →
• route53resolver →
• s3 (This command has a separate issue page Let's document: aws s3 #8406 to track it's subcommands)
• s3api → aws-s3api: add page #6132
• s3control →
• s3outposts →
• sagemaker →
• sagemaker-a2i-runtime →
• sagemaker-edge →
• sagemaker-featurestore-runtime →
• sagemaker-runtime →
• savingsplans →
• schemas →
• sdb →
• secretsmanager → aws-secretsmanager: add page #6131
• securityhub →
• serverlessrepo →
• service-quotas →
• servicecatalog →
• servicecatalog-appregistry →
• servicediscovery →
• ses → aws-ses: add page #7136
• sesv2 →
• shield →
• signer →
• sms →
• snowball →
• sns → aws-sns: add page #12259
• sqs → aws-sqs: add page #9085
• ssm →
• sso →
• sso-admin →
• sso-oidc →
• stepfunctions →
• storagegateway →
• sts → aws-sts: add page #8669
• support →
• swf →
• synthetics →
• textract →
• timestream-query →
• timestream-write →
• transcribe →
• transfer →
• translate →
• waf →
• waf-regional →
• wafv2 →
• workdocs →
• worklink →
• workmail → aws-workmail: add page #9058
• workmailmessageflow →
• workspaces →
• xray →

[Waples]

@bl-ue whenever you are bored :P #HelpWanted :p

[bl-ue]

Haha @Waples did you happen to see this: #5212?

[bl-ue]

@Waples it looks like you might have removed all occurences of the letter o in the above command list 😄, e.g. alexafrbusiness, wrkmailmessageflw, applicatin-autscaling

[Waples]

@Waples it looks like you might have removed all occurences of the letter o in the above command list , e.g. alexafrbusiness, wrkmailmessageflw, applicatin-autscaling

Owh haha, think i was a bit too agressive with my %s/\so^/g ish replace then xD will fix that in a second @bl-ue

[Waples]

Fixed it =D

[Waples]

@bl-ue didn't see that issue before, but that goes in a bit too deep with ALL the commands.
I was thinking more like, for example aws-ec2.md.

[bl-ue]

You're right, that's why I closed it. But I wanted to link it for reference 👍🏻

[Waples]

I'm gonna make some time today to add at least 15 examples, but I don't know what the best course of action is, a seperate branch for every page added or in one big PR ?
@bl-ue what ya want

[bl-ue]

The former @Waples. Please open 1 PR per new page. It makes it easier to review the changes.

It would certainly be great if we could document all of the aws subcommands—I'd say they're probably looked for often 🤷🏻

[Waples]

Organization status, here I come. xD

[Waples]

I'd say they're probably looked for often 🤷🏻
sounds a bit sarcastic xD

[bl-ue]

Haha no I wasn't intended to be sarcastic actually :)

[sbrl]

Oh wow, that's an enormous list @Waples! I'd suggest starting small, and opening just 1 or 2 PRs for 1 or 2 pages at a time to get used to the tldr page syntax if you haven't already got experience with the review process.

[258204]

Starting one on secrets manager now.

[258204]

Starting s3api and cur

[258204]

Might do ecs and eks next, everyone loves container orchestration.

[bl-ue]

And do ecr — I'm going to upload some Docker images to ECR just today, and it would be cool to know how to use aws ecr! 🙂

[258204]

I will start on ecr first then.

[258204]

It's a spiderweb. You need a tldr of docker-login for a tldr or aws ecr.

[258204]

This actually brings up an important question.
The authoritative documentation is more complete (eg. https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/index.html), however, the quick start guide https://docs.aws.amazon.com/AmazonECR/latest/userguide/ is much more useful to get to know a new tool. It would deviate from the standard, but pages that include both would be more useful.

[258204]

Also need to add a short one for docker-tag

[258204]

And docker-image....

DOCUMENT ALL THE THINGS!!! :D

[bl-ue]

Hmm, I'm not really sure. The first page does provide a lot more information directly related to the CLI (36 addition subcommands). The second page is tuned for beginners but isn't actually about the CLI.

I'm probably inclined to keep the first link, because it seems like a user who goes to that link might be looking for more info on how to use the tool itself, but there's equal argument for both links, so I'm chasing my own tail here. 😅

[258204]

The second link mirrors the same steps for cli and gui.

[sbrl]

I would suggest that for more information links subpages of https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/index.html (e.g. https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ecr/get-lifecycle-policy-preview.html) are more directly relevant to each individual page.

The generic user guide looks useful, but not specifically to the aws subcommand being documented.

[piraces]

aws configure #8808

[bryanmg]

Hi! I'll work on sqs command file

[bryanmg]

aws-sqs: add page #9085

[Waples]

Thank you @piraces @bryanmg for all your work!

[Waples]

Note to self: check if the list still up to date with the v2 (and beta v3) version of aws-cli

[the0001]

First timer trying to help.

aws-batch: add page #10591

[the0001]

aws-cloudwatch: add page #10614

[the0001]

aws-cloud9: add page #10627

[Sourav-Kumar-Panda]

Can I work on this?

[kbdharun]

Can I work on this?

Sure

[Sourav-Kumar-Panda]

I am new to open source, could you please guide me? and what are the things I should follow in order to solve this issue

[nkzren]

I'm new. Can I help?

aws-codeartifact: add page #11224

[sbrl]

Hey, @Sourav-Kumar-Panda, @nkzren! You don't need to ask - just open a pull request with a new page :-)

[Waples]

Update from myself: I might do some work with Sagemaker in the near future (on boto3 level), so I might document something for those items.

[Sourav-Kumar-Panda]

Hey, @Waples , please check the PR #11570

[Sourav-Kumar-Panda]

aws-eks: add page. #11577

[sebastiaanspeck]

When looking at https://docs.aws.amazon.com/cli/latest/, there is a note about a new CLI version:

Note

You are viewing the documentation for an older major version of the AWS CLI (version 1).
AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here.

Should we update the pages to match the new version?

[kbdharun]

Should we update the pages to match the new version?

Yeah, we should also check for any changed syntax and update it (if a subcommand/flag got deprecated we should mention it is only available in v1).

[sbrl]

Don't forget to reference this PR's number in any PRs you open @sebastiaanspeck :-)

[gauravcodepro]

@Waples adding this to the aws terraform. Writing the aws terraform initator files: https://github.com/sablokgaurav/hashicorp_instance_initiator/blob/main/terraform_aws.sh for merging into the tldr pages.

[Waples]

Just as an FYI, I have been ill / busy for a long while, but I do still weekly check how the process is going. Thank you all for giving you're time to fill the stupidly long list of items.

I will be more aware of ongoing work / MR/PRs etc from now on again, now my health has improved (beware xD).

[sebastiaanspeck]

Just as an FYI, I have been ill / busy for a long while, but I do still weekly check how the process is going. Thank you all for giving you're time to fill the stupidly long list of items.

I will be more aware of ongoing work / MR/PRs etc from now on again, now my health has improved (beware xD).

Good to have you back! :D

[Waples]

Just as an FYI, I have been ill / busy for a long while, but I do still weekly check how the process is going. Thank you all for giving you're time to fill the stupidly long list of items.
I will be more aware of ongoing work / MR/PRs etc from now on again, now my health has improved (beware xD).

Good to have you back! :D

thanks bruv ^^ feeling allot better now. Lets document some stuff haha

[Waples]

At the time of writing, I don't even know myself anymore if this list is complete and compatible with v3 (and v4-beta).

Note to self: investigate this.

And again, thank you all for helping with this massive project.

// Florian