AppStream / Client / get_export_image_task

get_export_image_task¶

AppStream.Client.get_export_image_task(**kwargs)¶

Retrieves information about an export image task, including its current state, progress, and any error details.

Request Syntax

response = client.get_export_image_task(
    TaskId='string'
)

Parameters:

TaskId (string) – The unique identifier of the export image task to retrieve information about.

Return type:

dict

Returns:

Response Syntax

{
    'ExportImageTask': {
        'TaskId': 'string',
        'ImageArn': 'string',
        'AmiName': 'string',
        'CreatedDate': datetime(2015, 1, 1),
        'AmiDescription': 'string',
        'State': 'EXPORTING'|'COMPLETED'|'FAILED',
        'AmiId': 'string',
        'TagSpecifications': {
            'string': 'string'
        },
        'ErrorDetails': [
            {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            },
        ]
    }
}

Response Structure

(dict) –
- ExportImageTask (dict) –
  
  Information about the export image task, including its current state, created date, and any error details.
  - TaskId (string) –
    
    The unique identifier for the export image task. Use this ID to track the task’s progress and retrieve its details.
  - ImageArn (string) –
    
    The ARN of the WorkSpaces Applications image being exported.
  - AmiName (string) –
    
    The name of the EC2 AMI that will be created by this export task.
  - CreatedDate (datetime) –
    
    The date and time when the export image task was created.
  - AmiDescription (string) –
    
    The description that will be applied to the exported EC2 AMI.
  - State (string) –
    
    The current state of the export image task, such as PENDING, RUNNING, COMPLETED, or FAILED.
  - AmiId (string) –
    
    The ID of the EC2 AMI that was created by this export task. This field is only populated when the task completes successfully.
  - TagSpecifications (dict) –
    
    The tags that will be applied to the exported EC2 AMI.
    - (string) –
      - (string) –
  - ErrorDetails (list) –
    
    Details about any errors that occurred during the export process. This field is only populated when the task fails.
    - (dict) –
      
      The error details.
      - ErrorCode (string) –
        
        The error code.
      - ErrorMessage (string) –
        
        The error message.

Exceptions

AppStream.Client.exceptions.OperationNotPermittedException
AppStream.Client.exceptions.ResourceNotFoundException