:doc:`Inspector <../../inspector>` / Paginator / ListAssessmentRunAgents

***********************
ListAssessmentRunAgents
***********************



.. py:class:: Inspector.Paginator.ListAssessmentRunAgents

  ::

    
    paginator = client.get_paginator('list_assessment_run_agents')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`Inspector.Client.list_assessment_run_agents`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/inspector-2016-02-16/ListAssessmentRunAgents>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          assessmentRunArn='string',
          filter={
              'agentHealths': [
                  'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
              ],
              'agentHealthCodes': [
                  'IDLE'|'RUNNING'|'SHUTDOWN'|'UNHEALTHY'|'THROTTLED'|'UNKNOWN',
              ]
          },
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type assessmentRunArn: string
    :param assessmentRunArn: **[REQUIRED]** 

      The ARN that specifies the assessment run whose agents you want to list.

      

    
    :type filter: dict
    :param filter: 

      You can use this parameter to specify a subset of data to be included in the action's response.

       

      For a record to match a filter, all specified filter attributes must match. When multiple values are specified for a filter attribute, any of the values can match.

      

    
      - **agentHealths** *(list) --* **[REQUIRED]** 

        The current health state of the agent. Values can be set to **HEALTHY** or **UNHEALTHY**.

        

      
        - *(string) --* 

        
    
      - **agentHealthCodes** *(list) --* **[REQUIRED]** 

        The detailed health state of the agent. Values can be set to **IDLE**, **RUNNING**, **SHUTDOWN**, **UNHEALTHY**, **THROTTLED**, and **UNKNOWN**.

        

      
        - *(string) --* 

        
    
    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'assessmentRunAgents': [
                {
                    'agentId': 'string',
                    'assessmentRunArn': 'string',
                    'agentHealth': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
                    'agentHealthCode': 'IDLE'|'RUNNING'|'SHUTDOWN'|'UNHEALTHY'|'THROTTLED'|'UNKNOWN',
                    'agentHealthDetails': 'string',
                    'autoScalingGroup': 'string',
                    'telemetryMetadata': [
                        {
                            'messageType': 'string',
                            'count': 123,
                            'dataSize': 123
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **assessmentRunAgents** *(list) --* 

          A list of ARNs that specifies the agents returned by the action.

          
          

          - *(dict) --* 

            Contains information about an Amazon Inspector agent. This data type is used as a response element in the  ListAssessmentRunAgents action.

            
            

            - **agentId** *(string) --* 

              The AWS account of the EC2 instance where the agent is installed.

              
            

            - **assessmentRunArn** *(string) --* 

              The ARN of the assessment run that is associated with the agent.

              
            

            - **agentHealth** *(string) --* 

              The current health state of the agent.

              
            

            - **agentHealthCode** *(string) --* 

              The detailed health state of the agent.

              
            

            - **agentHealthDetails** *(string) --* 

              The description for the agent health code.

              
            

            - **autoScalingGroup** *(string) --* 

              The Auto Scaling group of the EC2 instance that is specified by the agent ID.

              
            

            - **telemetryMetadata** *(list) --* 

              The Amazon Inspector application data metrics that are collected by the agent.

              
              

              - *(dict) --* 

                The metadata about the Amazon Inspector application data metrics collected by the agent. This data type is used as the response element in the  GetTelemetryMetadata action.

                
                

                - **messageType** *(string) --* 

                  A specific type of behavioral data that is collected by the agent.

                  
                

                - **count** *(integer) --* 

                  The count of messages that the agent sends to the Amazon Inspector service.

                  
                

                - **dataSize** *(integer) --* 

                  The data size of messages that the agent sends to the Amazon Inspector service.

                  
            
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    