:doc:`CloudWatchLogs <../../logs>` / Paginator / DescribeExportTasks

*******************
DescribeExportTasks
*******************



.. py:class:: CloudWatchLogs.Paginator.DescribeExportTasks

  ::

    
    paginator = client.get_paginator('describe_export_tasks')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CloudWatchLogs.Client.describe_export_tasks`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeExportTasks>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          taskId='string',
          statusCode='CANCELLED'|'COMPLETED'|'FAILED'|'PENDING'|'PENDING_CANCEL'|'RUNNING',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type taskId: string
    :param taskId: 

      The ID of the export task. Specifying a task ID filters the results to one or zero export tasks.

      

    
    :type statusCode: string
    :param statusCode: 

      The status code of the export task. Specifying a status code filters the results to zero or more export tasks.

      

    
    :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**

      
      ::

        {
            'exportTasks': [
                {
                    'taskId': 'string',
                    'taskName': 'string',
                    'logGroupName': 'string',
                    'from': 123,
                    'to': 123,
                    'destination': 'string',
                    'destinationPrefix': 'string',
                    'status': {
                        'code': 'CANCELLED'|'COMPLETED'|'FAILED'|'PENDING'|'PENDING_CANCEL'|'RUNNING',
                        'message': 'string'
                    },
                    'executionInfo': {
                        'creationTime': 123,
                        'completionTime': 123
                    }
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **exportTasks** *(list) --* 

          The export tasks.

          
          

          - *(dict) --* 

            Represents an export task.

            
            

            - **taskId** *(string) --* 

              The ID of the export task.

              
            

            - **taskName** *(string) --* 

              The name of the export task.

              
            

            - **logGroupName** *(string) --* 

              The name of the log group from which logs data was exported.

              
            

            - **from** *(integer) --* 

              The start time, expressed as the number of milliseconds after ``Jan 1, 1970 00:00:00 UTC``. Events with a timestamp before this time are not exported.

              
            

            - **to** *(integer) --* 

              The end time, expressed as the number of milliseconds after ``Jan 1, 1970 00:00:00 UTC``. Events with a timestamp later than this time are not exported.

              
            

            - **destination** *(string) --* 

              The name of the S3 bucket to which the log data was exported.

              
            

            - **destinationPrefix** *(string) --* 

              The prefix that was used as the start of Amazon S3 key for every object exported.

              
            

            - **status** *(dict) --* 

              The status of the export task.

              
              

              - **code** *(string) --* 

                The status code of the export task.

                
              

              - **message** *(string) --* 

                The status message related to the status code.

                
          
            

            - **executionInfo** *(dict) --* 

              Execution information about the export task.

              
              

              - **creationTime** *(integer) --* 

                The creation time of the export task, expressed as the number of milliseconds after ``Jan 1, 1970 00:00:00 UTC``.

                
              

              - **completionTime** *(integer) --* 

                The completion time of the export task, expressed as the number of milliseconds after ``Jan 1, 1970 00:00:00 UTC``.

                
          
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    