Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1436240246.3 KB

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.

post/#X-Amz-Target=NetworkFirewall_20201112.ListRuleGroups

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'NetworkFirewall_20201112.ListRuleGroups' required

Request body

NextTokenstring

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.

MaxResultsinteger

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.

Scope'MANAGED' | 'ACCOUNT'

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.

ManagedType'AWS_MANAGED_THREAT_SIGNATURES' | 'AWS_MANAGED_DOMAIN_LISTS'

Indicates the general category of the Amazon Web Services managed rule group.

Type'STATELESS' | 'STATEFUL'

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.

Response

Success

NextTokenstring

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.