NetworkFirewall / Client / describe_rule_group_summary

describe_rule_group_summary

NetworkFirewall.Client.describe_rule_group_summary(**kwargs)

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 UpdateRuleGroup.

See also: AWS API Documentation

Request Syntax

response = client.describe_rule_group_summary(
    RuleGroupName='string',
    RuleGroupArn='string',
    Type='STATELESS'|'STATEFUL'
)
Parameters:

  • RuleGroupName (string) –

    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 (string) –

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

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

  • Type (string) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'RuleGroupName': 'string',
    'Description': 'string',
    'Summary': {
        'RuleSummaries': [
            {
                'SID': 'string',
                'Msg': 'string',
                'Metadata': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • RuleGroupName (string) –

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

    • Description (string) –

      A description of the rule group.

    • Summary (dict) –

      A complex type that contains rule information based on the rule group’s configured summary settings. The content varies depending on the fields that you specified to extract in your SummaryConfiguration. When you haven’t configured any summary settings, this returns an empty array. The response might include:

      • Rule identifiers

      • Rule descriptions

      • Any metadata fields that you specified in your SummaryConfiguration

      • RuleSummaries (list) –

        An array of RuleSummary objects containing individual rule details that had been configured by the rulegroup’s SummaryConfiguration.

        • (dict) –

          A complex type containing details about a Suricata rule. Contains:

          • SID

          • Msg

          • Metadata

          Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups.

          • SID (string) –

            The unique identifier (Signature ID) of the Suricata rule.

          • Msg (string) –

            The contents taken from the rule’s msg field.

          • Metadata (string) –

            The contents of the rule’s metadata.

Exceptions