DatabaseMigrationService / Client / start_metadata_model_assessment

start_metadata_model_assessment

DatabaseMigrationService.Client.start_metadata_model_assessment(**kwargs)

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

The assessment 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.

To check the status of the assessment request, call DescribeMetadataModelAssessments using the returned RequestIdentifier as a filter.

To export the conversion assessment report after the request completes successfully, call ExportMetadataModelAssessment.

Required permissions: dms:StartMetadataModelAssessment. 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_assessment(
    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 assess. 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 assessment 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