DataSync / Paginator / ListAgents

ListAgents

class DataSync.Paginator.ListAgents

paginator = client.get_paginator('list_agents')

paginate(**kwargs)

Creates an iterator that will paginate through responses from DataSync.Client.list_agents().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'Agents': [
        {
            'AgentArn': 'string',
            'Name': 'string',
            'Status': 'ONLINE'|'OFFLINE',
            'Platform': {
                'Version': 'string'
            }
        },
    ],

}

Response Structure

• (dict) –

  ListAgentsResponse

  • Agents (list) –

    A list of DataSync agents in your Amazon Web Services account in the Amazon Web Services Region specified in the request. The list is ordered by the agents’ Amazon Resource Names (ARNs).

    • (dict) –

      Represents a single entry in a list (or array) of DataSync agents when you call the ListAgents operation.

      • AgentArn (string) –

        The Amazon Resource Name (ARN) of a DataSync agent.

      • Name (string) –

        The name of an agent.

      • Status (string) –

        The status of an agent.

        • If the status is ONLINE, the agent is configured properly and ready to use.

        • If the status is OFFLINE, the agent has been out of contact with DataSync for five minutes or longer. This can happen for a few reasons. For more information, see What do I do if my agent is offline?

      • Platform (dict) –

        The platform-related details about the agent, such as the version number.

        • Version (string) –

          The version of the DataSync agent.