list_rules `async` ¶

list_rules(
    *,
    config_overrides: Optional[AsyncWAFClientConfig] = None,
    next_marker: Optional[NextMarker] = None,
    limit: Optional[PaginationLimit] = None,
) -> ListRulesResponse

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of RuleSummary objects.

Parameters:

next_marker (Optional[NextMarker], default: None ) –

If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.
limit (Optional[PaginationLimit], default: None ) –

Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

Raises:

WAFInternalErrorException –

The operation failed because of a system problem, even though the request was valid. Retry your request.
WAFInvalidAccountException –

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
UnknownServiceError –

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

Examples:

To list rules The following example returns an array of up to 100 rules.

>>> await client.list_rules(limit=100)

Source code in docs_src/capo_waf/_services/async_waf.py

async def list_rules(
    self,
    *,
    config_overrides: Optional[AsyncWAFClientConfig] = None,
    next_marker: Optional["capo_waf.types.next_marker.NextMarker"] = None,
    limit: Optional["capo_waf.types.pagination_limit.PaginationLimit"] = None,
) -> "capo_waf.types.list_rules_response.ListRulesResponse":
    """<note> <p>This is <b>AWS WAF Classic</b> documentation. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS WAF Classic</a> in the developer guide.</p> <p> <b>For the latest version of AWS WAF</b>, use the AWS WAFV2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. With the latest version, AWS WAF has a single set of endpoints for regional and global use. </p> </note> <p>Returns an array of <a>RuleSummary</a> objects.</p>

    Args:
        next_marker: <p>If you specify a value for <code>Limit</code> and you have more <code>Rules</code> than the value of <code>Limit</code>, AWS WAF returns a <code>NextMarker</code> value in the response that allows you to list another group of <code>Rules</code>. For the second and subsequent <code>ListRules</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of <code>Rules</code>.</p>
        limit: <p>Specifies the number of <code>Rules</code> that you want AWS WAF to return for this request. If you have more <code>Rules</code> than the number that you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of <code>Rules</code>.</p>

    Raises:
        capo_waf.errors.waf_internal_error_exception.WAFInternalErrorException: <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
        capo_waf.errors.waf_invalid_account_exception.WAFInvalidAccountException: <p>The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.</p>
        capo_waf.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To list rules
        The following example returns an array of up to 100 rules.

        >>> await client.list_rules(limit=100)
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_waf.types.list_rules_request.ListRulesRequest]",
    ) -> AsyncOperationResponse[
        "capo_waf.types.list_rules_response.ListRulesResponse"
    ]:
        import capo_waf._operations.awswaf_20150824.list_rules

        (
            output,
            http_response,
        ) = await capo_waf._operations.awswaf_20150824.list_rules.async_list_rules(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRules")
    )
    input_: capo_waf.types.list_rules_request.ListRulesRequest = {}
    if next_marker is not None:
        input_["next_marker"] = next_marker
    if limit is not None:
        input_["limit"] = limit

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

list_rules async ¶

list_rules `async` ¶