v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1436240246.3 KB

Returns the data objects for the specified rule group.

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

Headers

X-Amz-Target'NetworkFirewall_20201112.DescribeRuleGroup' required

Request body

RuleGroupNamestring
<p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
RuleGroupArnstring
<p>The Amazon Resource Name (ARN) of the rule group.</p> <p>You must specify the ARN or the name, and you can specify both. </p>
Type'STATELESS' | 'STATEFUL'
<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> <note> <p>This setting is required for requests that do not include the <code>RuleGroupARN</code>.</p> </note>

Response

Success

UpdateTokenstring required
<p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request. </p> <p>To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. </p>