:doc:`EC2 <../../ec2>` / Paginator / DescribeImportImageTasks

************************
DescribeImportImageTasks
************************



.. py:class:: EC2.Paginator.DescribeImportImageTasks

  ::

    
    paginator = client.get_paginator('describe_import_image_tasks')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`EC2.Client.describe_import_image_tasks`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DryRun=True|False,
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          ImportTaskIds=[
              'string',
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 ImportTaskIds: list
    :param ImportTaskIds: 

      The IDs of the import image tasks.

      

    
      - *(string) --* 

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

      
      ::

        {
            'ImportImageTasks': [
                {
                    'Architecture': 'string',
                    'Description': 'string',
                    'Encrypted': True|False,
                    'Hypervisor': 'string',
                    'ImageId': 'string',
                    'ImportTaskId': 'string',
                    'KmsKeyId': 'string',
                    'LicenseType': 'string',
                    'Platform': 'string',
                    'Progress': 'string',
                    'SnapshotDetails': [
                        {
                            'Description': 'string',
                            'DeviceName': 'string',
                            'DiskImageSize': 123.0,
                            'Format': 'string',
                            'Progress': 'string',
                            'SnapshotId': 'string',
                            'Status': 'string',
                            'StatusMessage': 'string',
                            'Url': 'string',
                            'UserBucket': {
                                'S3Bucket': 'string',
                                'S3Key': 'string'
                            }
                        },
                    ],
                    'Status': 'string',
                    'StatusMessage': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'LicenseSpecifications': [
                        {
                            'LicenseConfigurationArn': 'string'
                        },
                    ],
                    'UsageOperation': 'string',
                    'BootMode': 'legacy-bios'|'uefi'|'uefi-preferred'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **ImportImageTasks** *(list) --* 

          A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.

          
          

          - *(dict) --* 

            Describes an import image task.

            
            

            - **Architecture** *(string) --* 

              The architecture of the virtual machine.

               

              Valid values: ``i386`` | ``x86_64`` | ``arm64``

              
            

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

              A description of the import task.

              
            

            - **Encrypted** *(boolean) --* 

              Indicates whether the image is encrypted.

              
            

            - **Hypervisor** *(string) --* 

              The target hypervisor for the import task.

               

              Valid values: ``xen``

              
            

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

              The ID of the Amazon Machine Image (AMI) of the imported virtual machine.

              
            

            - **ImportTaskId** *(string) --* 

              The ID of the import image task.

              
            

            - **KmsKeyId** *(string) --* 

              The identifier for the KMS key that was used to create the encrypted image.

              
            

            - **LicenseType** *(string) --* 

              The license type of the virtual machine.

              
            

            - **Platform** *(string) --* 

              The description string for the import image task.

              
            

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

              The percentage of progress of the import image task.

              
            

            - **SnapshotDetails** *(list) --* 

              Information about the snapshots.

              
              

              - *(dict) --* 

                Describes the snapshot created from the imported disk.

                
                

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

                  A description for the snapshot.

                  
                

                - **DeviceName** *(string) --* 

                  The block device mapping for the snapshot.

                  
                

                - **DiskImageSize** *(float) --* 

                  The size of the disk in the snapshot, in GiB.

                  
                

                - **Format** *(string) --* 

                  The format of the disk image from which the snapshot is created.

                  
                

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

                  The percentage of progress for the task.

                  
                

                - **SnapshotId** *(string) --* 

                  The snapshot ID of the disk being imported.

                  
                

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

                  A brief status of the snapshot creation.

                  
                

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

                  A detailed status message for the snapshot creation.

                  
                

                - **Url** *(string) --* 

                  The URL used to access the disk image.

                  
                

                - **UserBucket** *(dict) --* 

                  The Amazon S3 bucket for the disk image.

                  
                  

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

                    The Amazon S3 bucket from which the disk image was created.

                    
                  

                  - **S3Key** *(string) --* 

                    The file name of the disk image.

                    
              
            
          
            

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

              A brief status for the import image task.

              
            

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

              A descriptive status message for the import image task.

              
            

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

              The tags for the import 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.

                  
            
          
            

            - **LicenseSpecifications** *(list) --* 

              The ARNs of the license configurations that are associated with the import image task.

              
              

              - *(dict) --* 

                The response information for license configurations.

                
                

                - **LicenseConfigurationArn** *(string) --* 

                  The ARN of a license configuration.

                  
            
          
            

            - **UsageOperation** *(string) --* 

              The usage operation value.

              
            

            - **BootMode** *(string) --* 

              The boot mode of the virtual machine.

              
        
      
    