botocore icon indicating copy to clipboard operation
botocore copied to clipboard

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

Open victorhooi opened this issue 2 years ago • 1 comments

Describe the issue

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

  • https://github.com/aws/aws-cli/issues/41
  • https://github.com/aws/aws-cli/issues/4969

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

  • https://github.com/boto/botocore/pull/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 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 avatar Feb 29 '24 02:02 victorhooi

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

Redeys avatar Mar 21 '24 03:03 Redeys