Skip to content

EC2  >  Operations  >  create_instance_export_task

create_instance_export_task

Operation

create_instance_export_task async

create_instance_export_task(input: CreateInstanceExportTaskInput, plugins: list[Plugin] | None = None) -> CreateInstanceExportTaskOutput

Exports a running or stopped instance to an Amazon S3 bucket.

For information about the prerequisites for your Amazon S3 bucket, supported operating systems, image formats, and known limitations for the types of instances you can export, see Exporting an instance as a VM Using VM Import/Export in the VM Import/Export User Guide.

Parameters:

Name Type Description Default
input CreateInstanceExportTaskInput

An instance of CreateInstanceExportTaskInput.

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
CreateInstanceExportTaskOutput

An instance of CreateInstanceExportTaskOutput.

Input

CreateInstanceExportTaskInput dataclass

Bases: _SerdeShape

Dataclass for CreateInstanceExportTaskInput structure.

Attributes

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

A description for the conversion task or the resource being exported. The maximum length is 255 characters.

export_to_s3_task class-attribute instance-attribute
export_to_s3_task: ExportToS3TaskSpecification | None = ...

The format and location for an export instance task.

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

The ID of the instance.

tag_specifications class-attribute instance-attribute
tag_specifications: list[TagSpecification] | None = ...

The tags to apply to the export instance task during creation.

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

The target virtualization environment.

Output

CreateInstanceExportTaskOutput dataclass

Bases: _SerdeShape

Dataclass for CreateInstanceExportTaskOutput structure.

Attributes

export_task class-attribute instance-attribute
export_task: ExportTask | None = ...

Information about the export instance task.

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.