Skip to content

Returns detailed information for a stateful rule group

Description

Returns detailed information for a stateful rule group.

For active threat defense Amazon Web Services managed rule groups, this operation provides insight into the protections enabled by the rule group, based on Suricata rule metadata fields. Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.

To modify how threat information appears in summaries, use the SummaryConfiguration parameter in update_rule_group.

Usage

networkfirewall_describe_rule_group_summary(RuleGroupName, RuleGroupArn,
  Type)

Arguments

  • RuleGroupName

    The descriptive name of the rule group. You can't change the name of a rule group after you create it.

    You must specify the ARN or the name, and you can specify both.

  • RuleGroupArn

    Required. The Amazon Resource Name (ARN) of the rule group.

    You must specify the ARN or the name, and you can specify both.

  • Type

    The type of rule group you want a summary for. This is a required field.

    Valid value: STATEFUL

    Note that STATELESS exists but is not currently supported. If you provide STATELESS, an exception is returned.

Value

A list with the following syntax:

list(
  RuleGroupName = "string",
  Description = "string",
  Summary = list(
    RuleSummaries = list(
      list(
        SID = "string",
        Msg = "string",
        Metadata = "string"
      )
    )
  )
)

Request syntax

svc$describe_rule_group_summary(
  RuleGroupName = "string",
  RuleGroupArn = "string",
  Type = "STATELESS"|"STATEFUL"|"STATEFUL_DOMAIN"
)