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

adding CLI examples for App signals #9176

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

Conversation

khyathisri
Copy link

Issue #, if available:

Description of changes:

Adding CLI examples for Application signals

https://docs.aws.amazon.com/cli/latest/reference/application-signals/#cli-aws-application-signals

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 self-requested a review January 8, 2025 18:45
@elysahall elysahall self-assigned this Jan 8, 2025
@elysahall elysahall added documentation This is a problem with documentation. pr:work-in-progress This PR is a draft and needs further work. labels Jan 8, 2025
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.

Hi @khyathisri
Thank you for your command example submission! There were some formatting issues that need to be resolved before I can send for maintainer review.

Please fix all requested formatting issues, and be sure to fix your links in every file, and push your updates for a second review.

Thanks!

"Errors": []
}

For more information, see `<https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
For more information, see `<https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.
For more information, see `Application Signals <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.

All your for more information links are missing the title portion of the formatting and are therefore display broken. Please fix the URLs in all your submitted files to the following format:

`This is the topic title <https://link.to.the/topic/page>`__

https://aws.github.io/aws-cli/docs_styleguide.html#for-more-information-link

--description "Description of your SLO" \
--sli-config file://sli-config.json

The file ``sli-config`` is a JSON documnet in the current folder.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
The file ``sli-config`` is a JSON documnet in the current folder.
Contents of ``sli-config.json``::

The following ``delete-service-level-objective`` example deletes the specified service level objective. ::

aws application-signals delete-service-level-objective \
--id "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
--id "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName"
--id "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName"

aws application-signals delete-service-level-objective \
--id "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName"

Output::
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Output::


Output::

This command produces no output.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This command produces no output.
This command produces no output.


Output::

This command produces no output.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This command produces no output.
This command produces no output.

-—resource-arn "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" \
-—tags '{"Key":"test","Value":"value"}'

Output::
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Output::


Output::

This command produces no output.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This command produces no output.
This command produces no output.

-—resource-arn "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName" \
-—tag-keys "test"

Output::
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Output::


Output::

This command produces no output.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This command produces no output.
This command produces no output.

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:work-in-progress This PR is a draft and needs further work.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants