Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

PreviewAgents

class Inspector.Paginator.PreviewAgents
paginator = client.get_paginator('preview_agents')
paginate(**kwargs)

Creates an iterator that will paginate through responses from Inspector.Client.preview_agents().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    previewAgentsArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters
  • previewAgentsArn (string) --

    [REQUIRED]

    The ARN of the assessment target whose agents you want to preview.

  • PaginationConfig (dict) --

    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.

Return type

dict

Returns

Response Syntax

{
    'agentPreviews': [
        {
            'hostname': 'string',
            'agentId': 'string',
            'autoScalingGroup': 'string',
            'agentHealth': 'HEALTHY'|'UNHEALTHY'|'UNKNOWN',
            'agentVersion': 'string',
            'operatingSystem': 'string',
            'kernelVersion': 'string',
            'ipv4Address': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • agentPreviews (list) --

      The resulting list of agents.

      • (dict) --

        Used as a response element in the PreviewAgents action.

        • hostname (string) --

          The hostname of the EC2 instance on which the Amazon Inspector Agent is installed.

        • agentId (string) --

          The ID of the EC2 instance where the agent is installed.

        • autoScalingGroup (string) --

          The Auto Scaling group for the EC2 instance where the agent is installed.

        • agentHealth (string) --

          The health status of the Amazon Inspector Agent.

        • agentVersion (string) --

          The version of the Amazon Inspector Agent.

        • operatingSystem (string) --

          The operating system running on the EC2 instance on which the Amazon Inspector Agent is installed.

        • kernelVersion (string) --

          The kernel version of the operating system running on the EC2 instance on which the Amazon Inspector Agent is installed.

        • ipv4Address (string) --

          The IP address of the EC2 instance on which the Amazon Inspector Agent is installed.

    • NextToken (string) --

      A token to resume pagination.