ListRuleGroupsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { NetworkFirewallClient, ListRuleGroupsCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import
// const { NetworkFirewallClient, ListRuleGroupsCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import
const client = new NetworkFirewallClient(config);
const input = { // ListRuleGroupsRequest
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
  Scope: "MANAGED" || "ACCOUNT",
  ManagedType: "AWS_MANAGED_THREAT_SIGNATURES" || "AWS_MANAGED_DOMAIN_LISTS",
  Type: "STATELESS" || "STATEFUL",
};
const command = new ListRuleGroupsCommand(input);
const response = await client.send(command);
// { // ListRuleGroupsResponse
//   NextToken: "STRING_VALUE",
//   RuleGroups: [ // RuleGroups
//     { // RuleGroupMetadata
//       Name: "STRING_VALUE",
//       Arn: "STRING_VALUE",
//     },
//   ],
// };

ListRuleGroupsCommand Input

See ListRuleGroupsCommandInput for more details

Parameter
Type
Description
ManagedType
ResourceManagedType | undefined

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

MaxResults
number | undefined

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 NextToken value that you can use in a subsequent call to get the next batch of objects.

NextToken
string | undefined

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

Scope
ResourceManagedStatus | undefined

The scope of the request. The default setting of ACCOUNT or a setting of NULL returns all of the rule groups in your account. A setting of MANAGED returns all available managed rule groups.

Type
RuleGroupType | undefined

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.

ListRuleGroupsCommand Output

See ListRuleGroupsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

RuleGroups
RuleGroupMetadata[] | undefined

The rule group metadata objects that you've defined. Depending on your setting for max results and the number of rule groups, this might not be the full list.

Throws

Name
Fault
Details
InternalServerError
server

Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

InvalidRequestException
client

The operation failed because of a problem with your request. Examples include:

  • You specified an unsupported parameter name or value.

  • You tried to update a property with a value that isn't among the available types.

  • Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

ThrottlingException
client

Unable to process the request due to throttling limitations.

NetworkFirewallServiceException
Base exception class for all service exceptions from NetworkFirewall service.