Skip to content

Batch Delete Rum Metric Definitions

cloudwatchrum_batch_delete_rum_metric_definitions R Documentation

Removes the specified metrics from being sent to an extended metrics destination

Description

Removes the specified metrics from being sent to an extended metrics destination.

If some metric definition IDs specified in a batch_delete_rum_metric_definitions operations are not valid, those metric definitions fail and return errors, but all valid metric definition IDs in the same operation are still deleted.

The maximum number of metric definitions that you can specify in one batch_delete_rum_metric_definitions operation is 200.

Usage

cloudwatchrum_batch_delete_rum_metric_definitions(AppMonitorName,
  Destination, DestinationArn, MetricDefinitionIds)

Arguments

AppMonitorName

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

Destination

[required] Defines the destination where you want to stop sending the specified metrics. Valid values are CloudWatch and Evidently. If you specify Evidently, you must also specify the ARN of the CloudWatchEvidently experiment that is to be the destination and an IAM role that has permission to write to the experiment.

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 was receiving the metrics that are being deleted.

MetricDefinitionIds

[required] An array of structures which define the metrics that you want to stop sending.

Value

A list with the following syntax:

list(
  Errors = list(
    list(
      ErrorCode = "string",
      ErrorMessage = "string",
      MetricDefinitionId = "string"
    )
  ),
  MetricDefinitionIds = list(
    "string"
  )
)

Request syntax

svc$batch_delete_rum_metric_definitions(
  AppMonitorName = "string",
  Destination = "CloudWatch"|"Evidently",
  DestinationArn = "string",
  MetricDefinitionIds = list(
    "string"
  )
)