list_automation_rules `async` ¶

list_automation_rules(
    *,
    config_overrides: Optional[AsyncComputeOptimizerAutomationClientConfig] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[int] = None,
    next_token: Optional[NextToken] = None,
) -> ListAutomationRulesResponse

Lists the automation rules that match specified filters.

Parameters:

filters (Optional[FilterList], default: None ) –

The filters to apply to the list of automation rules.
max_results (Optional[int], default: None ) –

The maximum number of automation rules to return in a single response. Valid range is 1-1000.
next_token (Optional[NextToken], default: None ) –

A token used for pagination to retrieve the next set of results when the response is truncated.

Raises:

AccessDeniedException –

You do not have sufficient permissions to perform this action.
ForbiddenException –

You are not authorized to perform this action.
InternalServerException –

An internal error occurred while processing the request.
InvalidParameterValueException –

One or more parameter values are not valid.
OptInRequiredException –

The account must be opted in to Compute Optimizer Automation before performing this action.
ServiceUnavailableException –

The service is temporarily unavailable.
ThrottlingException –

The request was denied due to request throttling.
UnknownServiceError –

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

Source code in docs_src/capo_compute_optimizer_automation/_services/async_compute_optimizer_automation.py

async def list_automation_rules(
    self,
    *,
    config_overrides: Optional[AsyncComputeOptimizerAutomationClientConfig] = None,
    filters: Optional[
        "capo_compute_optimizer_automation.types.filter_list.FilterList"
    ] = None,
    max_results: Optional[int] = None,
    next_token: Optional[
        "capo_compute_optimizer_automation.types.next_token.NextToken"
    ] = None,
) -> "capo_compute_optimizer_automation.types.list_automation_rules_response.ListAutomationRulesResponse":
    """<p> Lists the automation rules that match specified filters. </p>

    Args:
        filters: <p> The filters to apply to the list of automation rules. </p>
        max_results: <p>The maximum number of automation rules to return in a single response. Valid range is 1-1000.</p>
        next_token: <p>A token used for pagination to retrieve the next set of results when the response is truncated.</p>

    Raises:
        capo_compute_optimizer_automation.errors.access_denied_exception.AccessDeniedException: <p> You do not have sufficient permissions to perform this action. </p>
        capo_compute_optimizer_automation.errors.forbidden_exception.ForbiddenException: <p> You are not authorized to perform this action. </p>
        capo_compute_optimizer_automation.errors.internal_server_exception.InternalServerException: <p> An internal error occurred while processing the request. </p>
        capo_compute_optimizer_automation.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p> One or more parameter values are not valid. </p>
        capo_compute_optimizer_automation.errors.opt_in_required_exception.OptInRequiredException: <p> The account must be opted in to Compute Optimizer Automation before performing this action. </p>
        capo_compute_optimizer_automation.errors.service_unavailable_exception.ServiceUnavailableException: <p> The service is temporarily unavailable. </p>
        capo_compute_optimizer_automation.errors.throttling_exception.ThrottlingException: <p> The request was denied due to request throttling. </p>
        capo_compute_optimizer_automation.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_compute_optimizer_automation.types.list_automation_rules_request.ListAutomationRulesRequest]",
    ) -> AsyncOperationResponse[
        "capo_compute_optimizer_automation.types.list_automation_rules_response.ListAutomationRulesResponse"
    ]:
        import capo_compute_optimizer_automation._operations.compute_optimizer_automation_service.list_automation_rules

        (
            output,
            http_response,
        ) = await capo_compute_optimizer_automation._operations.compute_optimizer_automation_service.list_automation_rules.async_list_automation_rules(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListAutomationRules")
    )
    input_: capo_compute_optimizer_automation.types.list_automation_rules_request.ListAutomationRulesRequest = {}
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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

list_automation_rules async ¶

list_automation_rules `async` ¶