MigrationHubOrchestrator / Paginator / ListPlugins

ListPlugins

class MigrationHubOrchestrator.Paginator.ListPlugins

paginator = client.get_paginator('list_plugins')

paginate(**kwargs)

Creates an iterator that will paginate through responses from MigrationHubOrchestrator.Client.list_plugins().

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

{
    'plugins': [
        {
            'pluginId': 'string',
            'hostname': 'string',
            'status': 'HEALTHY'|'UNHEALTHY',
            'ipAddress': 'string',
            'version': 'string',
            'registeredTime': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • plugins (list) –

    Migration Hub Orchestrator plugins.

    • (dict) –

      The summary of the Migration Hub Orchestrator plugin.

      • pluginId (string) –

        The ID of the plugin.

      • hostname (string) –

        The name of the host.

      • status (string) –

        The status of the plugin.

      • ipAddress (string) –

        The IP address at which the plugin is located.

      • version (string) –

        The version of the plugin.

      • registeredTime (string) –

        The time at which the plugin was registered.

  • NextToken (string) –

    A token to resume pagination.