Skip to content

EC2  >  Operations  >  cancel_conversion_task

cancel_conversion_task

Operation

cancel_conversion_task async 

cancel_conversion_task(input: CancelConversionTaskInput, plugins: list[Plugin] | None = None) -> CancelConversionTaskOutput

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.

Parameters:

Name Type Description Default
input CancelConversionTaskInput

An instance of CancelConversionTaskInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
CancelConversionTaskOutput

An instance of CancelConversionTaskOutput.

Input

CancelConversionTaskInput dataclass

Bases: _SerdeShape

Dataclass for CancelConversionTaskInput structure.

Attributes

conversion_task_id class-attribute instance-attribute 
conversion_task_id: str | None = ...

The ID of the conversion task.

dry_run class-attribute instance-attribute 
dry_run: bool | None = ...

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.

reason_message class-attribute instance-attribute 
reason_message: str | None = ...

The reason for canceling the conversion task.

Output

CancelConversionTaskOutput dataclass

Bases: _SerdeShape

Dataclass for CancelConversionTaskOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.