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

************************
DescribeFastLaunchImages
************************



.. py:class:: EC2.Paginator.DescribeFastLaunchImages

  ::

    
    paginator = client.get_paginator('describe_fast_launch_images')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ImageIds=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          DryRun=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ImageIds: list
    :param ImageIds: 

      Specify one or more Windows AMI image IDs for the request.

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      Use the following filters to streamline results.

       

      
      * ``resource-type`` - The resource type for pre-provisioning.
       
      * ``owner-id`` - The owner ID for the pre-provisioning resource.
       
      * ``state`` - The current state of fast launching for the Windows AMI.
      

      

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

      
      ::

        {
            'FastLaunchImages': [
                {
                    'ImageId': 'string',
                    'ResourceType': 'snapshot',
                    'SnapshotConfiguration': {
                        'TargetResourceCount': 123
                    },
                    'LaunchTemplate': {
                        'LaunchTemplateId': 'string',
                        'LaunchTemplateName': 'string',
                        'Version': 'string'
                    },
                    'MaxParallelLaunches': 123,
                    'OwnerId': 'string',
                    'State': 'enabling'|'enabling-failed'|'enabled'|'enabled-failed'|'disabling'|'disabling-failed',
                    'StateTransitionReason': 'string',
                    'StateTransitionTime': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **FastLaunchImages** *(list) --* 

          A collection of details about the fast-launch enabled Windows images that meet the requested criteria.

          
          

          - *(dict) --* 

            Describe details about a Windows image with Windows fast launch enabled that meets the requested criteria. Criteria are defined by the ``DescribeFastLaunchImages`` action filters.

            
            

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

              The image ID that identifies the Windows fast launch enabled image.

              
            

            - **ResourceType** *(string) --* 

              The resource type that Amazon EC2 uses for pre-provisioning the Windows AMI. Supported values include: ``snapshot``.

              
            

            - **SnapshotConfiguration** *(dict) --* 

              A group of parameters that are used for pre-provisioning the associated Windows AMI using snapshots.

              
              

              - **TargetResourceCount** *(integer) --* 

                The number of pre-provisioned snapshots requested to keep on hand for a Windows fast launch enabled AMI.

                
          
            

            - **LaunchTemplate** *(dict) --* 

              The launch template that the Windows fast launch enabled AMI uses when it launches Windows instances from pre-provisioned snapshots.

              
              

              - **LaunchTemplateId** *(string) --* 

                The ID of the launch template that the AMI uses for Windows fast launch.

                
              

              - **LaunchTemplateName** *(string) --* 

                The name of the launch template that the AMI uses for Windows fast launch.

                
              

              - **Version** *(string) --* 

                The version of the launch template that the AMI uses for Windows fast launch.

                
          
            

            - **MaxParallelLaunches** *(integer) --* 

              The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows fast launch.

              
            

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

              The owner ID for the Windows fast launch enabled AMI.

              
            

            - **State** *(string) --* 

              The current state of Windows fast launch for the specified Windows AMI.

              
            

            - **StateTransitionReason** *(string) --* 

              The reason that Windows fast launch for the AMI changed to the current state.

              
            

            - **StateTransitionTime** *(datetime) --* 

              The time that Windows fast launch for the AMI changed to the current state.

              
        
      
    