list_monitor_evaluations async ¶

async def list_monitor_evaluations(
    self,
    monitor_arn: "capo_forecast.types.arn.Arn",
    *,
    config_overrides: Optional[AsyncforecastClientConfig] = None,
    next_token: Optional["capo_forecast.types.next_token.NextToken"] = None,
    max_results: Optional["capo_forecast.types.max_results.MaxResults"] = None,
    filters: Optional["capo_forecast.types.filters.Filters"] = None,
) -> "capo_forecast.types.list_monitor_evaluations_response.ListMonitorEvaluationsResponse":
    """<p>Returns a list of the monitoring evaluation results and predictor events collected by the monitor resource during different windows of time.</p> <p>For information about monitoring see <a>predictor-monitoring</a>. For more information about retrieving monitoring results see <a href="https://docs.aws.amazon.com/forecast/latest/dg/predictor-monitoring-results.html">Viewing Monitoring Results</a>.</p>

    Args:
        next_token: <p>If the result of the previous request was truncated, the response includes a <code>NextToken</code>. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.</p>
        max_results: <p>The maximum number of monitoring results to return.</p>
        monitor_arn: <p>The Amazon Resource Name (ARN) of the monitor resource to get results from.</p>
        filters: <p>An array of filters. For each filter, provide a condition and a match statement. The condition is either <code>IS</code> or <code>IS_NOT</code>, which specifies whether to include or exclude the resources that match the statement from the list. The match statement consists of a key and a value.</p> <p> <b>Filter properties</b> </p> <ul> <li> <p> <code>Condition</code> - The condition to apply. Valid values are <code>IS</code> and <code>IS_NOT</code>.</p> </li> <li> <p> <code>Key</code> - The name of the parameter to filter on. The only valid value is <code>EvaluationState</code>.</p> </li> <li> <p> <code>Value</code> - The value to match. Valid values are only <code>SUCCESS</code> or <code>FAILURE</code>.</p> </li> </ul> <p>For example, to list only successful monitor evaluations, you would specify:</p> <p> <code>"Filters": [ { "Condition": "IS", "Key": "EvaluationState", "Value": "SUCCESS" } ]</code> </p>

    Raises:
        capo_forecast.errors.invalid_input_exception.InvalidInputException: <p>We can't process the request because it includes an invalid value or a value that exceeds the valid range.</p>
        capo_forecast.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The token is not valid. Tokens expire after 24 hours.</p>
        capo_forecast.errors.resource_not_found_exception.ResourceNotFoundException: <p>We can't find a resource with that Amazon Resource Name (ARN). Check the ARN and try again.</p>
        capo_forecast.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_forecast.types.list_monitor_evaluations_request.ListMonitorEvaluationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_forecast.types.list_monitor_evaluations_response.ListMonitorEvaluationsResponse"
    ]:
        import capo_forecast._operations.amazon_forecast.list_monitor_evaluations

        (
            output,
            http_response,
        ) = await capo_forecast._operations.amazon_forecast.list_monitor_evaluations.async_list_monitor_evaluations(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMonitorEvaluations")
    )
    input_: capo_forecast.types.list_monitor_evaluations_request.ListMonitorEvaluationsRequest = {
        "monitor_arn": monitor_arn
    }
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if filters is not None:
        input_["filters"] = filters

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output