NetworkSecurityManagerCustomerAPI / Client / list_rules

list_rules

NetworkSecurityManagerCustomerAPI.Client.list_rules(**kwargs)

Lists the rules in the account. You can filter the results by status and page through them using maxResults and nextToken.

See also: AWS API Documentation

Request Syntax

response = client.list_rules(
    maxResults=123,
    nextToken='string',
    status='ACTIVE'|'DRAFT'|'DISABLED'
)
Parameters:

  • maxResults (integer) – The maximum number of results to return in a single call. Valid range: 1-100. To retrieve the remaining results, use the returned nextToken value in a subsequent call.

  • nextToken (string) – The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.

  • status (string) – Filters the results by status, either ACTIVE or DRAFT.

Return type:

dict

Returns:

Response Syntax

{
    'nextToken': 'string',
    'rules': [
        {
            'ruleId': 'string',
            'ruleArn': 'string',
            'ruleName': 'string',
            'firewallType': 'WAF',
            'ruleType': 'CONFIGURATION'|'INSPECTION',
            'status': 'DRAFT'|'ACTIVE'|'DISABLED',
            'version': 'string',
            'hasPublishedVersion': True|False,
            'updatedAt': datetime(2015, 1, 1)
        },
    ]
}

Response Structure

  • (dict) –

    • nextToken (string) –

      The token for the next page of results. To retrieve the next page, call the operation again and provide this value. When there are no more results, this value is null.

    • rules (list) –

      The list of rules.

      • (dict) –

        Summary information about a rule.

        • ruleId (string) –

          The service-generated id of the rule.

        • ruleArn (string) –

          The Amazon Resource Name (ARN) of the rule.

        • ruleName (string) –

          The name of the rule.

        • firewallType (string) –

          The firewall type associated with the resource.

        • ruleType (string) –

          The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.

        • status (string) –

          The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).

        • version (string) –

          The version of the resource.

        • hasPublishedVersion (boolean) –

          Specifies whether a published version of the resource exists.

        • updatedAt (datetime) –

          The time when the resource was last updated. For a snapshot, this is the time when the snapshot was created.

Exceptions