Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1469325456.8 KB

Starts a new premigration assessment run for one or more individual assessments of a migration task.

The assessments that you can specify depend on the source and target database engine and the migration type defined for the given task. To run this operation, your migration task must already be created. After you run this operation, you can review the status of each individual assessment. You can also run the migration task manually after the assessment run and its individual assessments complete.

post/#X-Amz-Target=AmazonDMSv20160101.StartReplicationTaskAssessmentRun

Headers

X-Amz-Target'AmazonDMSv20160101.StartReplicationTaskAssessmentRun' required

Request body

ReplicationTaskArnstring required

Amazon Resource Name (ARN) of the migration task associated with the premigration assessment run that you want to start.

ServiceAccessRoleArnstring required

ARN of the service role needed to start the assessment run. The role must allow the <code>iam:PassRole</code> action.

ResultLocationBucketstring required

Amazon S3 bucket where you want DMS to store the results of this assessment run.

ResultLocationFolderstring

Folder within an Amazon S3 bucket where you want DMS to store the results of this assessment run.

ResultEncryptionModestring
<p>Encryption mode that you can specify to encrypt the results of this assessment run. If you don't specify this request parameter, DMS stores the assessment run results without encryption. You can specify one of the options following:</p> <ul> <li> <p> <code>"SSE_S3"</code> – The server-side encryption provided as a default by Amazon S3.</p> </li> <li> <p> <code>"SSE_KMS"</code> – Key Management Service (KMS) encryption. This encryption can use either a custom KMS encryption key that you specify or the default KMS encryption key that DMS provides.</p> </li> </ul>
ResultKmsKeyArnstring

ARN of a custom KMS encryption key that you specify when you set <code>ResultEncryptionMode</code> to <code>"SSE_KMS</code>".

AssessmentRunNamestring required

Unique name to identify the assessment run.

IncludeOnlyString[]
<p>Space-separated list of names for specific individual assessments that you want to include. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by <code>ReplicationTaskArn</code>.</p> <note> <p>You can't set a value for <code>IncludeOnly</code> if you also set a value for <code>Exclude</code> in the API operation. </p> <p>To identify the names of the default individual assessments that DMS supports for the associated migration task, run the <code>DescribeApplicableIndividualAssessments</code> operation using its own <code>ReplicationTaskArn</code> request parameter.</p> </note>
ExcludeString[]
<p>Space-separated list of names for specific individual assessments that you want to exclude. These names come from the default list of individual assessments that DMS supports for the associated migration task. This task is specified by <code>ReplicationTaskArn</code>.</p> <note> <p>You can't set a value for <code>Exclude</code> if you also set a value for <code>IncludeOnly</code> in the API operation.</p> <p>To identify the names of the default individual assessments that DMS supports for the associated migration task, run the <code>DescribeApplicableIndividualAssessments</code> operation using its own <code>ReplicationTaskArn</code> request parameter.</p> </note>

Response

Success