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

******************
DescribeFpgaImages
******************



.. py:class:: EC2.Paginator.DescribeFpgaImages

  ::

    
    paginator = client.get_paginator('describe_fpga_images')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DryRun=True|False,
          FpgaImageIds=[
              'string',
          ],
          Owners=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      '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 FpgaImageIds: list
    :param FpgaImageIds: 

      The AFI IDs.

      

    
      - *(string) --* 

      
  
    :type Owners: list
    :param Owners: 

      Filters the AFI by owner. Specify an Amazon Web Services account ID, ``self`` (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are ``amazon`` | ``aws-marketplace``).

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      The filters.

       

      
      * ``create-time`` - The creation time of the AFI.
       
      * ``fpga-image-id`` - The FPGA image identifier (AFI ID).
       
      * ``fpga-image-global-id`` - The global FPGA image identifier (AGFI ID).
       
      * ``name`` - The name of the AFI.
       
      * ``owner-id`` - The Amazon Web Services account ID of the AFI owner.
       
      * ``product-code`` - The product code.
       
      * ``shell-version`` - The version of the Amazon Web Services Shell that was used to create the bitstream.
       
      * ``state`` - The state of the AFI ( ``pending`` | ``failed`` | ``available`` | ``unavailable``).
       
      * ``tag``:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key ``Owner`` and the value ``TeamA``, specify ``tag:Owner`` for the filter name and ``TeamA`` for the filter value.
       
      * ``tag-key`` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
       
      * ``update-time`` - The time of the most recent update.
      

      

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

      
      ::

        {
            'FpgaImages': [
                {
                    'FpgaImageId': 'string',
                    'FpgaImageGlobalId': 'string',
                    'Name': 'string',
                    'Description': 'string',
                    'ShellVersion': 'string',
                    'PciId': {
                        'DeviceId': 'string',
                        'VendorId': 'string',
                        'SubsystemId': 'string',
                        'SubsystemVendorId': 'string'
                    },
                    'State': {
                        'Code': 'pending'|'failed'|'available'|'unavailable',
                        'Message': 'string'
                    },
                    'CreateTime': datetime(2015, 1, 1),
                    'UpdateTime': datetime(2015, 1, 1),
                    'OwnerId': 'string',
                    'OwnerAlias': 'string',
                    'ProductCodes': [
                        {
                            'ProductCodeId': 'string',
                            'ProductCodeType': 'devpay'|'marketplace'
                        },
                    ],
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'Public': True|False,
                    'DataRetentionSupport': True|False,
                    'InstanceTypes': [
                        'string',
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **FpgaImages** *(list) --* 

          Information about the FPGA images.

          
          

          - *(dict) --* 

            Describes an Amazon FPGA image (AFI).

            
            

            - **FpgaImageId** *(string) --* 

              The FPGA image identifier (AFI ID).

              
            

            - **FpgaImageGlobalId** *(string) --* 

              The global FPGA image identifier (AGFI ID).

              
            

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

              The name of the AFI.

              
            

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

              The description of the AFI.

              
            

            - **ShellVersion** *(string) --* 

              The version of the Amazon Web Services Shell that was used to create the bitstream.

              
            

            - **PciId** *(dict) --* 

              Information about the PCI bus.

              
              

              - **DeviceId** *(string) --* 

                The ID of the device.

                
              

              - **VendorId** *(string) --* 

                The ID of the vendor.

                
              

              - **SubsystemId** *(string) --* 

                The ID of the subsystem.

                
              

              - **SubsystemVendorId** *(string) --* 

                The ID of the vendor for the subsystem.

                
          
            

            - **State** *(dict) --* 

              Information about the state of the AFI.

              
              

              - **Code** *(string) --* 

                The state. The following are the possible values:

                 

                
                * ``pending`` - AFI bitstream generation is in progress.
                 
                * ``available`` - The AFI is available for use.
                 
                * ``failed`` - AFI bitstream generation failed.
                 
                * ``unavailable`` - The AFI is no longer available for use.
                

                
              

              - **Message** *(string) --* 

                If the state is ``failed``, this is the error message.

                
          
            

            - **CreateTime** *(datetime) --* 

              The date and time the AFI was created.

              
            

            - **UpdateTime** *(datetime) --* 

              The time of the most recent update to the AFI.

              
            

            - **OwnerId** *(string) --* 

              The ID of the Amazon Web Services account that owns the AFI.

              
            

            - **OwnerAlias** *(string) --* 

              The alias of the AFI owner. Possible values include ``self``, ``amazon``, and ``aws-marketplace``.

              
            

            - **ProductCodes** *(list) --* 

              The product codes for the AFI.

              
              

              - *(dict) --* 

                Describes a product code.

                
                

                - **ProductCodeId** *(string) --* 

                  The product code.

                  
                

                - **ProductCodeType** *(string) --* 

                  The type of product code.

                  
            
          
            

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

              Any tags assigned to the AFI.

              
              

              - *(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.

                  
            
          
            

            - **Public** *(boolean) --* 

              Indicates whether the AFI is public.

              
            

            - **DataRetentionSupport** *(boolean) --* 

              Indicates whether data retention support is enabled for the AFI.

              
            

            - **InstanceTypes** *(list) --* 

              The instance types supported by the AFI.

              
              

              - *(string) --* 
          
        
      
    