CancelReplicationTaskAssessmentRun
Cancels a single premigration assessment run.
This operation prevents any individual assessments from running if they haven't started running. It also attempts to cancel any individual assessments that are currently running.
Request Syntax
{
"ReplicationTaskAssessmentRunArn": "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.
- ReplicationTaskAssessmentRunArn
-
Amazon Resource Name (ARN) of the premigration assessment run to be canceled.
Type: String
Required: Yes
Response Syntax
{
"ReplicationTaskAssessmentRun": {
"AssessmentProgress": {
"IndividualAssessmentCompletedCount": number,
"IndividualAssessmentCount": number
},
"AssessmentRunName": "string",
"IsLatestTaskAssessmentRun": boolean,
"LastFailureMessage": "string",
"ReplicationTaskArn": "string",
"ReplicationTaskAssessmentRunArn": "string",
"ReplicationTaskAssessmentRunCreationDate": number,
"ResultEncryptionMode": "string",
"ResultKmsKeyArn": "string",
"ResultLocationBucket": "string",
"ResultLocationFolder": "string",
"ResultStatistic": {
"Cancelled": number,
"Error": number,
"Failed": number,
"Passed": number,
"Warning": number
},
"ServiceAccessRoleArn": "string",
"Status": "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.
- ReplicationTaskAssessmentRun
-
The
ReplicationTaskAssessmentRun
object for the canceled assessment run.Type: ReplicationTaskAssessmentRun object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedFault
-
Amazon DMS was denied access to the endpoint. Check that the role is correctly configured.
HTTP Status Code: 400
- InvalidResourceStateFault
-
The resource is in a state that prevents it from being used for database migration.
HTTP Status Code: 400
- ResourceNotFoundFault
-
The resource could not be found.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of CancelReplicationTaskAssessmentRun.
Sample Request
POST / HTTP/1.1
Host: dms.<region>.<domain>
x-amz-Date: <Date>
Authorization: AWS4-HMAC-SHA256
Credential=<Credential>,
SignedHeaders=contenttype;date;host;user-
agent;x-amz-date;x-amz-target;x-amzn-
requestid,Signature=<Signature>
User-Agent: <UserAgentString>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Connection: Keep-Alive
X-Amz-Target: AmazonDMSv20160101.CancelReplicationTaskAssessmentRun
{
"ReplicationTaskAssessmentRunArn": "arn:aws:dms:us-west-2:123456789012:assessment-run:G7C26HZ4A3CRB6DJKIMT4RDSHCIGP4T4BHOMHRA"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
"ReplicationTaskAssessmentRun": {
"AssessmentProgress": {
"IndividualAssessmentCompletedCount": 0,
"IndividualAssessmentCount": 3
},
"AssessmentRunName": "Assessment-run-2020-07-10-17-49-37",
"ReplicationTaskArn": "arn:aws:dms:us-west-2:123456789012:task:L6XROPGLRF25LCREVEDPT3XL5QJM5IZNUSVFV6Q",
"ReplicationTaskAssessmentRunArn": "arn:aws:dms:us-west-2:123456789012:assessment-run:G7C26HZ4A3CRB6DJKIMT4RDSHCIGP4T4BHOMHRA",
"ReplicationTaskAssessmentRunCreationDate": 1594428591.99,
"ResultEncryptionMode": "NONE",
"ResultLocationBucket": "s3-endpoint-bucket",
"ResultLocationFolder": "",
"ServiceAccessRoleArn": "arn:aws:iam::123456789012:role/Admin",
"Status": "cancelling"
}
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: