:doc:`CloudWatchLogs <../../logs>` / Client / describe_export_tasks

*********************
describe_export_tasks
*********************



.. py:method:: CloudWatchLogs.Client.describe_export_tasks(**kwargs)

  

  Lists the specified export tasks. You can list all your export tasks or filter the results based on task ID or task status.

  

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


  **Request Syntax**
  ::

    response = client.describe_export_tasks(
        taskId='string',
        statusCode='CANCELLED'|'COMPLETED'|'FAILED'|'PENDING'|'PENDING_CANCEL'|'RUNNING',
        nextToken='string',
        limit=123
    )
    
  :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 nextToken: string
  :param nextToken: 

    The token for the next set of items to return. (You received this token from a previous call.)

    

  
  :type limit: integer
  :param limit: 

    The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

    

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

        The token for the next set of items to return. The token expires after 24 hours.

        
  
  **Exceptions**
  
  *   :py:class:`CloudWatchLogs.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`CloudWatchLogs.Client.exceptions.ServiceUnavailableException`

  