Skip to content

cancel_import_task

Operation

cancel_import_task

cancel_import_task(request: CancelImportTaskInput | CancelImportTaskInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelImportTaskInputDict]) -> CancelImportTaskOutput

Cancels an in-process import virtual machine or import snapshot task.

Parameters:

Name Type Description Default
request CancelImportTaskInput | CancelImportTaskInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[CancelImportTaskInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CancelImportTaskOutput

An instance of CancelImportTaskOutput.

cancel_import_task async

cancel_import_task(request: CancelImportTaskInput | CancelImportTaskInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CancelImportTaskInputDict]) -> CancelImportTaskOutput

Cancels an in-process import virtual machine or import snapshot task.

Parameters:

Name Type Description Default
request CancelImportTaskInput | CancelImportTaskInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[CancelImportTaskInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CancelImportTaskOutput

An instance of CancelImportTaskOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CancelImportTaskInputDict

Bases: TypedDict

Dictionary form of CancelImportTaskInput.

Attributes

cancel_reason instance-attribute
cancel_reason: str | None

The reason for canceling the 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.

import_task_id instance-attribute
import_task_id: str | None

The ID of the import image or import snapshot task to be canceled.

CancelImportTaskInput dataclass

Bases: _SerdeShape

Dataclass for CancelImportTaskInput structure.

Attributes

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

The reason for canceling the 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.

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

The ID of the import image or import snapshot task to be canceled.

Output

CancelImportTaskOutput dataclass

Bases: _SerdeShape

Dataclass for CancelImportTaskOutput structure.

Attributes

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

The ID of the task being canceled.

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

The current state of the task being canceled.

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.

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

The current state of the task being canceled.