StartMetadataModelImport - Amazon Database Migration Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Loads the metadata for all the dependent database objects of the parent object.

This operation uses your project's Amazon S3 bucket as a metadata cache to improve performance.

Request Syntax

{ "MigrationProjectIdentifier": "string", "Origin": "string", "Refresh": boolean, "SelectionRules": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


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

Type: String

Required: Yes


Whether to load metadata to the source or target database.

Type: String

Valid Values: SOURCE | TARGET

Required: Yes


If true, Amazon DMS loads metadata for the specified objects from the source database.

Type: Boolean

Required: No


A value that specifies the database objects to import.

Type: String

Required: Yes

Response Syntax

{ "RequestIdentifier": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The identifier for the import operation.

Type: String


For information about the errors that are common to all actions, see Common Errors.


Amazon DMS was denied access to the endpoint. Check that the role is correctly configured.

HTTP Status Code: 400


The resource is in a state that prevents it from being used for database migration.

HTTP Status Code: 400


Amazon DMS cannot access the KMS key.

HTTP Status Code: 400


The resource you are attempting to create already exists.

HTTP Status Code: 400


The resource could not be found.

HTTP Status Code: 400


The quota for this resource quota has been exceeded.

HTTP Status Code: 400


Insufficient privileges are preventing access to an Amazon S3 object.

HTTP Status Code: 400


A specified Amazon S3 bucket, bucket folder, or other object can't be found.

HTTP Status Code: 400



This example illustrates one usage of StartMetadataModelImport.

Sample Request

awsdms start-metadata-model-import --migration-project-identifier arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRSTUVWXYZ012345 --selection-rules "{\"rules\": [{\"rule-type\": \"selection\",\"rule-id\": \"1\",\"rule-name\": \"1\",\"object-locator\": {\"server-name\": \"\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}" --origin SOURCE --refresh false

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: