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

***********************************
purchase_reserved_instance_offering
***********************************



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

  

  Allows you to purchase Amazon OpenSearch Service Reserved Instances.

  

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


  **Request Syntax**
  ::

    response = client.purchase_reserved_instance_offering(
        ReservedInstanceOfferingId='string',
        ReservationName='string',
        InstanceCount=123
    )
    
  :type ReservedInstanceOfferingId: string
  :param ReservedInstanceOfferingId: **[REQUIRED]** 

    The ID of the Reserved Instance offering to purchase.

    

  
  :type ReservationName: string
  :param ReservationName: **[REQUIRED]** 

    A customer-specified identifier to track this reservation.

    

  
  :type InstanceCount: integer
  :param InstanceCount: 

    The number of OpenSearch instances to reserve.

    

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

    
    ::

      {
          'ReservedInstanceId': 'string',
          'ReservationName': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 

      Represents the output of a ``PurchaseReservedInstanceOffering`` operation.

      
      

      - **ReservedInstanceId** *(string) --* 

        The ID of the Reserved Instance offering that was purchased.

        
      

      - **ReservationName** *(string) --* 

        The customer-specified identifier used to track this reservation.

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

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

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

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

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

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

  