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

BatchDeleteRumMetricDefinitions

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

If some metric definition IDs specified in a BatchDeleteRumMetricDefinitions 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 BatchDeleteRumMetricDefinitions operation is 200.

Request Syntax


DELETE /rummetrics/AppMonitorName/metrics?destination=Destination&destinationArn=DestinationArn&metricDefinitionIds=MetricDefinitionIds HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

AppMonitorName

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

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

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

Required: Yes

Destination

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.

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

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

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

MetricDefinitionIds

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Errors": [ 
      { 
         "ErrorCode": "string",
         "ErrorMessage": "string",
         "MetricDefinitionId": "string"
      }
   ],
   "MetricDefinitionIds": [ "string" ]
}

Response Elements

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

The following data is returned in JSON format by the service.

Errors

An array of error objects, if the operation caused any errors.

Type: Array of BatchDeleteRumMetricDefinitionsError objects

MetricDefinitionIds

The IDs of the metric definitions that were deleted.

Type: Array of strings

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

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