DatabaseMigrationService / Client / start_metadata_model_conversion

start_metadata_model_conversion

DatabaseMigrationService.Client.start_metadata_model_conversion(**kwargs)

Queues a conversion of the selected source metadata models (database objects such as tables, views, and procedures) to the target database format. If other requests created by Start* operations are already in the migration project’s queue, the conversion begins after they complete.

The conversion request loads metadata models that are not yet in the metadata tree, but does not reload metadata models that are already present. If your source database has changed since the metadata was loaded, refresh the affected metadata models with StartMetadataModelImport before calling this operation.

Note

If converted objects already exist in the target metadata tree, the conversion overwrites them, including any manual edits.

To check the status of the conversion request, call DescribeMetadataModelConversions using the returned RequestIdentifier as a filter.

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

After the conversion completes successfully:

• To export a post-conversion assessment report, call ExportMetadataModelAssessment.

• To retrieve converted code, use any of the following options:

  • DescribeMetadataModel and DescribeMetadataModelChildren – navigate the target metadata tree and retrieve converted definitions.

  • StartMetadataModelExportAsScript – export as data definition language (DDL) scripts to your Amazon S3 bucket.

  • StartMetadataModelExportToTarget – apply directly to your target database.

Required permissions: dms:StartMetadataModelConversion. 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_conversion(
    MigrationProjectIdentifier='string',
    SelectionRules='string'
)

Parameters:

• MigrationProjectIdentifier (string) –

  [REQUIRED]

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

• SelectionRules (string) –

  [REQUIRED]

  A JSON string that identifies the metadata models to convert. 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 explicit, include, and exclude rule actions.

Return type:

dict

Returns:

Response Syntax

{
    'RequestIdentifier': 'string'
}

Response Structure

• (dict) –

  • RequestIdentifier (string) –

    The identifier for the conversion request.

Exceptions

• DatabaseMigrationService.Client.exceptions.AccessDeniedFault

• DatabaseMigrationService.Client.exceptions.InvalidResourceStateFault

• DatabaseMigrationService.Client.exceptions.ResourceAlreadyExistsFault

• DatabaseMigrationService.Client.exceptions.ResourceNotFoundFault

• DatabaseMigrationService.Client.exceptions.KMSKeyNotAccessibleFault

• DatabaseMigrationService.Client.exceptions.ResourceQuotaExceededFault

• DatabaseMigrationService.Client.exceptions.S3ResourceNotFoundFault

• DatabaseMigrationService.Client.exceptions.S3AccessDeniedFault