Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateRumMetricDefinition

Modifies one existing metric definition for CloudWatch RUM extended metrics. For more information about extended metrics, see BatchCreateRumMetricsDefinitions.

Request Syntax


PATCH /rummetrics/AppMonitorName/metrics HTTP/1.1
Content-type: application/json

{
   "Destination": "string",
   "DestinationArn": "string",
   "MetricDefinition": { 
      "DimensionKeys": { 
         "string" : "string" 
      },
      "EventPattern": "string",
      "Name": "string",
      "Namespace": "string",
      "UnitLabel": "string",
      "ValueKey": "string"
   },
   "MetricDefinitionId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AppMonitorName

The name of the CloudWatch RUM app monitor that sends these 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

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 will receive the metrics and an IAM role that has permission to write to the experiment.

Type: String

Valid Values: CloudWatch | Evidently

Required: Yes

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 is to receive the metrics. You must have already defined this experiment as a valid destination. For more information, see PutRumMetricsDestination.

Type: String

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

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

Required: No

MetricDefinition

A structure that contains the new definition that you want to use for this metric.

Type: MetricDefinitionRequest object

Required: Yes

MetricDefinitionId

The ID of the metric definition to update.

Type: String

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

Required: Yes

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

ServiceQuotaExceededException

This request exceeds a service quota.

HTTP Status Code: 402

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