SMS / Paginator / GetConnectors

GetConnectors

class SMS.Paginator.GetConnectors

paginator = client.get_paginator('get_connectors')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SMS.Client.get_connectors().

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

{
    'connectorList': [
        {
            'connectorId': 'string',
            'version': 'string',
            'status': 'HEALTHY'|'UNHEALTHY',
            'capabilityList': [
                'VSPHERE'|'SCVMM'|'HYPERV-MANAGER'|'SNAPSHOT_BATCHING'|'SMS_OPTIMIZED',
            ],
            'vmManagerName': 'string',
            'vmManagerType': 'VSPHERE'|'SCVMM'|'HYPERV-MANAGER',
            'vmManagerId': 'string',
            'ipAddress': 'string',
            'macAddress': 'string',
            'associatedOn': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • connectorList (list) –

    Information about the registered connectors.

    • (dict) –

      Represents a connector.

      • connectorId (string) –

        The ID of the connector.

      • version (string) –

        The connector version.

      • status (string) –

        The status of the connector.

      • capabilityList (list) –

        The capabilities of the connector.

        • (string) –

      • vmManagerName (string) –

        The name of the VM manager.

      • vmManagerType (string) –

        The VM management product.

      • vmManagerId (string) –

        The ID of the VM manager.

      • ipAddress (string) –

        The IP address of the connector.

      • macAddress (string) –

        The MAC address of the connector.

      • associatedOn (datetime) –

        The time the connector was associated.

  • NextToken (string) –

    A token to resume pagination.