ApplicationDiscoveryService / Paginator / DescribeAgents

DescribeAgents

class ApplicationDiscoveryService.Paginator.DescribeAgents

paginator = client.get_paginator('describe_agents')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ApplicationDiscoveryService.Client.describe_agents().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    agentIds=[
        'string',
    ],
    filters=[
        {
            'name': 'string',
            'values': [
                'string',
            ],
            'condition': 'string'
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• agentIds (list) –

  The agent or the collector IDs for which you want information. If you specify no IDs, the system returns information about all agents/collectors associated with your user.

  • (string) –

• filters (list) –

  You can filter the request using various logical operators and a key-value format. For example:

  {"key": "collectionStatus", "value": "STARTED"}

  • (dict) –

    A filter that can use conditional operators.

    For more information about filters, see Querying Discovered Configuration Items in the Amazon Web Services Application Discovery Service User Guide.

    • name (string) – [REQUIRED]

      The name of the filter.

    • values (list) – [REQUIRED]

      A string value on which to filter. For example, if you choose the destinationServer.osVersion filter name, you could specify Ubuntu for the value.

      • (string) –

    • condition (string) – [REQUIRED]

      A conditional operator. The following operators are valid: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS. If you specify multiple filters, the system utilizes all filters as though concatenated by AND. If you specify multiple values for a particular filter, the system differentiates the values using OR. Calling either DescribeConfigurations or ListConfigurations returns attributes of matching configuration items.

• 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

{
    'agentsInfo': [
        {
            'agentId': 'string',
            'hostName': 'string',
            'agentNetworkInfoList': [
                {
                    'ipAddress': 'string',
                    'macAddress': 'string'
                },
            ],
            'connectorId': 'string',
            'version': 'string',
            'health': 'HEALTHY'|'UNHEALTHY'|'RUNNING'|'UNKNOWN'|'BLACKLISTED'|'SHUTDOWN',
            'lastHealthPingTime': 'string',
            'collectionStatus': 'string',
            'agentType': 'string',
            'registeredTime': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • agentsInfo (list) –

    Lists agents or the collector by ID or lists all agents/collectors associated with your user, if you did not specify an agent/collector ID. The output includes agent/collector IDs, IP addresses, media access control (MAC) addresses, agent/collector health, host name where the agent/collector resides, and the version number of each agent/collector.

    • (dict) –

      Information about agents associated with the user’s Amazon Web Services account. Information includes agent IDs, IP addresses, media access control (MAC) addresses, agent or collector status, hostname where the agent resides, and agent version for each agent.

      • agentId (string) –

        The agent or collector ID.

      • hostName (string) –

        The name of the host where the agent or collector resides. The host can be a server or virtual machine.

      • agentNetworkInfoList (list) –

        Network details about the host where the agent or collector resides.

        • (dict) –

          Network details about the host where the agent/collector resides.

          • ipAddress (string) –

            The IP address for the host where the agent/collector resides.

          • macAddress (string) –

            The MAC address for the host where the agent/collector resides.

      • connectorId (string) –

        The ID of the connector.

      • version (string) –

        The agent or collector version.

      • health (string) –

        The health of the agent.

      • lastHealthPingTime (string) –

        Time since agent health was reported.

      • collectionStatus (string) –

        Status of the collection process for an agent.

      • agentType (string) –

        Type of agent.

      • registeredTime (string) –

        Agent’s first registration timestamp in UTC.

  • NextToken (string) –

    A token to resume pagination.