Route53Resolver / Client / get_firewall_rule_group

get_firewall_rule_group#

Route53Resolver.Client.get_firewall_rule_group(**kwargs)#

Retrieves the specified firewall rule group.

See also: AWS API Documentation

Request Syntax

response = client.get_firewall_rule_group(
    FirewallRuleGroupId='string'
)
Parameters:

FirewallRuleGroupId (string) –

[REQUIRED]

The unique identifier of the firewall rule group.

Return type:

dict

Returns:

Response Syntax

{
    'FirewallRuleGroup': {
        'Id': 'string',
        'Arn': 'string',
        'Name': 'string',
        'RuleCount': 123,
        'Status': 'COMPLETE'|'DELETING'|'UPDATING',
        'StatusMessage': 'string',
        'OwnerId': 'string',
        'CreatorRequestId': 'string',
        'ShareStatus': 'NOT_SHARED'|'SHARED_WITH_ME'|'SHARED_BY_ME',
        'CreationTime': 'string',
        'ModificationTime': 'string'
    }
}

Response Structure

  • (dict) –

    • FirewallRuleGroup (dict) –

      A collection of rules used to filter DNS network traffic.

      • Id (string) –

        The ID of the rule group.

      • Arn (string) –

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

      • Name (string) –

        The name of the rule group.

      • RuleCount (integer) –

        The number of rules in the rule group.

      • Status (string) –

        The status of the domain list.

      • StatusMessage (string) –

        Additional information about the status of the rule group, if available.

      • OwnerId (string) –

        The Amazon Web Services account ID for the account that created the rule group. When a rule group is shared with your account, this is the account that has shared the rule group with you.

      • CreatorRequestId (string) –

        A unique string defined by you to identify the request. This allows you to retry failed requests without the risk of running the operation twice. This can be any unique string, for example, a timestamp.

      • ShareStatus (string) –

        Whether the rule group is shared with other Amazon Web Services accounts, or was shared with the current account by another Amazon Web Services account. Sharing is configured through Resource Access Manager (RAM).

      • CreationTime (string) –

        The date and time that the rule group was created, in Unix time format and Coordinated Universal Time (UTC).

      • ModificationTime (string) –

        The date and time that the rule group was last modified, in Unix time format and Coordinated Universal Time (UTC).

Exceptions