:doc:`SecurityHub <../../securityhub>` / Client / list_automation_rules_v2

************************
list_automation_rules_v2
************************



.. py:method:: SecurityHub.Client.list_automation_rules_v2(**kwargs)

  

  Returns a list of automation rules and metadata for the calling account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListAutomationRulesV2>`_  


  **Request Syntax**
  ::

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

    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.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return.

    

  
  
  :rtype: 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**
  
  *   :py:class:`SecurityHub.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`SecurityHub.Client.exceptions.InternalServerException`

  
  *   :py:class:`SecurityHub.Client.exceptions.ValidationException`

  
  *   :py:class:`SecurityHub.Client.exceptions.ThrottlingException`

  
  *   :py:class:`SecurityHub.Client.exceptions.ConflictException`

  