mgn / Paginator / ListConnectors

ListConnectors

class mgn.Paginator.ListConnectors

paginator = client.get_paginator('list_connectors')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• filters (dict) –

  List Connectors Request filters.

  • connectorIDs (list) –

    List Connectors Request Filters connector IDs.

    • (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

{
    'items': [
        {
            'arn': 'string',
            'connectorID': 'string',
            'name': 'string',
            'ssmCommandConfig': {
                'cloudWatchLogGroupName': 'string',
                'cloudWatchOutputEnabled': True|False,
                'outputS3BucketName': 'string',
                's3OutputEnabled': True|False
            },
            'ssmInstanceID': 'string',
            'tags': {
                'string': 'string'
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    List connectors response items.

    • (dict) –

      • arn (string) –

        Connector arn.

      • connectorID (string) –

        Connector ID.

      • name (string) –

        Connector name.

      • ssmCommandConfig (dict) –

        Connector SSM command config.

        • cloudWatchLogGroupName (string) –

          Connector SSM command config CloudWatch log group name.

        • cloudWatchOutputEnabled (boolean) –

          Connector SSM command config CloudWatch output enabled.

        • outputS3BucketName (string) –

          Connector SSM command config output S3 bucket name.

        • s3OutputEnabled (boolean) –

          Connector SSM command config S3 output enabled.

      • ssmInstanceID (string) –

        Connector SSM instance ID.

      • tags (dict) –

        Connector tags.

        • (string) –

          • (string) –

  • NextToken (string) –

    A token to resume pagination.