:doc:`EC2 <../../ec2>` / Client / describe_export_image_tasks

***************************
describe_export_image_tasks
***************************



.. py:method:: EC2.Client.describe_export_image_tasks(**kwargs)

  

  Describes the specified export image tasks or all of your export image tasks.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeExportImageTasks>`_  


  **Request Syntax**
  ::

    response = client.describe_export_image_tasks(
        DryRun=True|False,
        Filters=[
            {
                'Name': 'string',
                'Values': [
                    'string',
                ]
            },
        ],
        ExportImageTaskIds=[
            'string',
        ],
        MaxResults=123,
        NextToken='string'
    )
    
  :type DryRun: boolean
  :param DryRun: 

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ``DryRunOperation``. Otherwise, it is ``UnauthorizedOperation``.

    

  
  :type Filters: list
  :param Filters: 

    Filter tasks using the ``task-state`` filter and one of the following values: ``active``, ``completed``, ``deleting``, or ``deleted``.

    

  
    - *(dict) --* 

      A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

       

      If you specify multiple filters, the filters are joined with an ``AND``, and the request returns only results that match all of the specified filters.

       

      For more information, see `List and filter using the CLI and API <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI>`__ in the *Amazon EC2 User Guide*.

      

    
      - **Name** *(string) --* 

        The name of the filter. Filter names are case-sensitive.

        

      
      - **Values** *(list) --* 

        The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an ``OR``, and the request returns all results that match any of the specified values.

        

      
        - *(string) --* 

        
    
    

  :type ExportImageTaskIds: list
  :param ExportImageTaskIds: 

    The IDs of the export image tasks.

    

  
    - *(string) --* 

    

  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in a single call.

    

  
  :type NextToken: string
  :param NextToken: 

    A token that indicates the next page of results.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'ExportImageTasks': [
              {
                  'Description': 'string',
                  'ExportImageTaskId': 'string',
                  'ImageId': 'string',
                  'Progress': 'string',
                  'S3ExportLocation': {
                      'S3Bucket': 'string',
                      'S3Prefix': 'string'
                  },
                  'Status': 'string',
                  'StatusMessage': 'string',
                  'Tags': [
                      {
                          'Key': 'string',
                          'Value': 'string'
                      },
                  ]
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ExportImageTasks** *(list) --* 

        Information about the export image tasks.

        
        

        - *(dict) --* 

          Describes an export image task.

          
          

          - **Description** *(string) --* 

            A description of the image being exported.

            
          

          - **ExportImageTaskId** *(string) --* 

            The ID of the export image task.

            
          

          - **ImageId** *(string) --* 

            The ID of the image.

            
          

          - **Progress** *(string) --* 

            The percent complete of the export image task.

            
          

          - **S3ExportLocation** *(dict) --* 

            Information about the destination Amazon S3 bucket.

            
            

            - **S3Bucket** *(string) --* 

              The destination Amazon S3 bucket.

              
            

            - **S3Prefix** *(string) --* 

              The prefix (logical hierarchy) in the bucket.

              
        
          

          - **Status** *(string) --* 

            The status of the export image task. The possible values are ``active``, ``completed``, ``deleting``, and ``deleted``.

            
          

          - **StatusMessage** *(string) --* 

            The status message for the export image task.

            
          

          - **Tags** *(list) --* 

            Any tags assigned to the export image task.

            
            

            - *(dict) --* 

              Describes a tag.

              
              

              - **Key** *(string) --* 

                The key of the tag.

                 

                Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with ``aws:``.

                
              

              - **Value** *(string) --* 

                The value of the tag.

                 

                Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

                
          
        
      
    
      

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

        The token to use to get the next page of results. This value is ``null`` when there are no more results to return.

        
  