Skip to content

CLI examples for ec2, elasticache, globalaccelerator, kms, securityhu…#6192

Merged
kyleknap merged 2 commits intoaws:developfrom
elysahall:awsdocs-05-25
May 28, 2021
Merged

CLI examples for ec2, elasticache, globalaccelerator, kms, securityhu…#6192
kyleknap merged 2 commits intoaws:developfrom
elysahall:awsdocs-05-25

Conversation

@elysahall
Copy link
Copy Markdown
Contributor

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 27, 2021

Codecov Report

Merging #6192 (cc5c1b7) into develop (fc3296a) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #6192   +/-   ##
========================================
  Coverage    93.05%   93.05%           
========================================
  Files          204      204           
  Lines        16201    16201           
========================================
  Hits         15076    15076           
  Misses        1125     1125           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fc3296a...cc5c1b7. Read the comment docs.

Copy link
Copy Markdown
Contributor

@kyleknap kyleknap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Just had some comments about line breaks

--output text \
Before running this command, replace the example key ID with a valid key ID from your AWS account. ::

aws kms decrypt ^
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if ^ character is appropriate here? I'd assume we would want the \ instead for line break

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Talked offline the characters are for command prompt. I did not see the title of the example. We can ignore my comment.


aws kms re-encrypt ^
--ciphertext-blob fileb://ExampleEncryptedFile ^
--source-key-id 1234abcd-12ab-34cd-56ef-1234567890ab ^
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same thing here. I think we would want to be using \ instead of ^

Comment thread awscli/examples/kms/decrypt.rst Outdated
--output text ^
--query Plaintext > ExamplePlaintextFile.base64

Run the ''certutil'' command. ::
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We probably should be using `` instead of '' to enclose certutil to make a code literal

Comment thread awscli/examples/ssm/list-documents.rst Outdated

The following ``list-documents`` example lists shared documents, including private shared documents not owned by AWS. ::

aws ssm list-documents /
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need to change this from a / to a \

The following ``batch-import-findings`` example updates a finding. ::

aws securityhub batch-import-findings \
aws securityhub batch-import-findings
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we want to remove the backslash here since the --findings parameter is on a new line.

Copy link
Copy Markdown
Contributor

@kyleknap kyleknap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! 🚢

@kyleknap kyleknap merged commit 1a13998 into aws:develop May 28, 2021
@elysahall elysahall deleted the awsdocs-05-25 branch August 26, 2022 22:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants