:doc:`DataSync <../../datasync>` / Paginator / ListTaskExecutions

******************
ListTaskExecutions
******************



.. py:class:: DataSync.Paginator.ListTaskExecutions

  ::

    
    paginator = client.get_paginator('list_task_executions')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`DataSync.Client.list_task_executions`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTaskExecutions>`_    


    **Request Syntax**
    ::

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

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :rtype: 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 <https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html>`__ 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 <https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#understand-task-execution-statuses>`__.

              
            

            - **TaskMode** *(string) --* 

              The task mode that you're using. For more information, see `Choosing a task mode for your data transfer <https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html>`__.

              
        
      
    