Skip to content

delete_rum_metrics_destination

delete_rum_metrics_destination(
    app_monitor_name: AppMonitorName,
    destination: MetricDestination,
    *,
    config_overrides: Optional[RUMClientConfig] = None,
    destination_arn: Optional[DestinationArn] = None,
) -> DeleteRumMetricsDestinationResponse

Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.

Parameters:

  • app_monitor_name (AppMonitorName) –

    The name of the app monitor that is sending metrics to the destination that you want to delete.

  • destination (MetricDestination) –

    The type of destination to delete. Valid values are CloudWatch and Evidently.

  • destination_arn (Optional[DestinationArn], default: None ) –

    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 corresponds to the destination to delete.

Raises:

Source code in docs_src/capo_rum/_services/rum.py
def delete_rum_metrics_destination(
    self,
    app_monitor_name: "capo_rum.types.app_monitor_name.AppMonitorName",
    destination: "capo_rum.types.metric_destination.MetricDestination",
    *,
    config_overrides: Optional[RUMClientConfig] = None,
    destination_arn: Optional[
        "capo_rum.types.destination_arn.DestinationArn"
    ] = None,
) -> "capo_rum.types.delete_rum_metrics_destination_response.DeleteRumMetricsDestinationResponse":
    """<p>Deletes a destination for CloudWatch RUM extended metrics, so that the specified app monitor stops sending extended metrics to that destination.</p>

    Args:
        app_monitor_name: <p>The name of the app monitor that is sending metrics to the destination that you want to delete.</p>
        destination: <p>The type of destination to delete. Valid values are <code>CloudWatch</code> and <code>Evidently</code>.</p>
        destination_arn: <p>This parameter is required if <code>Destination</code> is <code>Evidently</code>. If <code>Destination</code> is <code>CloudWatch</code>, do not use this parameter. This parameter specifies the ARN of the Evidently experiment that corresponds to the destination to delete.</p>

    Raises:
        capo_rum.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permissions to perform this action.</p>
        capo_rum.errors.conflict_exception.ConflictException: <p>This operation attempted to create a resource that already exists.</p>
        capo_rum.errors.internal_server_exception.InternalServerException: <p>Internal service exception.</p>
        capo_rum.errors.resource_not_found_exception.ResourceNotFoundException: <p>Resource not found.</p>
        capo_rum.errors.throttling_exception.ThrottlingException: <p>The request was throttled because of quota limits.</p>
        capo_rum.errors.validation_exception.ValidationException: <p>One of the arguments for the request is not valid.</p>
        capo_rum.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_rum.types.delete_rum_metrics_destination_request.DeleteRumMetricsDestinationRequest]",
    ) -> OperationResponse[
        "capo_rum.types.delete_rum_metrics_destination_response.DeleteRumMetricsDestinationResponse"
    ]:
        import capo_rum._operations.rum.delete_rum_metrics_destination

        output, http_response = (
            capo_rum._operations.rum.delete_rum_metrics_destination.delete_rum_metrics_destination(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteRumMetricsDestination")
    )
    input_: capo_rum.types.delete_rum_metrics_destination_request.DeleteRumMetricsDestinationRequest = {
        "app_monitor_name": app_monitor_name,
        "destination": destination,
    }
    if destination_arn is not None:
        input_["destination_arn"] = destination_arn

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output