DatabaseMigrationService / Client / start_metadata_model_import

start_metadata_model_import

DatabaseMigrationService.Client.start_metadata_model_import(**kwargs)

Queues an import of metadata models (database objects such as tables, views, and procedures) from your data provider into the metadata tree. If other requests created by Start* operations are already in the migration project’s queue, the import begins after they complete.

To check the status of the import request, call DescribeMetadataModelImports using the returned RequestIdentifier as a filter.

Required permissions: dms:StartMetadataModelImport. 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_import(
    MigrationProjectIdentifier='string',
    SelectionRules='string',
    Origin='SOURCE'|'TARGET',
    Refresh=True|False
)
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 import from the data provider. For the selection rule format and examples, see Selection rules in DMS Schema Conversion.

    Usage:

    • Accepts source or target selection rules depending on the Origin parameter. The server-name in the object locator must match the corresponding data provider.

    • Supports explicit, include, and exclude rule actions.

  • Origin (string) –

    [REQUIRED]

    Specifies the metadata tree to import into.

    Note

    You cannot import from a virtual target data provider.

  • Refresh (boolean) –

    Specifies whether to refresh the selected metadata models from the data provider.

    When true, the import reloads the selected metadata models with current definitions and removes their existing subtree.

    When false (default), the import loads the full subtree that has not yet been loaded into the metadata tree.

Return type:

dict

Returns:

Response Syntax

{
    'RequestIdentifier': 'string'
}

Response Structure

  • (dict) –

    • RequestIdentifier (string) –

      The identifier for the import 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