DescribeReservedNodesOfferingsCommand

Suggest an Edit

Lists available reserved node offerings.

Example Syntax

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

import { MemoryDBClient, DescribeReservedNodesOfferingsCommand } from "@aws-sdk/client-memorydb"; // ES Modules import
// const { MemoryDBClient, DescribeReservedNodesOfferingsCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import
const client = new MemoryDBClient(config);
const input = { // DescribeReservedNodesOfferingsRequest
  ReservedNodesOfferingId: "STRING_VALUE",
  NodeType: "STRING_VALUE",
  Duration: "STRING_VALUE",
  OfferingType: "STRING_VALUE",
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new DescribeReservedNodesOfferingsCommand(input);
const response = await client.send(command);
// { // DescribeReservedNodesOfferingsResponse
//   NextToken: "STRING_VALUE",
//   ReservedNodesOfferings: [ // ReservedNodesOfferingList
//     { // ReservedNodesOffering
//       ReservedNodesOfferingId: "STRING_VALUE",
//       NodeType: "STRING_VALUE",
//       Duration: Number("int"),
//       FixedPrice: Number("double"),
//       OfferingType: "STRING_VALUE",
//       RecurringCharges: [ // RecurringChargeList
//         { // RecurringCharge
//           RecurringChargeAmount: Number("double"),
//           RecurringChargeFrequency: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
// };

DescribeReservedNodesOfferingsCommand Input

See DescribeReservedNodesOfferingsCommandInput for more details

Parameter
Type
Description
Duration
string | undefined

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

MaxResults
number | undefined

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.

NextToken
string | undefined

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.

NodeType
string | undefined

The node type for the reserved nodes. For more information, see Supported node types .

OfferingType
string | undefined

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"

ReservedNodesOfferingId
string | undefined

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

DescribeReservedNodesOfferingsCommand Output

See DescribeReservedNodesOfferingsCommandOutput for details

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

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.

ReservedNodesOfferings
ReservedNodesOffering[] | undefined

Lists available reserved node offerings.

Throws

Name
Fault
Details
InvalidParameterCombinationException
client

InvalidParameterValueException
client

ReservedNodesOfferingNotFoundFault
client

The requested node offering does not exist.

ServiceLinkedRoleNotFoundFault
client

MemoryDBServiceException
Base exception class for all service exceptions from MemoryDB service.