DescribeReservedNodesCommand

Suggest an Edit

Returns the descriptions of the reserved nodes.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RedshiftClient, DescribeReservedNodesCommand } from "@aws-sdk/client-redshift"; // ES Modules import
// const { RedshiftClient, DescribeReservedNodesCommand } = require("@aws-sdk/client-redshift"); // CommonJS import
const client = new RedshiftClient(config);
const input = { // DescribeReservedNodesMessage
  ReservedNodeId: "STRING_VALUE",
  MaxRecords: Number("int"),
  Marker: "STRING_VALUE",
};
const command = new DescribeReservedNodesCommand(input);
const response = await client.send(command);
// { // ReservedNodesMessage
//   Marker: "STRING_VALUE",
//   ReservedNodes: [ // ReservedNodeList
//     { // ReservedNode
//       ReservedNodeId: "STRING_VALUE",
//       ReservedNodeOfferingId: "STRING_VALUE",
//       NodeType: "STRING_VALUE",
//       StartTime: new Date("TIMESTAMP"),
//       Duration: Number("int"),
//       FixedPrice: Number("double"),
//       UsagePrice: Number("double"),
//       CurrencyCode: "STRING_VALUE",
//       NodeCount: Number("int"),
//       State: "STRING_VALUE",
//       OfferingType: "STRING_VALUE",
//       RecurringCharges: [ // RecurringChargeList
//         { // RecurringCharge
//           RecurringChargeAmount: Number("double"),
//           RecurringChargeFrequency: "STRING_VALUE",
//         },
//       ],
//       ReservedNodeOfferingType: "Regular" || "Upgradable",
//     },
//   ],
// };

DescribeReservedNodesCommand Input

See DescribeReservedNodesCommandInput for more details

Parameter
Type
Description
Marker
string | undefined

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

MaxRecords
number | undefined

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

ReservedNodeId
string | undefined

Identifier for the node reservation.

DescribeReservedNodesCommand Output

See DescribeReservedNodesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Marker
string | undefined

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

ReservedNodes
ReservedNode[] | undefined

The list of ReservedNode objects.

Throws

Name
Fault
Details
DependentServiceUnavailableFault
client

Your request cannot be completed because a dependent internal service is temporarily unavailable. Wait 30 to 60 seconds and try again.

ReservedNodeNotFoundFault
client

The specified reserved compute node not found.

RedshiftServiceException
Base exception class for all service exceptions from Redshift service.