Skip to content

EC2  >  Operations  >  cancel_export_task

cancel_export_task

Operation

cancel_export_task async 

cancel_export_task(input: CancelExportTaskInput, plugins: list[Plugin] | None = None) -> CancelExportTaskOutput

Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error.

Parameters:

Name Type Description Default
input CancelExportTaskInput

An instance of CancelExportTaskInput.

 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
CancelExportTaskOutput

An instance of CancelExportTaskOutput.

Input

CancelExportTaskInput dataclass

Bases: _SerdeShape

Dataclass for CancelExportTaskInput structure.

Attributes

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

The ID of the export task. This is the ID returned by the CreateInstanceExportTask and ExportImage operations.

Output

CancelExportTaskOutput dataclass

Bases: _SerdeShape

Dataclass for CancelExportTaskOutput 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.