Add CLI examples for CloudWatch OAM #8971

ashishbharadwajm · 2024-10-14T07:24:03Z

Issue #, if available:

Description of changes:

Adding example CLI commands for Amazon CloudWatch Observability Access Manager: https://docs.aws.amazon.com/cli/latest/reference/oam/

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

elysahall · 2024-10-30T19:10:07Z

awscli/examples/oam/delete-link.rst

+
+    aws oam delete-link \
+        --identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111
+


There is a missing output section. If this command produces no output please add the appropriate line.
https://aws.github.io/aws-cli/docs_styleguide.html#output

elysahall · 2024-10-30T19:10:15Z

awscli/examples/oam/delete-sink.rst

+
+    aws oam delete-sink \
+        --identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345
+


Same here. There is a missing output section. If this command produces no output please add the appropriate line.
https://aws.github.io/aws-cli/docs_styleguide.html#output

elysahall · 2024-10-30T19:10:38Z

awscli/examples/oam/get-link.rst

+        ],
+        "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
+        "Tags": {}
+}


Suggested change

}

}

elysahall · 2024-10-30T19:11:02Z

awscli/examples/oam/get-sink-policy.rst

+        "SinkArn": "arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345",
+        "SinkId": "a1b2c3d4-5678-90ab-cdef-example12345",
+        "Policy": "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789111:root\"},\"Action\":[\"oam:CreateLink\",\"oam:UpdateLink\"],\"Resource\":\"*\",\"Condition\":{\"ForAllValues:StringEquals\":{\"oam:ResourceTypes\":[\"AWS::Logs::LogGroup\",\"AWS::CloudWatch::Metric\",\"AWS::XRay::Trace\",\"AWS::ApplicationInsights::Application\"]}}}]}"
+}


Suggested change

}

}

elysahall · 2024-10-30T19:14:42Z

awscli/examples/oam/put-sink-policy.rst

+The following ``put-sink-policy`` example creates or updates the resource policy that grants permissions to source accounts to link to the monitoring account sink. ::
+
+    aws oam put-sink-policy \
+        --policy "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789111:root\"},\"Action\":[\"oam:CreateLink\",\"oam:UpdateLink\"],\"Resource\":\"*\",\"Condition\":{\"ForAllValues:StringEquals\":{\"oam:ResourceTypes\":[\"AWS::Logs::LogGroup\",\"AWS::CloudWatch::Metric\",\"AWS::XRay::Trace\",\"AWS::ApplicationInsights::Application\"]}}}]}" \


Suggested change

--policy "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789111:root\"},\"Action\":[\"oam:CreateLink\",\"oam:UpdateLink\"],\"Resource\":\"*\",\"Condition\":{\"ForAllValues:StringEquals\":{\"oam:ResourceTypes\":[\"AWS::Logs::LogGroup\",\"AWS::CloudWatch::Metric\",\"AWS::XRay::Trace\",\"AWS::ApplicationInsights::Application\"]}}}]}" \

--policy '{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789111:root"},"Action":["oam:CreateLink","oam:UpdateLink"],"Resource":"*","Condition":{"ForAllValues:StringEquals":{"oam:ResourceTypes":["AWS::Logs::LogGroup","AWS::CloudWatch::Metric","AWS::XRay::Trace","AWS::ApplicationInsights::Application"]}}}]}' \

elysahall · 2024-10-30T19:17:19Z

awscli/examples/oam/tag-resource.rst

+
+    aws oam tag-resource \
+        --resource-arn arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345 \
+        --tags team=Devops


Suggested change

--tags team=Devops

--tags team=Devops

This command produces no output.

elysahall · 2024-10-30T19:17:33Z

awscli/examples/oam/tag-resource.rst

@@ -0,0 +1,9 @@
+**To Assign one or more tags to the specified resource**
+
+The following ``tag-resource`` example tags a sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``. If the command succeeds, no output is returned. ::


Suggested change

The following ``tag-resource`` example tags a sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``. If the command succeeds, no output is returned. ::

The following ``tag-resource`` example tags a sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``. ::

elysahall · 2024-10-30T19:18:22Z

awscli/examples/oam/untag-resource.rst

+
+    aws oam untag-resource \
+        --resource-arn arn:aws:oam:us-east-2:123456789012:sink/f3f42f60-f0f2-425c-1234-12347bdd821f \
+        --tag-keys team


Suggested change

--tag-keys team

--tag-keys team

This command produces no output.

elysahall · 2024-10-30T19:18:36Z

awscli/examples/oam/untag-resource.rst

