Skip to content

ExportImageTask

Source code in docs_src/capo_appstream/types/export_image_task.py
class ExportImageTask(TypedDict, closed=True):
    task_id: NotRequired["capo_appstream.types.uuid.UUID"]
    """<p>The unique identifier for the export image task. Use this ID to track the task's progress and retrieve its details.</p>"""
    image_arn: NotRequired["capo_appstream.types.arn.Arn"]
    """<p>The ARN of the WorkSpaces Applications image being exported.</p>"""
    ami_name: NotRequired["capo_appstream.types.ami_name.AmiName"]
    """<p>The name of the EC2 AMI that will be created by this export task.</p>"""
    created_date: NotRequired["capo_appstream.types.timestamp.Timestamp"]
    """<p>The date and time when the export image task was created.</p>"""
    ami_description: NotRequired["capo_appstream.types.description.Description"]
    """<p>The description that will be applied to the exported EC2 AMI.</p>"""
    state: NotRequired[
        "capo_appstream.types.export_image_task_state.ExportImageTaskState"
    ]
    """<p>The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.</p>"""
    ami_id: NotRequired["capo_appstream.types.photon_ami_id.PhotonAmiId"]
    """<p>The ID of the EC2 AMI that was created by this export task. This field is only populated when the task completes successfully.</p>"""
    tag_specifications: NotRequired["capo_appstream.types.tags.Tags"]
    """<p>The tags that will be applied to the exported EC2 AMI.</p>"""
    error_details: NotRequired[
        "capo_appstream.types.error_details_list.ErrorDetailsList"
    ]
    """<p>Details about any errors that occurred during the export process. This field is only populated when the task fails.</p>"""

ami_description instance-attribute

ami_description: NotRequired[Description]

The description that will be applied to the exported EC2 AMI.

ami_id instance-attribute

ami_id: NotRequired[PhotonAmiId]

The ID of the EC2 AMI that was created by this export task. This field is only populated when the task completes successfully.

ami_name instance-attribute

ami_name: NotRequired[AmiName]

The name of the EC2 AMI that will be created by this export task.

created_date instance-attribute

created_date: NotRequired[Timestamp]

The date and time when the export image task was created.

error_details instance-attribute

error_details: NotRequired[ErrorDetailsList]

Details about any errors that occurred during the export process. This field is only populated when the task fails.

image_arn instance-attribute

image_arn: NotRequired[Arn]

The ARN of the WorkSpaces Applications image being exported.

state instance-attribute

state: NotRequired[ExportImageTaskState]

The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.

tag_specifications instance-attribute

tag_specifications: NotRequired[Tags]

The tags that will be applied to the exported EC2 AMI.

task_id instance-attribute

task_id: NotRequired[UUID]

The unique identifier for the export image task. Use this ID to track the task's progress and retrieve its details.