OpenSearchService / Client / purchase_reserved_instance_offering

purchase_reserved_instance_offering#

OpenSearchService.Client.purchase_reserved_instance_offering(**kwargs)#

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

See also: AWS API Documentation

Request Syntax

response = client.purchase_reserved_instance_offering(
    ReservedInstanceOfferingId='string',
    ReservationName='string',
    InstanceCount=123
)
Parameters:
  • ReservedInstanceOfferingId (string) –

    [REQUIRED]

    The ID of the Reserved Instance offering to purchase.

  • ReservationName (string) –

    [REQUIRED]

    A customer-specified identifier to track this reservation.

  • InstanceCount (integer) – The number of OpenSearch instances to reserve.

Return type:

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

  • OpenSearchService.Client.exceptions.ResourceNotFoundException

  • OpenSearchService.Client.exceptions.ResourceAlreadyExistsException

  • OpenSearchService.Client.exceptions.LimitExceededException

  • OpenSearchService.Client.exceptions.DisabledOperationException

  • OpenSearchService.Client.exceptions.ValidationException

  • OpenSearchService.Client.exceptions.InternalException