list_rule_groups ¶

def list_rule_groups(
    self,
    *,
    config_overrides: Optional[NetworkFirewallClientConfig] = None,
    next_token: Optional[
        "capo_network_firewall.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_network_firewall.types.pagination_max_results.PaginationMaxResults"
    ] = None,
    scope: Optional[
        "capo_network_firewall.types.resource_managed_status.ResourceManagedStatus"
    ] = None,
    managed_type: Optional[
        "capo_network_firewall.types.resource_managed_type.ResourceManagedType"
    ] = None,
    subscription_status: Optional[
        "capo_network_firewall.types.subscription_status.SubscriptionStatus"
    ] = None,
    type: Optional[
        "capo_network_firewall.types.rule_group_type.RuleGroupType"
    ] = None,
) -> "capo_network_firewall.types.list_rule_groups_response.ListRuleGroupsResponse":
    """<p>Retrieves the metadata for the rule groups that you have defined. Depending on your setting for max results and the number of rule groups, a single call might not return the full list. </p>

    Args:
        next_token: <p>When you request a list of objects with a <code>MaxResults</code> setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a <code>NextToken</code> value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.</p>
        max_results: <p>The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a <code>NextToken</code> value that you can use in a subsequent call to get the next batch of objects.</p>
        scope: <p>The scope of the request. The default setting of <code>ACCOUNT</code> or a setting of <code>NULL</code> returns all of the rule groups in your account. A setting of <code>MANAGED</code> returns all available managed rule groups.</p>
        managed_type: <p>Indicates the general category of the Amazon Web Services managed rule group.</p>
        subscription_status: <p>Filters the results to show only rule groups with the specified subscription status. Use this to find subscribed or unsubscribed rule groups.</p>
        type: <p>Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.</p>

    Raises:
        capo_network_firewall.errors.internal_server_error.InternalServerError: <p>Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request. </p>
        capo_network_firewall.errors.invalid_request_exception.InvalidRequestException: <p>The operation failed because of a problem with your request. Examples include: </p> <ul> <li> <p>You specified an unsupported parameter name or value.</p> </li> <li> <p>You tried to update a property with a value that isn't among the available types.</p> </li> <li> <p>Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.</p> </li> </ul>
        capo_network_firewall.errors.throttling_exception.ThrottlingException: <p>Unable to process the request due to throttling limitations.</p>
        capo_network_firewall.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_network_firewall.types.list_rule_groups_request.ListRuleGroupsRequest]",
    ) -> OperationResponse[
        "capo_network_firewall.types.list_rule_groups_response.ListRuleGroupsResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.list_rule_groups

        output, http_response = (
            capo_network_firewall._operations.network_firewall_20201112.list_rule_groups.list_rule_groups(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRuleGroups")
    )
    input_: capo_network_firewall.types.list_rule_groups_request.ListRuleGroupsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if scope is not None:
        input_["scope"] = scope
    if managed_type is not None:
        input_["managed_type"] = managed_type
    if subscription_status is not None:
        input_["subscription_status"] = subscription_status
    if type is not None:
        input_["type"] = type

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output