export_image¶
Operation¶
async
¶
export_image(input: ExportImageInput, plugins: list[Plugin] | None = None) -> ExportImageOutput
Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
ExportImageInput
|
An instance of |
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 |
|---|---|
ExportImageOutput
|
An instance of |
Input¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ExportImageInput structure.
Attributes¶
class-attribute
instance-attribute
¶
client_token: str | None = ...
Token to enable idempotency for export image requests.
This field is autopopulated if not provided.
class-attribute
instance-attribute
¶
description: str | None = ...
A description of the image being exported. The maximum length is 255 characters.
class-attribute
instance-attribute
¶
disk_image_format: str | None = ...
The disk image format.
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.
class-attribute
instance-attribute
¶
role_name: str | None = ...
The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.
class-attribute
instance-attribute
¶
The Amazon S3 bucket for the destination image. The destination bucket must exist.
Output¶
dataclass
¶
Bases: _SerdeShape
Dataclass for ExportImageOutput structure.
Attributes¶
class-attribute
instance-attribute
¶
description: str | None = ...
A description of the image being exported.
class-attribute
instance-attribute
¶
disk_image_format: str | None = ...
The disk image format for the exported image.
class-attribute
instance-attribute
¶
export_image_task_id: str | None = ...
The ID of the export image task.
class-attribute
instance-attribute
¶
progress: str | None = ...
The percent complete of the export image task.
class-attribute
instance-attribute
¶
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.
class-attribute
instance-attribute
¶
role_name: str | None = ...
The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
class-attribute
instance-attribute
¶
Information about the destination Amazon S3 bucket.
class-attribute
instance-attribute
¶
status: str | None = ...
The status of the export image task. The possible values are active,
completed, deleting, and deleted.