Skip to content

ExportImageRequest

Source code in docs_src/capo_ec2/types/export_image_request.py
class ExportImageRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_ec2.types.string.String"]
    """<p>Token to enable idempotency for export image requests.</p>"""
    description: NotRequired["capo_ec2.types.string.String"]
    """<p>A description of the image being exported. The maximum length is 255 characters.</p>"""
    disk_image_format: NotRequired["capo_ec2.types.disk_image_format.DiskImageFormat"]
    """<p>The disk image format.</p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""
    image_id: NotRequired["capo_ec2.types.image_id.ImageId"]
    """<p>The ID of the image.</p>"""
    s3_export_location: NotRequired[
        "capo_ec2.types.export_task_s3_location_request.ExportTaskS3LocationRequest"
    ]
    """<p>The Amazon S3 bucket for the destination image. The destination bucket must exist.</p>"""
    role_name: NotRequired["capo_ec2.types.string.String"]
    """<p>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'.</p>"""
    tag_specifications: NotRequired[
        "capo_ec2.types.tag_specification_list.TagSpecificationList"
    ]
    """<p>The tags to apply to the export image task during creation.</p>"""

client_token instance-attribute

client_token: NotRequired[String]

Token to enable idempotency for export image requests.

description instance-attribute

description: NotRequired[String]

A description of the image being exported. The maximum length is 255 characters.

disk_image_format instance-attribute

disk_image_format: NotRequired[DiskImageFormat]

The disk image format.

dry_run instance-attribute

dry_run: NotRequired[Boolean]

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.

image_id instance-attribute

image_id: NotRequired[ImageId]

The ID of the image.

role_name instance-attribute

role_name: NotRequired[String]

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: NotRequired[ExportTaskS3LocationRequest]

The Amazon S3 bucket for the destination image. The destination bucket must exist.

tag_specifications instance-attribute

tag_specifications: NotRequired[TagSpecificationList]

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