Examples edit #6
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Modified explanation text. Removed 'alias/' from sentence beginning "Alias names must begin with..." to line up with wording in our documentation [1]. Removed the reference to the Decrypt API operation as this is not related to modifying an alias [2]. [1] https://docs.aws.amazon.com/awscloudtrail/latest/userguide/KMS-key-naming-requirements.html [2] https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html
Set windows examples to use double quotation marks enclosing any text in the command syntax (such as the plaintext value or encryption context passed inline). Single quotes won't work. Confirming *nix examples work fine. Please retest Windows examples to validate my changes.
Modified Windows example to wrap inline text in double quotation marks.
Modified Windows examples to wrap all text in double quotation marks. Also, I can't make the example $plaintext=$(aws kms decrypt --ciphertext-blob fileb://encryptedDataKey --query Plaintext --output text | base64 --decode) work. I feel like it should be using an alias and be wrapped in quotation marks like: alias plaintext='aws kms decrypt --ciphertext-blob fileb://encryptedDataKey --query Plaintext --output text | base64 --decode' ...but I'm not an expert with bash. Can we confirm if that is correct? The modified example works for me.
In addition to wrapping inline text in double quotation marks for Windows, I also needed to remove the "$" symbol from the command substitution example. It should look like this: plaintext=$(aws kms decrypt --ciphertext-blob fileb://encryptedDataKey --query Plaintext --output text | base64 --decode) You should then be able to view the content of that value: echo $plaintext
Wrapped Windows examples inline text into double quotation marks. Removed dollar from variable declaration in Step 5.
Update generate-data-key.rst
Update create-alias.rst
Update encrypt.rst
Update generate-data-key-without-plaintext.rst
Update decrypt.rst
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is my pull request.