ExportMetadataModelAssessment - AWS Database Migration Service


Saves a copy of a database migration assessment report to your Amazon S3 bucket. AWS DMS can save your assessment report as a comma-separated value (CSV) or a PDF file.

Request Syntax

{ "AssessmentReportTypes": [ "string" ], "FileName": "string", "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 file format of the assessment file.

Type: Array of strings

Array Members: Minimum number of 1 item.

Valid Values: pdf | csv

Required: No


The name of the assessment file to create in your Amazon S3 bucket.

Type: String

Required: No


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

{ "CsvReport": { "ObjectURL": "string", "S3ObjectKey": "string" }, "PdfReport": { "ObjectURL": "string", "S3ObjectKey": "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 Amazon S3 details for an assessment exported in CSV format.

Type: ExportMetadataModelAssessmentResultEntry object


The Amazon S3 details for an assessment exported in PDF format.

Type: ExportMetadataModelAssessmentResultEntry object


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


The resource could not be found.

HTTP Status Code: 400



This example illustrates one usage of ExportMetadataModelAssessment.

Sample Request

awsdms export-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\": \"aurora-pg.cluster-a1b2c3d4e5f6.us-east-1.rds.amazonaws.com\", \"schema-name\": \"schema1\", \"table-name\": \"Cities\"},\"rule-action\": \"explicit\"} ]}" --assessment-report-types PDF --file-name file

See Also

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