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

********************************
DescribeHostReservationOfferings
********************************



.. py:class:: EC2.Paginator.DescribeHostReservationOfferings

  ::

    
    paginator = client.get_paginator('describe_host_reservation_offerings')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          MaxDuration=123,
          MinDuration=123,
          OfferingId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Filters: list
    :param Filters: 

      The filters.

       

      
      * ``instance-family`` - The instance family of the offering (for example, ``m4``).
       
      * ``payment-option`` - The payment option ( ``NoUpfront`` | ``PartialUpfront`` | ``AllUpfront``).
      

      

    
      - *(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 MaxDuration: integer
    :param MaxDuration: 

      This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.

      

    
    :type MinDuration: integer
    :param MinDuration: 

      This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.

      

    
    :type OfferingId: string
    :param OfferingId: 

      The ID of the reservation offering.

      

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

      
      ::

        {
            'OfferingSet': [
                {
                    'CurrencyCode': 'USD',
                    'Duration': 123,
                    'HourlyPrice': 'string',
                    'InstanceFamily': 'string',
                    'OfferingId': 'string',
                    'PaymentOption': 'AllUpfront'|'PartialUpfront'|'NoUpfront',
                    'UpfrontPrice': 'string'
                },
            ]
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **OfferingSet** *(list) --* 

          Information about the offerings.

          
          

          - *(dict) --* 

            Details about the Dedicated Host Reservation offering.

            
            

            - **CurrencyCode** *(string) --* 

              The currency of the offering.

              
            

            - **Duration** *(integer) --* 

              The duration of the offering (in seconds).

              
            

            - **HourlyPrice** *(string) --* 

              The hourly price of the offering.

              
            

            - **InstanceFamily** *(string) --* 

              The instance family of the offering.

              
            

            - **OfferingId** *(string) --* 

              The ID of the offering.

              
            

            - **PaymentOption** *(string) --* 

              The available payment option.

              
            

            - **UpfrontPrice** *(string) --* 

              The upfront price of the offering. Does not apply to No Upfront offerings.

              
        
      
    