StartMetadataModelAssessment - AWS Database Migration Service


Creates a database migration assessment report by assessing the migration complexity for your source database. A database migration assessment report summarizes all of the schema conversion tasks. It also details the action items for database objects that can't be converted to the database engine of your target database instance.

Request Syntax

{ "MigrationProjectIdentifier": "string", "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


A value that specifies the database objects to assess.

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

Type: String


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


AWS 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


AWS 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 StartMetadataModelAssessment.

Sample Request

awsdms start-metadata-model-assessment --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\"} ]}"

See Also

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