ConfigService / Paginator / ListConnectors

ListConnectors

class ConfigService.Paginator.ListConnectors

paginator = client.get_paginator('list_connectors')

paginate(**kwargs)

Creates an iterator that will paginate through responses from ConfigService.Client.list_connectors().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    Filters=[
        {
            'filterName': 'provider',
            'filterValues': [
                'string',
            ]
        },
    ],
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• Filters (list) –

  Filters the results based on a list of ConnectorFilter objects that you specify.

  • (dict) –

    Filters connectors based on the connector provider.

    • filterName (string) –

      The name of the filter. Currently, only provider is supported.

    • filterValues (list) –

      The value of the filter. For provider, valid values include: AZURE.

      • (string) –

• 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

{
    'ConnectorSummaries': [
        {
            'arn': 'string',
            'name': 'string',
            'provider': 'AZURE',
            'tenantIdentifier': 'string',
            'createdTime': datetime(2015, 1, 1)
        },
    ],

}

Response Structure

• (dict) –

  • ConnectorSummaries (list) –

    A list of ConnectorSummary objects.

    • (dict) –

      A summary of a connector.

      • arn (string) –

        The Amazon Resource Name (ARN) of the connector.

      • name (string) –

        The name of the connector.

      • provider (string) –

        The third-party cloud service provider. Currently, AZURE is supported.

      • tenantIdentifier (string) –

        The Azure tenant identifier for the connector.

      • createdTime (datetime) –

        The date and time that the connector was created.