Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

CancelConversionTask

Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception.

For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.

Request Parameters

The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see Common Query Parameters.

ConversionTaskId

The ID of the conversion task.

Type: String

Required: Yes

DryRun

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Type: Boolean

Required: No

ReasonMessage

The reason for canceling the conversion task.

Type: String

Required: No

Response Elements

The following elements are returned by the service.

requestId

The ID of the request.

Type: String

return

Is true if the request succeeds, and an error otherwise.

Type: Boolean

Errors

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

Example

Example

This example request cancels the conversion task with the ID import-i-fh95npoc.

Sample Request

Copy
https://ec2.amazonaws.com/?Action=CancelConversionTask &ConversionTaskId=import-i-fh95npoc &AUTHPARAMS

Sample Response

Copy
<CancelConversionTaskResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <return>true</return> </CancelConversionTaskResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: