Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ExportMetadataModelAssessment

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.

AssessmentReportTypes

The file format of the assessment file.

Type: Array of strings

Array Members: Minimum number of 1 item.

Valid Values: pdf | csv

Required: No

FileName

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

Type: String

Required: No

MigrationProjectIdentifier

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

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

SelectionRules

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.

CsvReport

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

Type: ExportMetadataModelAssessmentResultEntry object

PdfReport

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

Type: ExportMetadataModelAssessmentResultEntry object

Errors

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

ResourceNotFoundFault

The resource could not be found.

message

HTTP Status Code: 400

Examples

Export a conversion assessment report

The following example exports a conversion assessment report for all objects in the ExampleSchema schema.

Sample Request


POST / HTTP/1.1
Host: dms.<region>.<domain>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<SignedHeaders>, Signature=<Signature>
X-Amz-Date: <Date>
X-Amz-Target: AmazonDMSv20160101.ExportMetadataModelAssessment
{
    "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
    "SelectionRules": "{\"rules\": [{\"rule-type\": \"selection\", \"rule-id\": \"1\", \"rule-name\": \"1\", \"object-locator\": {\"server-name\": \"example-source-server.us-east-1.rds.amazonaws.com\", \"schema-name\": \"ExampleSchema\"}, \"rule-action\": \"explicit\"}]}",
    "AssessmentReportTypes": [
        "pdf",
        "csv"
    ],
    "FileName": "example-assessment-report"
}

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
    "PdfReport": {
        "S3ObjectKey": "example-migration-project/example-assessment-report.pdf",
        "ObjectURL": "https://amzn-s3-demo-bucket.s3.amazonaws.com/example-migration-project/example-assessment-report.pdf"
    },
    "CsvReport": {
        "S3ObjectKey": "example-migration-project/example-assessment-report.zip",
        "ObjectURL": "https://amzn-s3-demo-bucket.s3.amazonaws.com/example-migration-project/example-assessment-report.zip"
    }
}