list_subscribed_rule_groups `async` ¶

list_subscribed_rule_groups(
    *,
    config_overrides: Optional[AsyncWAFRegionalClientConfig] = None,
    next_marker: Optional[NextMarker] = None,
    limit: Optional[PaginationLimit] = None,
) -> ListSubscribedRuleGroupsResponse

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 RuleGroup objects that you are subscribed to.

Parameters:

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

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

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

Raises:

WAFInternalErrorException –

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

The operation failed because the referenced object doesn't exist.
UnknownServiceError –

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

Source code in docs_src/capo_waf_regional/_services/async_waf_regional.py

async def list_subscribed_rule_groups(
    self,
    *,
    config_overrides: Optional[AsyncWAFRegionalClientConfig] = None,
    next_marker: Optional["capo_waf_regional.types.next_marker.NextMarker"] = None,
    limit: Optional[
        "capo_waf_regional.types.pagination_limit.PaginationLimit"
    ] = None,
) -> "capo_waf_regional.types.list_subscribed_rule_groups_response.ListSubscribedRuleGroupsResponse":
    """<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>RuleGroup</a> objects that you are subscribed to.</p>

    Args:
        next_marker: <p>If you specify a value for <code>Limit</code> and you have more <code>ByteMatchSets</code>subscribed rule groups 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 subscribed rule groups. For the second and subsequent <code>ListSubscribedRuleGroupsRequest</code> requests, specify the value of <code>NextMarker</code> from the previous response to get information about another batch of subscribed rule groups.</p>
        limit: <p>Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for <code>Limit</code>, the response includes a <code>NextMarker</code> value that you can use to get another batch of objects.</p>

    Raises:
        capo_waf_regional.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_regional.errors.waf_nonexistent_item_exception.WAFNonexistentItemException: <p>The operation failed because the referenced object doesn't exist.</p>
        capo_waf_regional.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_waf_regional.types.list_subscribed_rule_groups_request.ListSubscribedRuleGroupsRequest]",
    ) -> AsyncOperationResponse[
        "capo_waf_regional.types.list_subscribed_rule_groups_response.ListSubscribedRuleGroupsResponse"
    ]:
        import capo_waf_regional._operations.awswaf_regional_20161128.list_subscribed_rule_groups

        (
            output,
            http_response,
        ) = await capo_waf_regional._operations.awswaf_regional_20161128.list_subscribed_rule_groups.async_list_subscribed_rule_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListSubscribedRuleGroups")
    )
    input_: capo_waf_regional.types.list_subscribed_rule_groups_request.ListSubscribedRuleGroupsRequest = {}
    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_subscribed_rule_groups async ¶

list_subscribed_rule_groups `async` ¶