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.

Sign up for GitHub

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

Jump to bottom

adding rum-cli-examples #8984

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

adding rum-cli-examples #8984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions awscli/examples/rum/batch-create-rum-metric-definitions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
**To specify the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination**

The following ``batch-create-rum-metric-definitions`` specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. ::
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 following ``batch-create-rum-metric-definitions`` specifies the extended metrics and custom metrics that you want a CloudWatch RUM app monitor to send to a destination. ::
The following ``batch-create-rum-metric-definitions`` example has a CloudWatch RUM app monitor send extended and custom metrics to the specified destination. ::


aws rum batch-create-rum-metric-definitions \
--app-monitor-name MyWebApp \
--destination CloudWatch \
--metric-definitions 'Namespace=PageVisit,Name=AmazonVisitCount,DimensionKeys={event_details.current_url=URL},EventPattern="{\"metadata\":{\"browserName\":[\"Chrome\"]},\"event_type\":[\"my_custom_event\"],\"event_details\":{\"current_url\":[\"amazonaws.com\"]}}"'

Output::

{
"Errors": [],
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
"Errors": [],
"Errors": [],

"MetricDefinitions": [
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
"MetricDefinitions": [
"MetricDefinitions": [

{
"DimensionKeys": {
"event_details.current_url": "URL"
},
"EventPattern": "{\"metadata\":{\"browserName\":[\"Chrome\"]},\"event_type\":[\"my_custom_event\"],\"event_details\":{\"current_url\":[\"amazonaws.com\"]}}",
"MetricDefinitionId": "8b67gh3-r678-q987-a576-b9fj7kf234kd",
"Name": "AmazonVisitCount",
"Namespace": "PageVisit"
}
]
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
]
]

}
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 `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
11 changes: 11 additions & 0 deletions awscli/examples/rum/batch-delete-rum-metric-definitions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
**To remove the specified metrics from being sent to an extended metrics destination**

The following ``batch-delete-rum-metric-definitions`` removes the specified metrics from being sent to an extended metrics destination. If the command succeeds, no output is returned. ::
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 following ``batch-delete-rum-metric-definitions`` removes the specified metrics from being sent to an extended metrics destination. If the command succeeds, no output is returned. ::
The following ``batch-delete-rum-metric-definitions`` example removes the specified metrics from being sent to an extended metrics destination. ::


aws rum batch-delete-rum-metric-definitions \
Copy link
Collaborator

Choose a reason for hiding this comment

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

All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--app-monitor-name AWSApp \
--destination Evidently \
--destination-arn arn:aws:evidently:us-east-1:123456789012:project/petfood/feature/petfood-upsell-text \
--metric-definition-ids 77gh6a55-bh77-5eed-a338-d8750b544a2
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
--metric-definition-ids 77gh6a55-bh77-5eed-a338-d8750b544a2
--metric-definition-ids 77gh6a55-bh77-5eed-a338-d8750b544a2
This command produces no output.


For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
39 changes: 39 additions & 0 deletions awscli/examples/rum/batch-get-rum-metric-definitions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
**Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination**

The following ``batch-get-rum-metric-definitions` retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination. ::
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 following ``batch-get-rum-metric-definitions` retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination. ::
The following ``batch-get-rum-metric-definitions`` example retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination. ::


aws rum batch-get-rum-metric-definitions \
--app-monitor-name MyWebApp \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--destination CloudWatch

Output::

{
"MetricDefinitions": [
{
"DimensionKeys": {
"metadata.browserName": "BrowserName",
"metadata.countryCode": "CountryCode",
"metadata.deviceType": "DeviceType",
"metadata.osName": "OSName",
"metadata.pageId": "PageId"
},
"EventPattern": "{\"event_type\":[\"com.amazon.rum.session_start_event\"],\"metadata\":{\"pageId\":[\"/\"],\"browserName\":[\"Firefox\",\"Chrome\",\"Chrome Headless\",\"Edge\",\"IE\",\"Safari\"],\"countryCode\":[\"IN\"],\"deviceType\":[\"mobile\"],\"osName\":[\"Android\",\"iOS\"]}}",
"MetricDefinitionId": "010c9e15-c0ad-4321-9166-52d8b909b34e",
"Name": "SessionCount",
"Namespace": "AWS/RUM",
"UnitLabel": "Count"
},
{
"DimensionKeys": {
"event_details.current_url": "URL"
},
"EventPattern": "{\"metadata\":{\"browserName\":[\"Chrome\"]},\"event_type\":[\"my_custom_event\"],\"event_details\":{\"current_url\":[\"amazonaws.com\"]}}",
"MetricDefinitionId": "8b67gh3-r678-q987-a576-b9fj7kf234kd",
"Name": "AmazonVisitCount",
"Namespace": "PageVisit"
}
]
}

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
15 changes: 15 additions & 0 deletions awscli/examples/rum/create-app-monitor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
**To create a Amazon CloudWatch RUM app monitor**

The following ``create-app-monitor`` creates a Amazon CloudWatch RUM app monitor. ::
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 following ``create-app-monitor`` creates a Amazon CloudWatch RUM app monitor. ::
The following ``create-app-monitor`` example creates a Amazon CloudWatch RUM app monitor. ::


aws rum create-app-monitor \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--domain amazonaws.com \
--name AWSApp

Output::

{
"Id": "77gh6a55-bh77-5eed-a338-d8750b544a2"
}

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
7 changes: 7 additions & 0 deletions awscli/examples/rum/delete-app-monitor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
**To deletes an existing app monitor**

The following ``delete-app-monitor`` deletes an existing app monitor. If the command succeeds, no output is returned. ::
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 following ``delete-app-monitor`` deletes an existing app monitor. If the command succeeds, no output is returned. ::
The following ``delete-app-monitor`` example deletes an existing app monitor. ::


aws rum delete-app-monitor --name AWSApp
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

The --name option also needs to be on it's own line.


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

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
10 changes: 10 additions & 0 deletions awscli/examples/rum/delete-rum-metrics-destination.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
**To deletes a destination for CloudWatch RUM extended metrics**

The following ``delete-rum-metrics-destination`` deletes a destination for CloudWatch RUM extended metrics. If the command succeeds, no output is returned. ::
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 following ``delete-rum-metrics-destination`` deletes a destination for CloudWatch RUM extended metrics. If the command succeeds, no output is returned. ::
The following ``delete-rum-metrics-destination`` example deletes a destination for CloudWatch RUM extended metrics. ::


aws rum delete-rum-metrics-destination \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--app-monitor-name AWSApp \
--destination Evidently \
--destination-arn arn:aws:evidently:us-east-1:123456789012:project/petfood/feature/petfood-upsell-text

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.

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
19 changes: 19 additions & 0 deletions awscli/examples/rum/get-app-monitor-data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
**To retrieve the raw performance events that RUM has collected from your web application**

The following ``get-app-monitor-data`` retrieves the raw performance events that RUM has collected from your web application. ::
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 following ``get-app-monitor-data`` retrieves the raw performance events that RUM has collected from your web application. ::
The following ``get-app-monitor-data`` example retrieves the raw performance events that RUM has collected from your web application. ::


aws rum get-app-monitor-data \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--name MyWebApp \
--time-range After=1712492421000,Before=1712492422000 \
--filters Name=EventType,Values=com.amazon.rum.performance_resource_event

Output::

{
"Events": [
"{\"userId\":\"9b43f0e7-8ce7-4a1a-80d2-b1761f7a1aaa\",\"sessionId\":\"887vv1bc-f345-5784-be88-aegf7d2a8723\",\"application_id\":\"r6fj89df-5rt3-55h6-9875-bg6c7uud94fg\",\"application_version\":\"1.0.0\",\"application_name\":\"MyWebApp\",\"event_id\":\"w878e342-5e99-4b66-d7fv-567e49001vf6\",\"event_timestamp\":1712492422000,\"event_type\":\"com.amazon.rum.performance_resource_event\",\"event_version\":\"1.0.0\",\"log_stream\":{\"seconds\":1712492422,\"nanos\":0},\"batch_id\":\"0b85623b-90f1-4725-9dc6-ceac23566c07\",\"metadata\":{\"version\":\"1.0.0\",\"browserLanguage\":\"en-GB\",\"browserName\":\"Chrome\",\"browserVersion\":\"123.0.0.0\",\"osName\":\"Mac OS\",\"osVersion\":\"10.15.7\",\"deviceType\":\"desktop\",\"platformType\":\"web\",\"pageId\":\"/\",\"interaction\":0,\"title\":\"Simple HTML Website\",\"domain\":\"amazonaws.com\",\"aws:client\":\"arw-script\",\"aws:clientVersion\":\"1.16.1\",\"countryCode\":\"IN\",\"subdivisionCode\":\"KA\"},\"metadata_keys\":[\"version\",\"browserLanguage\",\"browserName\",\"browserVersion\",\"osName\",\"osVersion\",\"deviceType\",\"platformType\",\"pageId\",\"interaction\",\"title\",\"domain\",\"aws:client\",\"aws:clientVersion\",\"countryCode\",\"subdivisionCode\"],\"metadata_values\":[\"version=1.0.0\",\"browserLanguage=en-GB\",\"browserName=Chrome\",\"browserVersion=123.0.0.0\",\"osName=Mac OS\",\"osVersion=10.15.7\",\"deviceType=desktop\",\"platformType=web\",\"pageId=/\",\"interaction=0\",\"title=Simple HTML Website\",\"domain=amazonaws.com\",\"aws:client=arw-script\",\"aws:clientVersion=1.16.1\",\"countryCode=IN\",\"subdivisionCode=KA\"],\"event_details\":{\"version\":\"1.0.0\",\"targetUrl\":\"https://amazonaws.com/favicon.ico\",\"initiatorType\":\"other\",\"startTime\":2838.7000000178814,\"duration\":257.7999999821186,\"transferSize\":496.0,\"fileType\":\"image\"},\"user_details\":{\"sessionId\":\"887vv1bc-f345-5784-be88-aegf7d2a8723\",\"userId\":\"9b43f0e7-8ce7-4a1a-80d2-b1761f7a1aaa\"},\"account_id\":\"123456789012\",\"event_interaction\":\"%2F-0 &\"}",
"{\"userId\":\"9b43f0e7-8ce7-4a1a-80d2-b1761f7a1aaa\",\"sessionId\":\"887vv1bc-f345-5784-be88-aegf7d2a8723\",\"application_id\":\"r6fj89df-5rt3-55h6-9875-bg6c7uud94fg\",\"application_version\":\"1.0.0\",\"application_name\":\"MyWebApp\",\"event_id\":\"984508bn-he88-7d55-301j-0c69a99f38dt\",\"event_timestamp\":1712492421000,\"event_type\":\"com.amazon.rum.performance_resource_event\",\"event_version\":\"1.0.0\",\"log_stream\":{\"seconds\":1712492421,\"nanos\":0},\"batch_id\":\"0b85623b-90f1-4725-9dc6-ceac23566c07\",\"metadata\":{\"version\":\"1.0.0\",\"browserLanguage\":\"en-GB\",\"browserName\":\"Chrome\",\"browserVersion\":\"123.0.0.0\",\"osName\":\"Mac OS\",\"osVersion\":\"10.15.7\",\"deviceType\":\"desktop\",\"platformType\":\"web\",\"pageId\":\"/\",\"interaction\":0,\"title\":\"Simple HTML Website\",\"domain\":\"amazonaws.com\",\"aws:client\":\"arw-script\",\"aws:clientVersion\":\"1.16.1\",\"countryCode\":\"IN\",\"subdivisionCode\":\"KA\"},\"metadata_keys\":[\"version\",\"browserLanguage\",\"browserName\",\"browserVersion\",\"osName\",\"osVersion\",\"deviceType\",\"platformType\",\"pageId\",\"interaction\",\"title\",\"domain\",\"aws:client\",\"aws:clientVersion\",\"countryCode\",\"subdivisionCode\"],\"metadata_values\":[\"version=1.0.0\",\"browserLanguage=en-GB\",\"browserName=Chrome\",\"browserVersion=123.0.0.0\",\"osName=Mac OS\",\"osVersion=10.15.7\",\"deviceType=desktop\",\"platformType=web\",\"pageId=/\",\"interaction=0\",\"title=Simple HTML Website\",\"domain=amazonaws.com\",\"aws:client=arw-script\",\"aws:clientVersion=1.16.1\",\"countryCode=IN\",\"subdivisionCode=KA\"],\"event_details\":{\"version\":\"1.0.0\",\"targetUrl\":\"https://client.rum.us-east-1.amazonaws.com/1.16.1/cwr.js\",\"initiatorType\":\"script\",\"startTime\":1203.0,\"duration\":16.900000005960464,\"transferSize\":0.0,\"fileType\":\"script\"},\"user_details\":{\"sessionId\":\"887vv1bc-f345-5784-be88-aegf7d2a8723\",\"userId\":\"9b43f0e7-8ce7-4a1a-80d2-b1761f7a1aaa\"},\"account_id\":\"123456789012\",\"event_interaction\":\"%2F-0 &\"}"
]
}

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
46 changes: 46 additions & 0 deletions awscli/examples/rum/get-app-monitor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
**To retrieve the complete configuration information for one app monitor**

The following ``get-app-monitor`` retrieves the complete configuration information for one app monitor. ::
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 following ``get-app-monitor`` retrieves the complete configuration information for one app monitor. ::
The following ``get-app-monitor`` example retrieves the complete configuration information for one app monitor. ::


aws rum get-app-monitor \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--name MyWebApp

Output::

{
"AppMonitor": {
"AppMonitorConfiguration": {
"AllowCookies": true,
"EnableXRay": true,
"ExcludedPages": [],
"IdentityPoolId": "us-west-1:78bcaws1-5e48-4as6-8tu4-t8c62d152d38",
"IncludedPages": [],
"SessionSampleRate": 1.0,
"Telemetries": [
"performance",
"errors",
"http"
]
},
"Created": "2024-04-04T16:13:09.278943Z",
"CustomEvents": {
"Status": "ENABLED"
},
"DataStorage": {
"CwLog": {
"CwLogEnabled": true,
"CwLogGroup": "/aws/vendedlogs/RUMService_MyWebAppe678de"
}
},
"Domain": "*.amazonaws.com",
"Id": "r6fj89df-5rt3-55h6-9875-bg6c7uud94fg",
"Name": "MyWebApp",
"State": "CREATED",
"Tags": {
"auto-delete": "no",
"MyWebApp": ""
}
}
}

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
38 changes: 38 additions & 0 deletions awscli/examples/rum/list-app-monitors.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
**To return a list of the Amazon CloudWatch RUM app monitors in the account**

The following ``list-app-monitors`` returns a list of the Amazon CloudWatch RUM app monitors in the account. ::
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 following ``list-app-monitors`` returns a list of the Amazon CloudWatch RUM app monitors in the account. ::
The following ``list-app-monitors`` example returns a list of the Amazon CloudWatch RUM app monitors in the account. ::


aws rum list-app-monitors

Output::

{
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

"AppMonitorSummaries": [
{
"Created": "2024-04-07T12:37:05.326459Z",
"Id": "5bh7juu8-3dd7-4ccu-b434-8e5t89849g9d",
"Name": "AWSApp",
"State": "CREATED"
},
{
"Created": "2024-04-07T12:37:10.757704Z",
"Id": "6f177feb-fbft-4b7j-98k0-86yuc79c6563",
"Name": "AWSApp2",
"State": "CREATED"
},
{
"Created": "2024-04-07T12:37:15.330147Z",
"Id": "dedc2978-8f89-6jju-ad7i-67668kf086b91",
"Name": "AWSApp3",
"State": "CREATED"
},
{
"Created": "2024-04-04T16:13:09.278943Z",
"Id": "r6fj89df-5rt3-55h6-9875-bg6c7uud94fg",
"Name": "MyWebApp",
"State": "CREATED"
}
]
}

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
25 changes: 25 additions & 0 deletions awscli/examples/rum/list-rum-metrics-destinations.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
**To return a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor**

The following ``list-rum-metrics-destinations`` returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor. ::
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 following ``list-rum-metrics-destinations`` returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor. ::
The following ``list-rum-metrics-destinations`` example returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor. ::

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 following ``list-rum-metrics-destinations`` returns a list of destinations that you have created to receive RUM extended metrics, for the specified app monitor. ::
The following ``list-rum-metrics-destinations`` example returns a list of destinations that you created to receive RUM extended metrics, for the specified app monitor. ::


aws rum list-rum-metrics-destinations \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--app-monitor-name MyWebApp

Output::

{
"Destinations": [
{
"Destination": "CloudWatch",
"DestinationArn": "",
"IamRoleArn": ""
},
{
"Destination": "Evidently",
"DestinationArn": "arn:aws:evidently:us-east-1:123456789012:project/petfood/feature/petfood-upsell-text",
"IamRoleArn": "arn:aws:iam::123456789012:role/Assume-role-EC2"
}
]
}

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
19 changes: 19 additions & 0 deletions awscli/examples/rum/list-tags-for-resource.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
**To display the tags associated with a CloudWatch RUM resource**

The following ``list-tags-for-resource`` displays the tags associated with a CloudWatch RUM resource. ::
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 following ``list-tags-for-resource`` displays the tags associated with a CloudWatch RUM resource. ::
The following ``list-tags-for-resource`` example displays the tags associated with a CloudWatch RUM resource. ::


aws rum list-tags-for-resource \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--resource-arn arn:aws:rum:us-west-1:123456789012:appmonitor/MyWebApp

Output::

{
"Tags": {
"Value": "Production",
"delete": "no",
"Key": "Environment",
"MyWebApp": ""
}
}

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
12 changes: 12 additions & 0 deletions awscli/examples/rum/put-rum-events.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
**To send telemetry events about your application performance and user behavior to CloudWatch RUM**

The following ``put-rum-events`` sends telemetry events about your application performance and user behavior to CloudWatch RUM. If the command succeeds, no output is returned. ::
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 following ``put-rum-events`` sends telemetry events about your application performance and user behavior to CloudWatch RUM. If the command succeeds, no output is returned. ::
The following ``put-rum-events`` example sends telemetry events about your application performance and user behavior to CloudWatch RUM. ::


aws rum put-rum-events \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--app-monitor-details "{\"id\":\"r6fj89df-5rt3-55h6-9875-bg6c7uud94fg\",\"name\":\"MyWebApp\",\"version\":\"1.0.0\"}" \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Command examples need to follow standard unix-like quoting rules, where strings are surrounded by single quotes. With single quotes you no longer need to escape your double quotes, so it'll look similar to the following:

Suggested change
--app-monitor-details "{\"id\":\"r6fj89df-5rt3-55h6-9875-bg6c7uud94fg\",\"name\":\"MyWebApp\",\"version\":\"1.0.0\"}" \
--app-monitor-details '{"id":"r6fj89df-5rt3-55h6-9875-bg6c7uud94fg","name":"MyWebApp","version":"1.0.0"}' \

Be sure to fix all your command options following these quoting rules.

--batch-id "0b856678-90g1-4767-9uu6-ceyui23567807" \
--id "r6fj89df-5rt3-55h6-9875-bg6c7uud94fg" \
--rum-events "[{\"details\":\"{\\\"version\\\":\\\"1.0.0\\\",\\\"targetUrl\\\":\\\"https://amazonaws.com\\\",\\\"initiatorType\\\":\\\"other\\\",\\\"startTime\\\":2838.7000000178814,\\\"duration\\\":257.7999999821186,\\\"transferSize\\\":496.0,\\\"fileType\\\":\\\"image\\\"}\",\"id\":\"r6fj89df-5rt3-55h6-9875-bg6c7uud94fg\",\"metadata\":\"{\\\"version\\\":\\\"1.0.0\\\",\\\"browserLanguage\\\":\\\"en-GB\\\",\\\"browserName\\\":\\\"Chrome\\\",\\\"browserVersion\\\":\\\"123.0.0.0\\\",\\\"osName\\\":\\\"Mac OS\\\",\\\"osVersion\\\":\\\"10.15.7\\\",\\\"deviceType\\\":\\\"desktop\\\",\\\"platformType\\\":\\\"web\\\",\\\"pageId\\\":\\\"/\\\",\\\"interaction\\\":0,\\\"title\\\":\\\"Simple HTML Website\\\",\\\"domain\\\":\\\"amazonaws.com\\\",\\\"aws:client\\\":\\\"arw-script\\\",\\\"aws:clientVersion\\\":\\\"1.16.1\\\",\\\"countryCode\\\":\\\"IN\\\",\\\"subdivisionCode\\\":\\\"KA\\\"}\",\"timestamp\":1712982698,\"type\":\"com.amazon.rum.performance_resource_event\"}]" \
--user-details "{\"sessionId\":\"696bb1ce-f193-4240-be00-aeaf4c2a5614\",\"userId\":\"8b43f0t6-8ce7-5a1c-90d2-b1771h7a1bbb\"}"

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.

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
10 changes: 10 additions & 0 deletions awscli/examples/rum/put-rum-metrics-destination.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
**To creates or updates a destination to receive extended metrics from CloudWatch RUM**
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
**To creates or updates a destination to receive extended metrics from CloudWatch RUM**
**To create or update a destination to receive extended metrics from CloudWatch RUM**


The following ``put-rum-metrics-destination`` creates or updates a destination to receive extended metrics from CloudWatch RUM. If the command succeeds, no output is returned. ::
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 following ``put-rum-metrics-destination`` creates or updates a destination to receive extended metrics from CloudWatch RUM. If the command succeeds, no output is returned. ::
The following ``put-rum-metrics-destination`` example creates or updates a destination to receive extended metrics from CloudWatch RUM. ::


aws rum put-rum-metrics-destination \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--app-monitor-name MyWebApp \
--destination Evidently \
--destination-arn arn:aws:evidently:us-east-1:123456789012:project/petfood/feature/petfood-upsell-text --iam-role-arn arn:aws:iam::123456789012:role/Assume-role-EC2

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.

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
9 changes: 9 additions & 0 deletions awscli/examples/rum/tag-resource.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
**To assigns one or more tags (key-value pairs) to the specified CloudWatch resource**
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
**To assigns one or more tags (key-value pairs) to the specified CloudWatch resource**
**To assign one or more tags (key-value pairs) to the specified CloudWatch resource**


The following ``tag-resource`` assigns one or more tags (key-value pairs) to the specified CloudWatch resource. If the command succeeds, no output is returned. ::
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 following ``tag-resource`` assigns one or more tags (key-value pairs) to the specified CloudWatch resource. If the command succeeds, no output is returned. ::
The following ``tag-resource`` example assigns one or more tags (key-value pairs) to the specified CloudWatch resource. ::


aws rum tag-resource \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--resource-arn arn:aws:rum:us-west-1:123456789012:appmonitor/MyWebApp \
--tags Key=Environment,Value=Production

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.

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
9 changes: 9 additions & 0 deletions awscli/examples/rum/untag-resource.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
**To remove one or more tags from the specified resource.**

The following ``untag-resource`` removes one or more tags from the specified resource. If the command succeeds, no output is returned. ::
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 following ``untag-resource`` removes one or more tags from the specified resource. If the command succeeds, no output is returned. ::
The following ``untag-resource`` example removes one or more tags from the specified resource. ::


aws rum untag-resource \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--resource-arn arn:aws:rum:us-west-1:123456789012:appmonitor/MyWebApp \
--tag-keys Environment

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.

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
10 changes: 10 additions & 0 deletions awscli/examples/rum/update-app-monitor.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
**To update the configuration of an existing app monitor**

The following ``update-app-monitor`` updates the configuration of an existing app monitor. If the command succeeds, no output is returned. ::
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 following ``update-app-monitor`` updates the configuration of an existing app monitor. If the command succeeds, no output is returned. ::
The following ``update-app-monitor`` example updates the configuration of an existing app monitor. ::


aws rum update-app-monitor \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--app-monitor-configuration 'AllowCookies=true,EnableXRay=true' \
--custom-events Status=ENABLED \
--name AWSApp

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.

For more information, see `CloudWatch RUM <https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-RUM.html>`__ in the *Amazon CloudWatch User Guide*.
11 changes: 11 additions & 0 deletions awscli/examples/rum/update-rum-metric-definition.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
**To modifies one existing metric definition for CloudWatch RUM extended metric**
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
**To modifies one existing metric definition for CloudWatch RUM extended metric**
**To modify an existing metric definition for CloudWatch RUM extended metric**


The following ``update-rum-metric-definition`` modifies one existing metric definition for CloudWatch RUM extended metrics. If the command succeeds, no output is returned. ::
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 following ``update-rum-metric-definition`` modifies one existing metric definition for CloudWatch RUM extended metrics. If the command succeeds, no output is returned. ::
The following ``update-rum-metric-definition`` example modifies one existing metric definition for CloudWatch RUM extended metrics. ::


aws rum update-rum-metric-definition \
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here. All of these indents need to be 4 spaces each and not tab indenting.
For more information: https://aws.github.io/aws-cli/docs_styleguide.html#general

--app-monitor-name MyWebApp \
--destination CloudWatch \
--metric-definition 'Namespace=PageVisit,Name=AmazonVisitCount,DimensionKeys={event_details.current_url=URL},EventPattern="{\"metadata\":{\"browserName\":[\"Chrome\"]},\"event_type\":[\"my_custom_event\"],\"event_details\":{\"current_url\":[\"amazonaws.com\"]}}"' \
--metric-definition-id 8b67gh3-r678-q987-a576-b9fj7kf234kd

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.

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