DatabaseMigrationService / Client / start_metadata_model_creation

start_metadata_model_creation

DatabaseMigrationService.Client.start_metadata_model_creation(**kwargs)

Queues the creation of a metadata model in the source metadata tree. If other requests created by Start* operations are already in the migration project’s queue, the creation begins after they complete.

Note

This operation supports only Microsoft SQL Server to Aurora PostgreSQL and Microsoft SQL Server to Amazon RDS for PostgreSQL conversion paths.

To check the status of the creation request, call DescribeMetadataModelCreations using the returned RequestIdentifier as a filter.

To cancel a queued or in-progress request, call CancelMetadataModelCreation with the returned RequestIdentifier.

Warning

Calling StartMetadataModelImport with Refresh deletes metadata models created by this operation.

After the creation completes successfully:

Required permissions: dms:StartMetadataModelCreation. For more information, see Actions, resources, and condition keys for Database Migration Service.

See also: AWS API Documentation

Request Syntax

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

  • MigrationProjectIdentifier (string) –

    [REQUIRED]

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

  • SelectionRules (string) –

    [REQUIRED]

    A JSON string that identifies the source schema for the metadata model. For the selection rule format and examples, see Selection rules in DMS Schema Conversion.

    Usage:

    • Accepts only source selection rules, where server-name in the object locator matches the source data provider.

    • Supports only explicit rule actions.

    • Exactly one rule is allowed.

  • MetadataModelName (string) –

    [REQUIRED]

    The name for the metadata model to use in subsequent operations.

  • Properties (dict) –

    [REQUIRED]

    The properties of the metadata model.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: StatementProperties.

    • StatementProperties (dict) –

      The properties of the SQL statement.

      • Definition (string) – [REQUIRED]

        The SQL text of the statement.

Return type:

dict

Returns:

Response Syntax

{
    'RequestIdentifier': 'string'
}

Response Structure

  • (dict) –

    • RequestIdentifier (string) –

      The identifier for the creation request.

Exceptions