Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
victorhooi opened this issue Feb 29, 2024 · 3 comments
Closed
Assignees
Labels
documentation This is a problem with documentation.

Comments

@victorhooi
Copy link

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

@victorhooi victorhooi added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Feb 29, 2024
@Redeys
Copy link

Redeys commented Mar 21, 2024

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 tim-finnigan self-assigned this May 17, 2024
@tim-finnigan tim-finnigan added the investigating This issue is being investigated and/or work is in progress to resolve the issue. label May 17, 2024
@tim-finnigan
Copy link
Contributor

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.

@tim-finnigan tim-finnigan closed this as not planned Won't fix, can't repro, duplicate, stale May 17, 2024
@tim-finnigan tim-finnigan removed investigating This issue is being investigated and/or work is in progress to resolve the issue. needs-triage This issue or PR still needs to be triaged. labels May 17, 2024
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation.
Projects
None yet
Development

No branches or pull requests

3 participants