batch_get_rum_metric_definitions ¶

def batch_get_rum_metric_definitions(
    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,
    max_results: Optional[
        "capo_rum.types.max_results_integer.MaxResultsInteger"
    ] = None,
    next_token: Optional[str] = None,
) -> "capo_rum.types.batch_get_rum_metric_definitions_response.BatchGetRumMetricDefinitionsResponse":
    """<p>Retrieves the list of metrics and dimensions that a RUM app monitor is sending to a single destination.</p>

    Args:
        app_monitor_name: <p>The name of the CloudWatch RUM app monitor that is sending the metrics.</p>
        destination: <p>The type of destination that you want to view metrics for. 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.</p> <p>This parameter specifies the ARN of the Evidently experiment that corresponds to the destination.</p>
        max_results: <p>The maximum number of results to return in one operation. The default is 50. The maximum that you can specify is 100.</p> <p>To retrieve the remaining results, make another call with the returned <code>NextToken</code> value. </p>
        next_token: <p>Use the token returned by the previous operation to request the next page of results.</p>

    Raises:
        capo_rum.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permissions to perform this action.</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.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.batch_get_rum_metric_definitions_request.BatchGetRumMetricDefinitionsRequest]",
    ) -> OperationResponse[
        "capo_rum.types.batch_get_rum_metric_definitions_response.BatchGetRumMetricDefinitionsResponse"
    ]:
        import capo_rum._operations.rum.batch_get_rum_metric_definitions

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("BatchGetRumMetricDefinitions")
    )
    input_: capo_rum.types.batch_get_rum_metric_definitions_request.BatchGetRumMetricDefinitionsRequest = {
        "app_monitor_name": app_monitor_name,
        "destination": destination,
    }
    if destination_arn is not None:
        input_["destination_arn"] = destination_arn
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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