SecurityHub / Client / list_automation_rules_v2

list_automation_rules_v2¶

SecurityHub.Client.list_automation_rules_v2(**kwargs)¶

Returns a list of automation rules and metadata for the calling account. This API is in private preview and subject to change.

Request Syntax

response = client.list_automation_rules_v2(
    NextToken='string',
    MaxResults=123
)

Parameters:

NextToken (string) – The token required for pagination. On your first call, set the value of this parameter to NULL. For subsequent calls, to continue listing data, set the value of this parameter to the value returned in the previous response.
MaxResults (integer) – The maximum number of results to return.

Return type:

dict

Returns:

Response Syntax

{
    'Rules': [
        {
            'RuleArn': 'string',
            'RuleId': 'string',
            'RuleOrder': ...,
            'RuleName': 'string',
            'RuleStatus': 'ENABLED'|'DISABLED',
            'Description': 'string',
            'Actions': [
                {
                    'Type': 'FINDING_FIELDS_UPDATE'|'EXTERNAL_INTEGRATION'
                },
            ],
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Rules (list) –
  
  An array of automation rules.
  - (dict) –
    
    Includes essential metadata information about automation rules.
    - RuleArn (string) –
      
      The ARN of the automation rule.
    - RuleId (string) –
      
      The ID of the automation rule.
    - RuleOrder (float) –
      
      The value for the rule priority.
    - RuleName (string) –
      
      The name of the automation rule.
    - RuleStatus (string) –
      
      The status of the automation rule.
    - Description (string) –
      
      An explanation for the purpose and funcitonality of the automation rule.
    - Actions (list) –
      
      The list of action to be performed when the rule criteria is met.
      - (dict) –
        
        Allows you to customize security response workflows.
        
        Type (string) –
        
        The category of action to be executed by the automation rule.
    - CreatedAt (datetime) –
      
      The timestamp for when the automation rule was created.
    - UpdatedAt (datetime) –
      
      The timestamp for the most recent modification to the automation rule.
- NextToken (string) –
  
  The pagination token to use to request the next page of results. Otherwise, this parameter is null.

Exceptions

SecurityHub.Client.exceptions.AccessDeniedException
SecurityHub.Client.exceptions.InternalServerException
SecurityHub.Client.exceptions.ValidationException
SecurityHub.Client.exceptions.ThrottlingException
SecurityHub.Client.exceptions.ConflictException