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

CancelMetadataModelCreation

Cancels a single metadata model creation operation that was started with StartMetadataModelCreation.

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 creation operation to cancel. This operation was initiated by StartMetadataModelCreation.

Type: String

Required: Yes

Response Syntax


{
   "Request": { 
      "Error": { ... },
      "ExportSqlDetails": { 
         "ObjectURL": "string",
         "S3ObjectKey": "string"
      },
      "MigrationProjectArn": "string",
      "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 Errors.

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

Sample Request

This example illustrates retrieval of a metadata model creation requests for a migration project. The provided filter allow querying specific request by its identifier. The response includes a list of creation requests with their current status and details.


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.CancelMetadataModelCreation
{
    "MigrationProjectIdentifier": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
    "RequestIdentifier": "00000000-0000-0000-0000-000000000000"
}

Sample Response

This example illustrates one usage of CancelMetadataModelCreation.


HTTP/1.1 200 OK
x-amzn-RequestId: <RequestId>
Content-Type: application/x-amz-json-1.1
Content-Length: <PayloadSizeBytes>
Date: <Date>
{
    "Request": {
        "MigrationProjectArn": "arn:aws:dms:us-east-1:012345678901:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS",
        "RequestIdentifier": "00000000-0000-0000-0000-000000000000",
        "Status": "CANCELLING"
    }
}