Batch Get Rum Metric Definitions

cloudwatchrum_batch_get_rum_metric_definitions

R Documentation

Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination¶

Description¶

Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.

Usage¶

cloudwatchrum_batch_get_rum_metric_definitions(AppMonitorName,
  Destination, DestinationArn, MaxResults, NextToken)

Arguments¶

AppMonitorName

[required] The name of the CloudWatch RUM app monitor that is sending the metrics.

Destination

[required] The type of destination that you want to view metrics for. Valid values are CloudWatch and Evidently.

DestinationArn

This parameter is required if Destination is Evidently. If Destination is CloudWatch, do not use this parameter.

This parameter specifies the ARN of the Evidently experiment that corresponds to the destination.

MaxResults

The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.

To retrieve the remaining results, make another call with the returned NextToken value.

NextToken

Use the token returned by the previous operation to request the next page of results.

Value¶

A list with the following syntax:

list(
  MetricDefinitions = list(
    list(
      DimensionKeys = list(
        "string"
      ),
      EventPattern = "string",
      MetricDefinitionId = "string",
      Name = "string",
      Namespace = "string",
      UnitLabel = "string",
      ValueKey = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$batch_get_rum_metric_definitions(
  AppMonitorName = "string",
  Destination = "CloudWatch"|"Evidently",
  DestinationArn = "string",
  MaxResults = 123,
  NextToken = "string"
)