AWS Database Migration Service

2025/11/12 - AWS Database Migration Service - 7 new api methods

Changes  Added support of SQL statements creation, metadata model discovery and selection rules transformation.

CancelMetadataModelCreation (new) Link ¶

Cancels a single metadata model creation operation that was started with StartMetadataModelCreation.

See also: AWS API Documentation

Request Syntax

client.cancel_metadata_model_creation(
    MigrationProjectIdentifier='string',
    RequestIdentifier='string'
)
type MigrationProjectIdentifier:

string

param MigrationProjectIdentifier:

[REQUIRED]

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

type RequestIdentifier:

string

param RequestIdentifier:

[REQUIRED]

The identifier for the metadata model creation operation to cancel. This operation was initiated by StartMetadataModelCreation.

rtype:

dict

returns:

Response Syntax

{
    'Request': {
        'Status': 'string',
        'RequestIdentifier': 'string',
        'MigrationProjectArn': 'string',
        'Error': {
            'defaultErrorDetails': {
                'Message': 'string'
            }
        },
        'ExportSqlDetails': {
            'S3ObjectKey': 'string',
            'ObjectURL': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Request (dict) --

      Provides information about a schema conversion action.

      • Status (string) --

        The schema conversion action status.

      • RequestIdentifier (string) --

        The identifier for the schema conversion action.

      • MigrationProjectArn (string) --

        The migration project ARN.

      • Error (dict) --

        Provides error information about a project.

        • defaultErrorDetails (dict) --

          Error information about a project.

          • Message (string) --

            The error message.

      • ExportSqlDetails (dict) --

        Provides information about a metadata model assessment exported to SQL.

        • S3ObjectKey (string) --

          The Amazon S3 object key for the object containing the exported metadata model assessment.

        • ObjectURL (string) --

          The URL for the object containing the exported metadata model assessment.

CancelMetadataModelConversion (new) Link ¶

Cancels a single metadata model conversion operation that was started with StartMetadataModelConversion.

See also: AWS API Documentation

Request Syntax

client.cancel_metadata_model_conversion(
    MigrationProjectIdentifier='string',
    RequestIdentifier='string'
)
type MigrationProjectIdentifier:

string

param MigrationProjectIdentifier:

[REQUIRED]

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

type RequestIdentifier:

string

param RequestIdentifier:

[REQUIRED]

The identifier for the metadata model conversion operation to cancel. This operation was initiated by StartMetadataModelConversion.

rtype:

dict

returns:

Response Syntax

{
    'Request': {
        'Status': 'string',
        'RequestIdentifier': 'string',
        'MigrationProjectArn': 'string',
        'Error': {
            'defaultErrorDetails': {
                'Message': 'string'
            }
        },
        'ExportSqlDetails': {
            'S3ObjectKey': 'string',
            'ObjectURL': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • Request (dict) --

      Provides information about a schema conversion action.

      • Status (string) --

        The schema conversion action status.

      • RequestIdentifier (string) --

        The identifier for the schema conversion action.

      • MigrationProjectArn (string) --

        The migration project ARN.

      • Error (dict) --

        Provides error information about a project.

        • defaultErrorDetails (dict) --

          Error information about a project.

          • Message (string) --

            The error message.

      • ExportSqlDetails (dict) --

        Provides information about a metadata model assessment exported to SQL.

        • S3ObjectKey (string) --

          The Amazon S3 object key for the object containing the exported metadata model assessment.

        • ObjectURL (string) --

          The URL for the object containing the exported metadata model assessment.

DescribeMetadataModel (new) Link ¶

Gets detailed information about the specified metadata model, including its definition and corresponding converted objects in the target database if applicable.

See also: AWS API Documentation

Request Syntax

client.describe_metadata_model(
    SelectionRules='string',
    MigrationProjectIdentifier='string',
    Origin='SOURCE'|'TARGET'
)
type SelectionRules:

string

param SelectionRules:

[REQUIRED]

The JSON string that specifies which metadata model to retrieve. Only one selection rule with "rule-action": "explicit" can be provided. For more information, see Selection Rules in the DMS User Guide.

type MigrationProjectIdentifier:

string

param MigrationProjectIdentifier:

[REQUIRED]

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

type Origin:

string

param Origin:

[REQUIRED]

Specifies whether to retrieve metadata from the source or target tree. Valid values: SOURCE | TARGET

rtype:

dict

returns:

Response Syntax

{
    'MetadataModelName': 'string',
    'MetadataModelType': 'string',
    'TargetMetadataModels': [
        {
            'MetadataModelName': 'string',
            'SelectionRules': 'string'
        },
    ],
    'Definition': 'string'
}

Response Structure

  • (dict) --

    • MetadataModelName (string) --

      The name of the metadata model.

    • MetadataModelType (string) --

      The type of the metadata model.

    • TargetMetadataModels (list) --

      A list of counterpart metadata models in the target. This field is populated only when Origin is SOURCE and after the object has been converted by DMS Schema Conversion.

      • (dict) --

        A reference to a metadata model, including its name and selection rules for location identification.

        • MetadataModelName (string) --

          The name of the metadata model.

        • SelectionRules (string) --

          The JSON string representing metadata model location.

    • Definition (string) --

      The SQL text of the metadata model. This field might not be populated for some metadata models.

DescribeMetadataModelCreations (new) Link ¶

Returns a paginated list of metadata model creation requests for a migration project.

See also: AWS API Documentation

Request Syntax

client.describe_metadata_model_creations(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    Marker='string',
    MaxRecords=123,
    MigrationProjectIdentifier='string'
)
type Filters:

list

param Filters:

Filters applied to the metadata model creation requests described in the form of key-value pairs. The supported filters are request-id and status.

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

type Marker:

string

param Marker:

Specifies the unique pagination token that makes it possible to display the next page of metadata model creation requests. If Marker is returned by a previous response, there are more metadata model creation requests available.

type MaxRecords:

integer

param MaxRecords:

The maximum number of metadata model creation requests to include in the response. If more requests exist than the specified MaxRecords value, a pagination token is provided in the response so that you can retrieve the remaining results.

type MigrationProjectIdentifier:

string

param MigrationProjectIdentifier:

[REQUIRED]

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

rtype:

dict

returns:

Response Syntax

{
    'Marker': 'string',
    'Requests': [
        {
            'Status': 'string',
            'RequestIdentifier': 'string',
            'MigrationProjectArn': 'string',
            'Error': {
                'defaultErrorDetails': {
                    'Message': 'string'
                }
            },
            'ExportSqlDetails': {
                'S3ObjectKey': 'string',
                'ObjectURL': 'string'
            }
        },
    ]
}

Response Structure

  • (dict) --

    • Marker (string) --

      Specifies the unique pagination token that makes it possible to display the next page of metadata model creation requests. If Marker is returned, there are more metadata model creation requests available.

    • Requests (list) --

      A list of metadata model creation requests. The ExportSqlDetails field will never be populated for the DescribeMetadataModelCreations operation.

      • (dict) --

        Provides information about a schema conversion action.

        • Status (string) --

          The schema conversion action status.

        • RequestIdentifier (string) --

          The identifier for the schema conversion action.

        • MigrationProjectArn (string) --

          The migration project ARN.

        • Error (dict) --

          Provides error information about a project.

          • defaultErrorDetails (dict) --

            Error information about a project.

            • Message (string) --

              The error message.

        • ExportSqlDetails (dict) --

          Provides information about a metadata model assessment exported to SQL.

          • S3ObjectKey (string) --

            The Amazon S3 object key for the object containing the exported metadata model assessment.

          • ObjectURL (string) --

            The URL for the object containing the exported metadata model assessment.

DescribeMetadataModelChildren (new) Link ¶

Gets a list of child metadata models for the specified metadata model in the database hierarchy.

See also: AWS API Documentation

Request Syntax

client.describe_metadata_model_children(
    SelectionRules='string',
    MigrationProjectIdentifier='string',
    Origin='SOURCE'|'TARGET',
    Marker='string',
    MaxRecords=123
)
type SelectionRules:

string

param SelectionRules:

[REQUIRED]

The JSON string that specifies which metadata model's children to retrieve. Only one selection rule with "rule-action": "explicit" can be provided. For more information, see Selection Rules in the DMS User Guide.

type MigrationProjectIdentifier:

string

param MigrationProjectIdentifier:

[REQUIRED]

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

type Origin:

string

param Origin:

[REQUIRED]

Specifies whether to retrieve metadata from the source or target tree. Valid values: SOURCE | TARGET

type Marker:

string

param Marker:

Specifies the unique pagination token that indicates where the next page should start. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

type MaxRecords:

integer

param MaxRecords:

The maximum number of metadata model children to include in the response. If more items exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

rtype:

dict

returns:

Response Syntax

{
    'Marker': 'string',
    'MetadataModelChildren': [
        {
            'MetadataModelName': 'string',
            'SelectionRules': 'string'
        },
    ]
}

Response Structure

  • (dict) --

    • Marker (string) --

      Specifies the unique pagination token that makes it possible to display the next page of metadata model children. If a marker is returned, there are more metadata model children available.

    • MetadataModelChildren (list) --

      A list of child metadata models.

      • (dict) --

        A reference to a metadata model, including its name and selection rules for location identification.

        • MetadataModelName (string) --

          The name of the metadata model.

        • SelectionRules (string) --

          The JSON string representing metadata model location.

StartMetadataModelCreation (new) Link ¶

Creates source metadata model of the given type with the specified properties for schema conversion operations.

See also: AWS API Documentation

Request Syntax

client.start_metadata_model_creation(
    MigrationProjectIdentifier='string',
    SelectionRules='string',
    MetadataModelName='string',
    Properties={
        'StatementProperties': {
            'Definition': 'string'
        }
    }
)
type MigrationProjectIdentifier:

string

param MigrationProjectIdentifier:

[REQUIRED]

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

type SelectionRules:

string

param SelectionRules:

[REQUIRED]

The JSON string that specifies the location where the metadata model will be created. Selection rules must specify a single schema. For more information, see Selection Rules in the DMS User Guide.

type MetadataModelName:

string

param MetadataModelName:

[REQUIRED]

The name of the metadata model.

type Properties:

dict

param Properties:

[REQUIRED]

The properties of metadata model in JSON format. This object is a Union. Only one member of this object can be specified or returned.

  • StatementProperties (dict) --

    The properties of the statement.

    • Definition (string) -- [REQUIRED]

      The SQL text of the statement.

rtype:

dict

returns:

Response Syntax

{
    'RequestIdentifier': 'string'
}

Response Structure

  • (dict) --

    • RequestIdentifier (string) --

      The identifier for the metadata model creation operation.

GetTargetSelectionRules (new) Link ¶

Converts source selection rules into their target counterparts for schema conversion operations.

See also: AWS API Documentation

Request Syntax

client.get_target_selection_rules(
    MigrationProjectIdentifier='string',
    SelectionRules='string'
)
type MigrationProjectIdentifier:

string

param MigrationProjectIdentifier:

[REQUIRED]

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

type SelectionRules:

string

param SelectionRules:

[REQUIRED]

The JSON string representing the source selection rules for conversion. Selection rules must contain only supported metadata model types. For more information, see Selection Rules in the DMS User Guide.

rtype:

dict

returns:

Response Syntax

{
    'TargetSelectionRules': 'string'
}

Response Structure

  • (dict) --

    • TargetSelectionRules (string) --

      The JSON string representing the counterpart selection rules in the target.