DataSync / Paginator / ListTaskExecutions

ListTaskExecutions#

class DataSync.Paginator.ListTaskExecutions#
paginator = client.get_paginator('list_task_executions')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from DataSync.Client.list_task_executions().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    TaskArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:

  • TaskArn (string) – Specifies the Amazon Resource Name (ARN) of the task that you want execution information about.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

}

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.