DatabaseMigrationService / Paginator / DescribeConnections


class DatabaseMigrationService.Paginator.DescribeConnections#
paginator = client.get_paginator('describe_connections')

Creates an iterator that will paginate through responses from DatabaseMigrationService.Client.describe_connections().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
            'Name': 'string',
            'Values': [
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • Filters (list) –

    The filters applied to the connection.

    Valid filter names: endpoint-arn | replication-instance-arn

    • (dict) –

      Identifies the name and value of a filter object. This filter is used to limit the number and type of DMS objects that are returned for a particular Describe* call or similar operation. Filters are used as an optional parameter for certain API operations.

      • Name (string) – [REQUIRED]

        The name of the filter as specified for a Describe* or similar operation.

      • Values (list) – [REQUIRED]

        The filter value, which can specify one or more values used to narrow the returned results.

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



Response Syntax

    'Connections': [
            'ReplicationInstanceArn': 'string',
            'EndpointArn': 'string',
            'Status': 'string',
            'LastFailureMessage': 'string',
            'EndpointIdentifier': 'string',
            'ReplicationInstanceIdentifier': 'string'
    'NextToken': 'string'

Response Structure

  • (dict) –

    • Connections (list) –

      A description of the connections.

      • (dict) –

        Status of the connection between an endpoint and a replication instance, including Amazon Resource Names (ARNs) and the last error message issued.

        • ReplicationInstanceArn (string) –

          The ARN of the replication instance.

        • EndpointArn (string) –

          The ARN string that uniquely identifies the endpoint.

        • Status (string) –

          The connection status. This parameter can return one of the following values:

          • "successful"

          • "testing"

          • "failed"

          • "deleting"

        • LastFailureMessage (string) –

          The error message when the connection last failed.

        • EndpointIdentifier (string) –

          The identifier of the endpoint. Identifiers must begin with a letter and must contain only ASCII letters, digits, and hyphens. They can’t end with a hyphen or contain two consecutive hyphens.

        • ReplicationInstanceIdentifier (string) –

          The replication instance identifier. This parameter is stored as a lowercase string.

    • NextToken (string) –

      A token to resume pagination.