DataSync / Client / list_task_executions

list_task_executions#

DataSync.Client.list_task_executions(**kwargs)#

Returns a list of executions for an DataSync transfer task.

Request Syntax

response = client.list_task_executions(
    TaskArn='string',
    MaxResults=123,
    NextToken='string'
)

Parameters:

TaskArn (string) – Specifies the Amazon Resource Name (ARN) of the task that you want execution information about.
MaxResults (integer) – Specifies how many results you want in the response.
NextToken (string) – Specifies an opaque string that indicates the position at which to begin the next list of results in the response.

Return type:

dict

Returns:

Response Syntax

{
    'TaskExecutions': [
        {
            'TaskExecutionArn': 'string',
            'Status': 'QUEUED'|'CANCELLING'|'LAUNCHING'|'PREPARING'|'TRANSFERRING'|'VERIFYING'|'SUCCESS'|'ERROR',
            'TaskMode': 'BASIC'|'ENHANCED'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –

ListTaskExecutionsResponse
- TaskExecutions (list) –
  
  A list of the task’s executions.
  - (dict) –
    
    Represents a single entry in a list of DataSync task executions that’s returned with the ListTaskExecutions operation.
    - TaskExecutionArn (string) –
      
      The Amazon Resource Name (ARN) of a task execution.
    - Status (string) –
      
      The status of a task execution. For more information, see Task execution statuses.
    - TaskMode (string) –
      
      The task mode that you’re using. For more information, see Choosing a task mode for your data transfer.
- NextToken (string) –
  
  The opaque string that indicates the position to begin the next list of results in the response.

Exceptions

DataSync.Client.exceptions.InvalidRequestException
DataSync.Client.exceptions.InternalException