DatabaseMigrationService / Paginator / DescribeEndpointTypes

DescribeEndpointTypes

class DatabaseMigrationService.Paginator.DescribeEndpointTypes

paginator = client.get_paginator('describe_endpoint_types')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• Filters (list) –

  Filters applied to the endpoint types.

  Valid filter names: engine-name | endpoint-type

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

dict

Returns:

Response Syntax

{
    'SupportedEndpointTypes': [
        {
            'EngineName': 'string',
            'SupportsCDC': True|False,
            'EndpointType': 'source'|'target',
            'ReplicationInstanceEngineMinimumVersion': 'string',
            'EngineDisplayName': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • SupportedEndpointTypes (list) –

    The types of endpoints that are supported.

    • (dict) –

      Provides information about types of supported endpoints in response to a request by the DescribeEndpointTypes operation. This information includes the type of endpoint, the database engine name, and whether change data capture (CDC) is supported.

      • EngineName (string) –

        The database engine name. Valid values, depending on the EndpointType, include "mysql", "oracle", "postgres", "mariadb", "aurora", "aurora-postgresql", "redshift", "s3", "db2", "db2-zos", "azuredb", "sybase", "dynamodb", "mongodb", "kinesis", "kafka", "elasticsearch", "documentdb", "sqlserver", "neptune", and "babelfish".

      • SupportsCDC (boolean) –

        Indicates if change data capture (CDC) is supported.

      • EndpointType (string) –

        The type of endpoint. Valid values are source and target.

      • ReplicationInstanceEngineMinimumVersion (string) –

        The earliest DMS engine version that supports this endpoint engine. Note that endpoint engines released with DMS versions earlier than 3.1.1 do not return a value for this parameter.

      • EngineDisplayName (string) –

        The expanded name for the engine name. For example, if the EngineName parameter is “aurora”, this value would be “Amazon Aurora MySQL”.

  • NextToken (string) –

    A token to resume pagination.