batch_delete_rum_metric_definitions

CloudWatchRUM.Client.batch_delete_rum_metric_definitions(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_rum_metric_definitions(
    AppMonitorName='string',
    Destination='CloudWatch'|'Evidently',
    DestinationArn='string',
    MetricDefinitionIds=[
        'string',
    ]
)

Parameters

• AppMonitorName (string) --

  [REQUIRED]

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

• Destination (string) --

  [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 (string) --

  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 (list) --

  [REQUIRED]

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

  • (string) --

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • Errors (list) --

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

    • (dict) --

      A structure that defines one error caused by a BatchCreateRumMetricsDefinitions operation.

      • ErrorCode (string) --

        The error code.

      • ErrorMessage (string) --

        The error message for this metric definition.

      • MetricDefinitionId (string) --

        The ID of the metric definition that caused this error.

  • MetricDefinitionIds (list) --

    The IDs of the metric definitions that were deleted.

    • (string) --

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