list_monitors `async` ¶

list_monitors(
    *,
    config_overrides: Optional[AsyncforecastClientConfig] = None,
    next_token: Optional[NextToken] = None,
    max_results: Optional[MaxResults] = None,
    filters: Optional[Filters] = None,
) -> ListMonitorsResponse

Returns a list of monitors created with the CreateMonitor operation and CreateAutoPredictor operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the DescribeMonitor operation.

Parameters:

next_token (Optional[NextToken], default: None ) –

If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.
max_results (Optional[MaxResults], default: None ) –

The maximum number of monitors to include in the response.
filters (Optional[Filters], default: None ) –
An array of filters. For each filter, provide a condition and a match statement. The condition is either IS or IS_NOT, 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.

Filter properties
- Condition - The condition to apply. Valid values are IS and IS_NOT.
- Key - The name of the parameter to filter on. The only valid value is Status.
- Value - The value to match.
For example, to list all monitors who's status is ACTIVE, you would specify:

"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]

Raises:

InvalidInputException –

We can't process the request because it includes an invalid value or a value that exceeds the valid range.
InvalidNextTokenException –

The token is not valid. Tokens expire after 24 hours.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_forecast/_services/async_forecast.py

async def list_monitors(
    self,
    *,
    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_monitors_response.ListMonitorsResponse":
    """<p>Returns a list of monitors created with the <a>CreateMonitor</a> operation and <a>CreateAutoPredictor</a> operation. For each monitor resource, this operation returns of a summary of its properties, including its Amazon Resource Name (ARN). You can retrieve a complete set of properties of a monitor resource by specify the monitor's ARN in the <a>DescribeMonitor</a> operation.</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 monitors to include in the response.</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>Status</code>.</p> </li> <li> <p> <code>Value</code> - The value to match.</p> </li> </ul> <p>For example, to list all monitors who's status is ACTIVE, you would specify:</p> <p> <code>"Filters": [ { "Condition": "IS", "Key": "Status", "Value": "ACTIVE" } ]</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.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_forecast.types.list_monitors_request.ListMonitorsRequest]",
    ) -> AsyncOperationResponse[
        "capo_forecast.types.list_monitors_response.ListMonitorsResponse"
    ]:
        import capo_forecast._operations.amazon_forecast.list_monitors

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListMonitors")
    )
    input_: capo_forecast.types.list_monitors_request.ListMonitorsRequest = {}
    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

list_monitors async ¶

list_monitors `async` ¶