PutRumMetricsDestination - CloudWatch RUM

PutRumMetricsDestination

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 AddRumMetrics.

Request Syntax

POST /rummetrics/AppMonitorName/metricsdestination HTTP/1.1 Content-type: application/json { "Destination": "string", "DestinationArn": "string", "IamRoleArn": "string" }

URI Request Parameters

The request uses the following URI parameters.

AppMonitorName

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

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: ^(?!\.)[\.\-_#A-Za-z0-9]+$

Required: Yes

Request Body

The request accepts the following data in JSON format.

Destination

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.

Type: String

Valid Values: CloudWatch | Evidently

Required: Yes

DestinationArn

Use this parameter only if Destination is Evidently. This parameter specifies the ARN of the Evidently experiment that will receive the extended metrics.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 2048.

Pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:.*

Required: No

IamRoleArn

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.

Type: String

Pattern: arn:[^:]*:[^:]*:[^:]*:[^:]*:.*

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient permissions to perform this action.

HTTP Status Code: 403

ConflictException

This operation attempted to create a resource that already exists.

HTTP Status Code: 409

InternalServerException

Internal service exception.

HTTP Status Code: 500

ResourceNotFoundException

Resource not found.

HTTP Status Code: 404

ThrottlingException

The request was throttled because of quota limits.

HTTP Status Code: 429

ValidationException

One of the arguments for the request is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: