CloudWatchRUM / Client / put_rum_metrics_destination

put_rum_metrics_destination

CloudWatchRUM.Client.put_rum_metrics_destination(**kwargs)

Creates or updates a destination to receive extended metrics from CloudWatch RUM. You can send extended metrics to CloudWatch or to a CloudWatch Evidently experiment.

For more information about extended metrics, see BatchCreateRumMetricDefinitions.

See also: AWS API Documentation

Request Syntax

response = client.put_rum_metrics_destination(
    AppMonitorName='string',
    Destination='CloudWatch'|'Evidently',
    DestinationArn='string',
    IamRoleArn='string'
)

Parameters:

• AppMonitorName (string) –

  [REQUIRED]

  The name of the CloudWatch RUM app monitor that will send the metrics.

• Destination (string) –

  [REQUIRED]

  Defines the destination to send the metrics to. 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 (string) – Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.

• IamRoleArn (string) –

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

  This parameter specifies the ARN of an IAM role that RUM will assume to write to the Evidently experiment that you are sending metrics to. This role must have permission to write to that experiment.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• CloudWatchRUM.Client.exceptions.ConflictException

• CloudWatchRUM.Client.exceptions.ResourceNotFoundException

• CloudWatchRUM.Client.exceptions.InternalServerException

• CloudWatchRUM.Client.exceptions.ValidationException

• CloudWatchRUM.Client.exceptions.ThrottlingException

• CloudWatchRUM.Client.exceptions.AccessDeniedException