Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

See also: AWS API Documentation

Request Syntax

response = client.describe_reserved_instances(
  • ReservedInstanceId (string) -- The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
  • MaxResults (integer) -- An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
  • NextToken (string) -- If your initial DescribeReservedInstances operation returns a nextToken , you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.
Return type



Response Syntax

    'NextToken': 'string',
    'ReservedInstances': [
            'ReservationName': 'string',
            'ReservedInstanceId': 'string',
            'BillingSubscriptionId': 123,
            'ReservedInstanceOfferingId': 'string',
            'InstanceType': ''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|''|'',
            'StartTime': datetime(2015, 1, 1),
            'Duration': 123,
            'FixedPrice': 123.0,
            'UsagePrice': 123.0,
            'CurrencyCode': 'string',
            'InstanceCount': 123,
            'State': 'string',
            'PaymentOption': 'ALL_UPFRONT'|'PARTIAL_UPFRONT'|'NO_UPFRONT',
            'RecurringCharges': [
                    'RecurringChargeAmount': 123.0,
                    'RecurringChargeFrequency': 'string'

Response Structure

  • (dict) --

    Container for results from DescribeReservedInstances

    • NextToken (string) --

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

    • ReservedInstances (list) --

      List of Reserved Instances in the current Region.

      • (dict) --

        Details of an OpenSearch Reserved Instance.

        • ReservationName (string) --

          The customer-specified identifier to track this reservation.

        • ReservedInstanceId (string) --

          The unique identifier for the reservation.

        • BillingSubscriptionId (integer) --

          The unique identifier of the billing subscription.

        • ReservedInstanceOfferingId (string) --

          The unique identifier of the Reserved Instance offering.

        • InstanceType (string) --

          The OpenSearch instance type offered by theReserved Instance offering.

        • StartTime (datetime) --

          The date and time when the reservation was purchased.

        • Duration (integer) --

          The duration, in seconds, for which the OpenSearch instance is reserved.

        • FixedPrice (float) --

          The upfront fixed charge you will paid 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 offering.

        • InstanceCount (integer) --

          The number of OpenSearch instances that have been reserved.

        • State (string) --

          The state of the Reserved Instance.

        • PaymentOption (string) --

          The payment option as defined in the Reserved Instance offering.

        • RecurringCharges (list) --

          The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance 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.


  • OpenSearchService.Client.exceptions.ResourceNotFoundException
  • OpenSearchService.Client.exceptions.InternalException
  • OpenSearchService.Client.exceptions.ValidationException
  • OpenSearchService.Client.exceptions.DisabledOperationException