adding CLI examples for App signals #9176

khyathisri · 2024-12-27T07:00:23Z

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

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!

elysahall · 2025-01-22T00:34:58Z

awscli/examples/application-signals/batch-get-service-level-objective-budget-report.rst

+        "Errors": []
+    }
+
+For more information, see `<https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-Application-Monitoring-Sections.html>`__ in the *Amazon CloudWatch User Guide*.


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

elysahall · 2025-01-22T00:35:51Z

awscli/examples/application-signals/create-service-level-objective.rst

+        --description "Description of your SLO" \
+        --sli-config file://sli-config.json
+
+The file ``sli-config`` is a JSON documnet in the current folder.


Suggested change

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

Contents of ``sli-config.json``::

elysahall · 2025-01-22T00:37:04Z

awscli/examples/application-signals/delete-service-level-objective.rst

+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"


Suggested change

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

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

elysahall · 2025-01-22T00:37:39Z

awscli/examples/application-signals/delete-service-level-objective.rst

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


Suggested change

Output::

elysahall · 2025-01-22T00:37:49Z

awscli/examples/application-signals/delete-service-level-objective.rst

+
+Output::
+
+    This command produces no output.


Suggested change

This command produces no output.

This command produces no output.

elysahall · 2025-01-22T00:40:24Z

awscli/examples/application-signals/start-discovery.rst

+
+Output::
+
+    This command produces no output.


Suggested change

This command produces no output.

This command produces no output.

elysahall · 2025-01-22T00:40:47Z

awscli/examples/application-signals/tag-resource.rst

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


Suggested change

Output::

elysahall · 2025-01-22T00:40:52Z

awscli/examples/application-signals/tag-resource.rst

+
+Output::
+
+    This command produces no output.


Suggested change

This command produces no output.

This command produces no output.

elysahall · 2025-01-22T00:41:03Z

awscli/examples/application-signals/untag-resource.rst

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


Suggested change

Output::

elysahall · 2025-01-22T00:41:11Z

awscli/examples/application-signals/untag-resource.rst

+
+Output::
+
+    This command produces no output.


Suggested change

This command produces no output.

This command produces no output.

khyathisri

Hello @elysahall,

I have made the suggested changes, kindly take a look and let me know if any other modifications are required.

Thank you!

elysahall

LGTM

ashovlin

Added a few more comments from the second pass.

ashovlin · 2025-03-19T20:16:21Z

awscli/examples/application-signals/start-discovery.rst

@@ -0,0 +1,11 @@
+**To enable this Amazon Web Services account to be able to use CloudWatch Application Signals**
+
+The following ``start-discovery`` example enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role. ::


Could you italicize the role name like it is on https://docs.aws.amazon.com/applicationsignals/latest/APIReference/API_StartDiscovery.html?

ashovlin · 2025-03-19T20:22:31Z

awscli/examples/application-signals/list-service-level-objectives.rst

+        "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/test",
+        "Name": "test",
+        "CreatedTime": "2024-12-24T22:01:21.116000+05:30"


Could you fix the indentation here for the innermost Arn/Name/CreatedTime?

ashovlin · 2025-03-19T20:23:50Z

awscli/examples/application-signals/list-tags-for-resource.rst

+
+The following ``list-tags-for-resource`` example displays the tags associated with a CloudWatch resource. ::
+
+    aws application-signals list-services \


This command doesn't match the filename or line 3.

ashovlin · 2025-03-19T20:26:58Z

awscli/examples/application-signals/update-service-level-objective.rst

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


Checking my understanding - this isn't actually updating anything, just retaining current values, right?

If so, can we adjust to demonstrate updating one or more properties?

ashovlin · 2025-03-19T20:27:20Z

awscli/examples/application-signals/update-service-level-objective.rst

+
+    {
+        "Slo": {
+        "Arn": "arn:aws:application-signals:us-east-1:123456789101:slo/SLOName",


Please fix indentation throughout.

elysahall self-requested a review January 8, 2025 18:45

elysahall self-assigned this Jan 8, 2025

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

elysahall suggested changes Jan 22, 2025

View reviewed changes

adding CLI examples for App signals

83a57ec

khyathisri force-pushed the app-signals-cli-docs branch from 6ec07c0 to 83a57ec Compare February 9, 2025 10:16

khyathisri commented Feb 9, 2025

View reviewed changes

elysahall approved these changes Mar 6, 2025

View reviewed changes

elysahall assigned ashovlin and unassigned elysahall Mar 6, 2025

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 Mar 6, 2025

ashovlin reviewed Mar 19, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adding CLI examples for App signals #9176

adding CLI examples for App signals #9176

khyathisri commented Dec 27, 2024

elysahall left a comment

elysahall Jan 22, 2025

elysahall Jan 22, 2025

elysahall Jan 22, 2025

elysahall Jan 22, 2025

elysahall Jan 22, 2025

elysahall Jan 22, 2025

elysahall Jan 22, 2025

elysahall Jan 22, 2025

elysahall Jan 22, 2025

elysahall Jan 22, 2025

khyathisri left a comment

elysahall left a comment

ashovlin left a comment

ashovlin Mar 19, 2025

ashovlin Mar 19, 2025

ashovlin Mar 19, 2025

ashovlin Mar 19, 2025

ashovlin Mar 19, 2025

	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.

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

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

	This command produces no output.
	This command produces no output.

		@@ -0,0 +1,11 @@
		To enable this Amazon Web Services account to be able to use CloudWatch Application Signals

		The following ``start-discovery`` example enables this Amazon Web Services account to be able to use CloudWatch Application Signals by creating the AWSServiceRoleForCloudWatchApplicationSignals service-linked role. ::


		The following ``list-tags-for-resource`` example displays the tags associated with a CloudWatch resource. ::

		aws application-signals list-services \

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

adding CLI examples for App signals #9176

Are you sure you want to change the base?

adding CLI examples for App signals #9176

Conversation

khyathisri commented Dec 27, 2024

elysahall left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

khyathisri left a comment

Choose a reason for hiding this comment

elysahall left a comment

Choose a reason for hiding this comment

ashovlin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment