:doc:`OpenSearchService <../../opensearch>` / Client / describe_reserved_instance_offerings

************************************
describe_reserved_instance_offerings
************************************



.. py:method:: OpenSearchService.Client.describe_reserved_instance_offerings(**kwargs)

  

  Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see `Reserved Instances in Amazon OpenSearch Service <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ri.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/DescribeReservedInstanceOfferings>`_  


  **Request Syntax**
  ::

    response = client.describe_reserved_instance_offerings(
        ReservedInstanceOfferingId='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type ReservedInstanceOfferingId: string
  :param ReservedInstanceOfferingId: 

    The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    An optional parameter that specifies the maximum number of results to return. You can use ``nextToken`` to get the next page of results.

    

  
  :type NextToken: string
  :param NextToken: 

    If your initial ``DescribeReservedInstanceOfferings`` operation returns a ``nextToken``, you can include the returned ``nextToken`` in subsequent ``DescribeReservedInstanceOfferings`` operations, which returns results in the next page.

    

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

    
    ::

      {
          'NextToken': 'string',
          'ReservedInstanceOfferings': [
              {
                  'ReservedInstanceOfferingId': 'string',
                  'InstanceType': 'm3.medium.search'|'m3.large.search'|'m3.xlarge.search'|'m3.2xlarge.search'|'m4.large.search'|'m4.xlarge.search'|'m4.2xlarge.search'|'m4.4xlarge.search'|'m4.10xlarge.search'|'m5.large.search'|'m5.xlarge.search'|'m5.2xlarge.search'|'m5.4xlarge.search'|'m5.12xlarge.search'|'m5.24xlarge.search'|'r5.large.search'|'r5.xlarge.search'|'r5.2xlarge.search'|'r5.4xlarge.search'|'r5.12xlarge.search'|'r5.24xlarge.search'|'c5.large.search'|'c5.xlarge.search'|'c5.2xlarge.search'|'c5.4xlarge.search'|'c5.9xlarge.search'|'c5.18xlarge.search'|'t3.nano.search'|'t3.micro.search'|'t3.small.search'|'t3.medium.search'|'t3.large.search'|'t3.xlarge.search'|'t3.2xlarge.search'|'or1.medium.search'|'or1.large.search'|'or1.xlarge.search'|'or1.2xlarge.search'|'or1.4xlarge.search'|'or1.8xlarge.search'|'or1.12xlarge.search'|'or1.16xlarge.search'|'ultrawarm1.medium.search'|'ultrawarm1.large.search'|'ultrawarm1.xlarge.search'|'t2.micro.search'|'t2.small.search'|'t2.medium.search'|'r3.large.search'|'r3.xlarge.search'|'r3.2xlarge.search'|'r3.4xlarge.search'|'r3.8xlarge.search'|'i2.xlarge.search'|'i2.2xlarge.search'|'d2.xlarge.search'|'d2.2xlarge.search'|'d2.4xlarge.search'|'d2.8xlarge.search'|'c4.large.search'|'c4.xlarge.search'|'c4.2xlarge.search'|'c4.4xlarge.search'|'c4.8xlarge.search'|'r4.large.search'|'r4.xlarge.search'|'r4.2xlarge.search'|'r4.4xlarge.search'|'r4.8xlarge.search'|'r4.16xlarge.search'|'i3.large.search'|'i3.xlarge.search'|'i3.2xlarge.search'|'i3.4xlarge.search'|'i3.8xlarge.search'|'i3.16xlarge.search'|'r6g.large.search'|'r6g.xlarge.search'|'r6g.2xlarge.search'|'r6g.4xlarge.search'|'r6g.8xlarge.search'|'r6g.12xlarge.search'|'m6g.large.search'|'m6g.xlarge.search'|'m6g.2xlarge.search'|'m6g.4xlarge.search'|'m6g.8xlarge.search'|'m6g.12xlarge.search'|'c6g.large.search'|'c6g.xlarge.search'|'c6g.2xlarge.search'|'c6g.4xlarge.search'|'c6g.8xlarge.search'|'c6g.12xlarge.search'|'r6gd.large.search'|'r6gd.xlarge.search'|'r6gd.2xlarge.search'|'r6gd.4xlarge.search'|'r6gd.8xlarge.search'|'r6gd.12xlarge.search'|'r6gd.16xlarge.search'|'t4g.small.search'|'t4g.medium.search',
                  'Duration': 123,
                  'FixedPrice': 123.0,
                  'UsagePrice': 123.0,
                  'CurrencyCode': 'string',
                  'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT',
                  'RecurringCharges': [
                      {
                          'RecurringChargeAmount': 123.0,
                          'RecurringChargeFrequency': 'string'
                      },
                  ]
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Container for results of a ``DescribeReservedInstanceOfferings`` request.

      
      

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

        When ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

        
      

      - **ReservedInstanceOfferings** *(list) --* 

        List of Reserved Instance offerings.

        
        

        - *(dict) --* 

          Details of an OpenSearch Reserved Instance offering.

          
          

          - **ReservedInstanceOfferingId** *(string) --* 

            The unique identifier of the Reserved Instance offering.

            
          

          - **InstanceType** *(string) --* 

            The OpenSearch instance type offered by the Reserved Instance offering.

            
          

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

            The duration, in seconds, for which the offering will reserve the OpenSearch instance.

            
          

          - **FixedPrice** *(float) --* 

            The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.

            
          

          - **UsagePrice** *(float) --* 

            The hourly rate at which you're charged for the domain using this Reserved Instance.

            
          

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

            The currency code for the Reserved Instance offering.

            
          

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

            Payment option for the Reserved Instance offering

            
          

          - **RecurringCharges** *(list) --* 

            The recurring charge to your account, regardless of whether you creates any domains using the offering.

            
            

            - *(dict) --* 

              Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.

              
              

              - **RecurringChargeAmount** *(float) --* 

                The monetary amount of the recurring charge.

                
              

              - **RecurringChargeFrequency** *(string) --* 

                The frequency of the recurring charge.

                
          
        
      
    
  
  **Exceptions**
  
  *   :py:class:`OpenSearchService.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.ValidationException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.DisabledOperationException`

  
  *   :py:class:`OpenSearchService.Client.exceptions.InternalException`

  