Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeReservedNodes

Returns information about reserved nodes for this account, or about a specified reserved node.

Request Syntax


{
   "Duration": "string",
   "MaxResults": number,
   "NextToken": "string",
   "NodeType": "string",
   "OfferingType": "string",
   "ReservationId": "string",
   "ReservedNodesOfferingId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Duration

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

Type: String

Required: No

MaxResults

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Type: Integer

Required: No

NextToken

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Type: String

Required: No

NodeType

The node type filter value. Use this parameter to show only those reservations matching the specified node type. For more information, see Supported node types.

Type: String

Required: No

OfferingType

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "All Upfront"|"Partial Upfront"| "No Upfront"

Type: String

Required: No

ReservationId

The reserved node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

Type: String

Required: No

ReservedNodesOfferingId

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Type: String

Required: No

Response Syntax


{
   "NextToken": "string",
   "ReservedNodes": [ 
      { 
         "ARN": "string",
         "Duration": number,
         "FixedPrice": number,
         "NodeCount": number,
         "NodeType": "string",
         "OfferingType": "string",
         "RecurringCharges": [ 
            { 
               "RecurringChargeAmount": number,
               "RecurringChargeFrequency": "string"
            }
         ],
         "ReservationId": "string",
         "ReservedNodesOfferingId": "string",
         "StartTime": number,
         "State": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

Type: String

ReservedNodes

Returns information about reserved nodes for this account, or about a specified reserved node.

Type: Array of ReservedNode objects

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterCombinationException

HTTP Status Code: 400

InvalidParameterValueException

HTTP Status Code: 400

ReservedNodeNotFoundFault

The requested node does not exist.

HTTP Status Code: 400

ServiceLinkedRoleNotFoundFault

HTTP Status Code: 400