DatabaseMigrationService / Paginator / DescribeMetadataModelCreations

DescribeMetadataModelCreations

class DatabaseMigrationService.Paginator.DescribeMetadataModelCreations

paginator = client.get_paginator('describe_metadata_model_creations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• Filters (list) –

  The filters to apply to the metadata model creation requests.

  The following filter names are supported:

  • request-id – The request identifier.

  • status – The request status. Valid values: RECEIVED, IN_PROGRESS, SUCCESS, FAILED, CANCELING, CANCELED.

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

• MigrationProjectIdentifier (string) –

  [REQUIRED]

  The migration project name or Amazon Resource Name (ARN).

• 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

{
    'Requests': [
        {
            'Status': 'string',
            'RequestIdentifier': 'string',
            'MigrationProjectArn': 'string',
            'Error': {
                'defaultErrorDetails': {
                    'Message': 'string'
                }
            },
            'ExportSqlDetails': {
                'S3ObjectKey': 'string',
                'ObjectURL': 'string'
            },
            'Progress': {
                'ProgressPercent': 123.0,
                'TotalObjects': 123,
                'ProgressStep': 'string',
                'ProcessedObject': {
                    'Name': 'string',
                    'Type': 'string',
                    'EndpointType': 'string'
                }
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Requests (list) –

    A paginated list of metadata model creation requests.

    Note

    DMS never populates the ExportSqlDetails field for this operation.

    • (dict) –

      Provides information about a schema conversion action.

      • Status (string) –

        The schema conversion operation status. Possible values:

        • RECEIVED – The operation is received but not yet queued for processing.

        • IN_PROGRESS – The operation is queued or actively running.

        • SUCCESS – The operation completed successfully.

        • FAILED – The operation did not complete.

        • CANCELING – The operation is being canceled. The operation might still succeed or fail before cancellation takes effect.

        • CANCELED – The operation was canceled before completion.

      • RequestIdentifier (string) –

        The identifier for the schema conversion action.

      • MigrationProjectArn (string) –

        The migration project ARN.

      • Error (dict) –

        Provides error information about a project.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: defaultErrorDetails. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • defaultErrorDetails (dict) –

          Error information about a project.

          • Message (string) –

            The error message.

      • ExportSqlDetails (dict) –

        The Amazon S3 location of the ZIP archive that contains the exported data definition language (DDL) scripts.

        Note

        DMS populates this field only for the DescribeMetadataModelExportsAsScript operation.

        • S3ObjectKey (string) –

          The Amazon S3 URI of the object that contains the ZIP archive with exported DDL scripts.

        • ObjectURL (string) –

          The URL of the Amazon S3 object that contains the ZIP archive with exported DDL scripts.

      • Progress (dict) –

        Provides information about the progress of the schema conversion operation.

        • ProgressPercent (float) –

          The percent complete for the current step of the schema conversion operation.

        • TotalObjects (integer) –

          The number of objects in this schema conversion operation.

        • ProgressStep (string) –

          The step of the schema conversion operation. This parameter can store one of the following values:

          • IN_PROGRESS – The operation is running.

          • LOADING_METADATA – Loads metadata from the source database.

          • COUNTING_OBJECTS – Determines the number of objects involved in the operation.

          • ANALYZING – Analyzes the source database objects.

          • CONVERTING – Converts the source database objects to a format compatible with the target database.

          • APPLYING – Applies the converted code to the target database.

          • FINISHED – The operation completed successfully.

        • ProcessedObject (dict) –

          The name of the database object that the schema conversion operation currently uses.

          • Name (string) –

            The name of the database object.

          • Type (string) –

            The type of the database object. For example, a table, view, procedure, and so on.

          • EndpointType (string) –

            The type of the data provider. This parameter can store one of the following values: "SOURCE" or "TARGET".

  • NextToken (string) –

    A token to resume pagination.