cancel_conversion_task¶
Operation¶
cancel_conversion_task
async
¶
cancel_conversion_task(request: CancelConversionTaskInput | CancelConversionTaskInputDict, /, *, plugins: list[Plugin] | None = None) -> CancelConversionTaskOutput
cancel_conversion_task(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelConversionTaskInputDict]) -> 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 |
|---|---|---|---|
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 |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
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.
Dictionaries¶
CancelConversionTaskInputDict
¶
Bases: TypedDict
Dictionary form of CancelConversionTaskInput.
Attributes¶
conversion_task_id
instance-attribute
¶
The ID of the conversion task.
dry_run
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.
Output¶
CancelConversionTaskOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for CancelConversionTaskOutput structure.