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

add examples for CloudWatch CLI commands #9038

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

chaitanyagummadi
Copy link

Issue #, if available:

Description of changes:
Adding example CLI commands for Amazon CloudWatch: https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/

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

@elysahall elysahall added the documentation This is a problem with documentation. label Oct 31, 2024
@elysahall elysahall self-requested a review October 31, 2024 15:34
@elysahall elysahall added the pr:work-in-progress This PR is a draft and needs further work. label Oct 31, 2024
Copy link
Collaborator

@elysahall elysahall left a comment

Choose a reason for hiding this comment

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

LGTM

@elysahall elysahall added pr:needs-review This PR needs a review from a Member. and removed pr:work-in-progress This PR is a draft and needs further work. labels Oct 31, 2024
awscli/examples/cloudwatch/describe-anomaly-detectors.rst Outdated Show resolved Hide resolved
@@ -0,0 +1,34 @@
**To create a contributor insights rule**

The following ``put-insight-rule`` example creates a Contributor Insights rule named ``VPCFlowLogsContributorInsights`` in the specified account. If the command succeeds, no output is returned. ::
Copy link
Member

Choose a reason for hiding this comment

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

nit: Usually the comment that there is no output is after the command with the text "This command produces no output."

Copy link
Author

Choose a reason for hiding this comment

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

Updated the suggestion.

@kdaily kdaily self-assigned this Nov 21, 2024
@kdaily
Copy link
Member

kdaily commented Nov 21, 2024

I will port this to the v2 branch before merging.

@@ -0,0 +1,17 @@
**To create a metric stream**

The following ``put-metric-stream`` example creates a metric stream named ``QuickFull-GuaFb`` in the specified account. ::
Copy link
Member

Choose a reason for hiding this comment

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

Maybe an extra space between the . and the ::.

Copy link
Author

Choose a reason for hiding this comment

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

Confirmed that only 1 space here

--output-format json \
--no-include-linked-accounts-metrics

Output::
Copy link
Member

Choose a reason for hiding this comment

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

Missing a newline here:

Suggested change
Output::
Output::

Copy link
Member

Choose a reason for hiding this comment

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

I think this is causing a couple of the tests failures. Let's resolve this one and I'll check the tests again.

Copy link
Author

Choose a reason for hiding this comment

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

Added new line in the last commit.

* fix the 2 examples
* fix the put-metric-stream API
@codecov-commenter
Copy link

codecov-commenter commented Nov 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 0.08%. Comparing base (52985a2) to head (4304c48).
Report is 101 commits behind head on develop.

Additional details and impacted files
@@            Coverage Diff             @@
##           develop   #9038      +/-   ##
==========================================
- Coverage     0.08%   0.08%   -0.01%     
==========================================
  Files          210     210              
  Lines        16952   16978      +26     
==========================================
  Hits            14      14              
- Misses       16938   16964      +26     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

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. pr:needs-review This PR needs a review from a Member.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants