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

CancelMetadataModelConversion

Cancels a single metadata model conversion operation that was started with StartMetadataModelConversion.

Request Syntax


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

MigrationProjectIdentifier

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

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

RequestIdentifier

The identifier for the metadata model conversion operation to cancel. This operation was initiated by StartMetadataModelConversion.

Type: String

Required: Yes

Response Syntax


{
   "Request": { 
      "Error": { ... },
      "ExportSqlDetails": { 
         "ObjectURL": "string",
         "S3ObjectKey": "string"
      },
      "MigrationProjectArn": "string",
      "Progress": { 
         "ProcessedObject": { 
            "EndpointType": "string",
            "Name": "string",
            "Type": "string"
         },
         "ProgressPercent": number,
         "ProgressStep": "string",
         "TotalObjects": number
      },
      "RequestIdentifier": "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.

Request

Provides information about a schema conversion action.

Type: SchemaConversionRequest object

Errors

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

AccessDeniedFault

AWS DMS was denied access to the endpoint. Check that the role is correctly configured.

message

HTTP Status Code: 400

InvalidResourceStateFault

The resource is in a state that prevents it from being used for database migration.

message

HTTP Status Code: 400

ResourceNotFoundFault

The resource could not be found.

message

HTTP Status Code: 400

Examples

Cancel a metadata model conversion

The following example cancels a metadata model conversion operation.

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.CancelMetadataModelConversion
{
    "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
    "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
    "Request": {
        "Status": "CANCELING",
        "RequestIdentifier": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111",
        "MigrationProjectArn": "arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS"
    }
}