boto / botocore

The low-level, core functionality of boto3 and the AWS CLI.
Apache License 2.0
1.44k stars 1.06k forks source link

Fix wrong documentation in ec2 import-key-pair around base64 encoding #3130

Closed victorhooi closed 1 month ago

victorhooi commented 4 months ago

Describe the issue

This is related to the below two issues against aws-cli:

There seems to be a documentation bug in botocore - I filed a very small PR to fix it:

However, I just re-read the CONTRIBUTING.md - it seems the preference is to file issues to fix these upstream (which I assume is AWS internal).

The PR should be self-explanatory - but specifically, can we update the documentation to remove the sentence:

For command line tools, base64 encoding is performed for you. (Which is no longer accurate with AWS CLI V2).

And replace with a reference to using the fileb:// URI please?

Links

https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/import-key-pair.html

Redeys commented 3 months ago

Describe the issue This is related to the below two issues against aws-cli:

Fix ec2 import-key-pair aws/aws-cli#41 ec2 import-key-pair issue aws/aws-cli#4969 There seems to be a documentation bug in botocore - I filed a very small PR to fix it:

Fix documentation for ec2 import-key-pair for how to properly base64-encode keyfiles #3129 However, I just re-read the CONTRIBUTING.md - it seems the preference is to file issues to fix these upstream (which I assume is AWS internal).

The PR should be self-explanatory - but specifically, can we update the documentation to remove

tim-finnigan commented 1 month ago

Thanks for reaching out and for your patience. As you mentioned, changes to the service documentation would need to be implemented upstream. To send suggestions for APIs like ImportKeyPair, you can use the Provide feedback at the bottom of the API documentation page.

But it looks like handling base64 commands is already mentioned here in the AWS CLI documentation for the EC2 import-key-pair command: https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/import-key-pair.html

image

And in the example on that page which uses fileb://:

image

If you'd like to submit feedback specific to the CLI command reference, please use the Give us feedback on the sidebar.

github-actions[bot] commented 1 month ago

This issue is now closed. Comments on closed issues are hard for our team to see. If you need more assistance, please open a new issue that references this one.