export_image¶
Operation¶
export_image
¶
export_image(request: ExportImageInput | ExportImageInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ExportImageInputDict]) -> 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 |
|---|---|---|---|
request
|
ExportImageInput | ExportImageInputDict | 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[ExportImageInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ExportImageOutput
|
An instance of |
export_image
async
¶
export_image(request: ExportImageInput | ExportImageInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ExportImageInputDict]) -> 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 |
|---|---|---|---|
request
|
ExportImageInput | ExportImageInputDict | 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[ExportImageInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
ExportImageOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
ExportImageInputDict
¶
Bases: TypedDict
Dictionary form of ExportImageInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | None
Token to enable idempotency for export image requests.
This field is autopopulated if not provided.
description
instance-attribute
¶
description: str | None
A description of the image being exported. The maximum length is 255 characters.
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.
role_name
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'.
s3_export_location
instance-attribute
¶
s3_export_location: Required[ExportTaskS3LocationRequest | ExportTaskS3LocationRequestDict]
The Amazon S3 bucket for the destination image. The destination bucket must exist.
tag_specifications
instance-attribute
¶
tag_specifications: Sequence[TagSpecification | TagSpecificationDict] | None
The tags to apply to the export image task during creation.
ExportImageInput
dataclass
¶
Bases: _SerdeShape
Dataclass for ExportImageInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
Token to enable idempotency for export image requests.
This field is autopopulated if not provided.
description
class-attribute
instance-attribute
¶
description: str | None = ...
A description of the image being exported. The maximum length is 255 characters.
disk_image_format
class-attribute
instance-attribute
¶
disk_image_format: str | None = ...
The disk image format.
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.
role_name
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'.
s3_export_location
class-attribute
instance-attribute
¶
s3_export_location: ExportTaskS3LocationRequest | None = ...
The Amazon S3 bucket for the destination image. The destination bucket must exist.
tag_specifications
class-attribute
instance-attribute
¶
tag_specifications: list[TagSpecification] | None = ...
The tags to apply to the export image task during creation.
Output¶
ExportImageOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for ExportImageOutput structure.
Attributes¶
description
class-attribute
instance-attribute
¶
description: str | None = ...
A description of the image being exported.
disk_image_format
class-attribute
instance-attribute
¶
disk_image_format: str | None = ...
The disk image format for the exported image.
export_image_task_id
class-attribute
instance-attribute
¶
export_image_task_id: str | None = ...
The ID of the export image task.
progress
class-attribute
instance-attribute
¶
progress: str | None = ...
The percent complete of the export image task.
response_metadata
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.
role_name
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.
s3_export_location
class-attribute
instance-attribute
¶
s3_export_location: ExportTaskS3Location | None = ...
Information about the destination Amazon S3 bucket.
status
class-attribute
instance-attribute
¶
status: str | None = ...
The status of the export image task. The possible values are active,
completed, deleting, and deleted.