AppStream / Client / list_export_image_tasks

list_export_image_tasks¶

AppStream.Client.list_export_image_tasks(**kwargs)¶

Lists export image tasks, with optional filtering and pagination. Use this operation to monitor the status of multiple export operations.

Request Syntax

response = client.list_export_image_tasks(
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    NextToken='string'
)

Parameters:

Filters (list) –
Optional filters to apply when listing export image tasks. Filters help you narrow down the results based on specific criteria.
- (dict) –
  
  A filter for narrowing down the results when listing export image tasks. Filters allow you to specify criteria such as task state or creation date.
  - Name (string) – [REQUIRED]
    
    The name of the filter. Valid filter names depend on the operation being performed.
  - Values (list) – [REQUIRED]
    
    The values for the filter. Multiple values can be specified for a single filter name.
    - (string) –
MaxResults (integer) – The maximum number of export image tasks to return in a single request. The valid range is 1-500, with a default of 50.
NextToken (string) – The pagination token from a previous request. Use this to retrieve the next page of results when there are more tasks than the MaxResults limit.

Return type:

dict

Returns:

Response Syntax

{
    'ExportImageTasks': [
        {
            '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'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- ExportImageTasks (list) –
  
  The list of export image tasks that match the specified criteria.
  - (dict) –
    
    Information about an export image task, including its current state, timestamps, 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.
- NextToken (string) –
  
  The pagination token to use for retrieving the next page of results. This field is only present when there are more results available.

Exceptions

AppStream.Client.exceptions.OperationNotPermittedException