@@ -0,0 +1,9 @@
+**To Removes one or more tags from the specified resource.**
+
+The following ``untag-resource`` example removes a tag with the key ``team`` from Sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``. If the command succeeds, no output is returned. ::


Suggested change

The following ``untag-resource`` example removes a tag with the key ``team`` from Sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``. If the command succeeds, no output is returned. ::

The following ``untag-resource`` example removes a tag with the key ``team`` from Sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``. ::

elysahall

Missed a double colon causing incorrect rendering. Thanks!

elysahall · 2024-11-13T17:56:15Z

awscli/examples/oam/untag-resource.rst

@@ -0,0 +1,11 @@
+**To Remove one or more tags from the specified resource.**
+
+The following ``untag-resource`` example removes a tag with the key ``team`` from Sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``.


Suggested change

The following ``untag-resource`` example removes a tag with the key ``team`` from Sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``.

The following ``untag-resource`` example removes a tag with the key ``team`` from Sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``. ::

Published the new commit with suggested changes

Add CLI examples for CloudWatch OAM

4b704ad

elysahall self-assigned this Oct 14, 2024

elysahall added the documentation This is a problem with documentation. label Oct 14, 2024

elysahall self-requested a review October 14, 2024 16:18

elysahall added the pr:work-in-progress This PR is a draft and needs further work. label Oct 30, 2024

elysahall suggested changes Oct 30, 2024

View reviewed changes

ashishbharadwajm added 5 commits October 31, 2024 14:58

Add CLI examples for CloudWatch OAM-v2

1740421

Add CLI examples for CloudWatch OAM-v3

c0f1314

Add CLI examples for CloudWatch OAM-v5

8590e50

Add CLI examples for CloudWatch OAM-v6

9440853

Add CLI examples for CloudWatch OAM-v7

ece0961

elysahall suggested changes Nov 13, 2024

View reviewed changes

Add CLI examples for CloudWatch OAM-v8

d576431

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add CLI examples for CloudWatch OAM #8971

Add CLI examples for CloudWatch OAM #8971

ashishbharadwajm commented Oct 14, 2024

elysahall Oct 30, 2024

elysahall Oct 30, 2024

elysahall Oct 30, 2024

elysahall Oct 30, 2024

elysahall Oct 30, 2024

elysahall Oct 30, 2024

elysahall Oct 30, 2024

elysahall Oct 30, 2024

elysahall Oct 30, 2024

elysahall left a comment

elysahall Nov 13, 2024

ashishbharadwajm Nov 14, 2024


		aws oam delete-link \
		--identifier arn:aws:oam:us-east-2:123456789111:link/a1b2c3d4-5678-90ab-cdef-example11111


		aws oam delete-sink \
		--identifier arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345

	--policy "{\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS\":\"arn:aws:iam::123456789111:root\"},\"Action\":[\"oam:CreateLink\",\"oam:UpdateLink\"],\"Resource\":\"*\",\"Condition\":{\"ForAllValues:StringEquals\":{\"oam:ResourceTypes\":[\"AWS::Logs::LogGroup\",\"AWS::CloudWatch::Metric\",\"AWS::XRay::Trace\",\"AWS::ApplicationInsights::Application\"]}}}]}" \
	--policy '{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal":{"AWS":"arn:aws:iam::123456789111:root"},"Action":["oam:CreateLink","oam:UpdateLink"],"Resource":"*","Condition":{"ForAllValues:StringEquals":{"oam:ResourceTypes":["AWS::Logs::LogGroup","AWS::CloudWatch::Metric","AWS::XRay::Trace","AWS::ApplicationInsights::Application"]}}}]}' \

		@@ -0,0 +1,9 @@
		To Assign one or more tags to the specified resource

		The following ``tag-resource`` example tags a sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``. If the command succeeds, no output is returned. ::

		@@ -0,0 +1,9 @@
		To Removes one or more tags from the specified resource.

		The following ``untag-resource`` example removes a tag with the key ``team`` from Sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``. If the command succeeds, no output is returned. ::

		@@ -0,0 +1,11 @@
		To Remove one or more tags from the specified resource.

		The following ``untag-resource`` example removes a tag with the key ``team`` from Sink ``arn:aws:oam:us-east-2:123456789012:sink/a1b2c3d4-5678-90ab-cdef-example12345``.

Add CLI examples for CloudWatch OAM #8971

Are you sure you want to change the base?

Add CLI examples for CloudWatch OAM #8971

Conversation

ashishbharadwajm commented Oct 14, 2024

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

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