describeReservedNodeOfferings method

Future<ReservedNodeOfferingsMessage> describeReservedNodeOfferings({ String? marker, int? maxRecords, String? reservedNodeOfferingId, })

Returns a list of the available reserved node offerings by Amazon Redshift with their descriptions including the node type, the fixed and recurring costs of reserving the node and duration the node will be reserved for you. These descriptions help you determine which reserve node offering you want to purchase. You then use the unique offering ID in you call to PurchaseReservedNodeOffering to reserve one or more nodes for your Amazon Redshift cluster.

For more information about reserved node offerings, go to Purchasing Reserved Nodes in the Amazon Redshift Cluster Management Guide.

May throw ReservedNodeOfferingNotFoundFault. May throw UnsupportedOperationFault. May throw DependentServiceUnavailableFault.

Parameter marker : An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodeOfferings request exceed the value specified in MaxRecords, AWS 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.

Parameter maxRecords : 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.

Parameter reservedNodeOfferingId : The unique identifier for the offering.

Implementation

Future<ReservedNodeOfferingsMessage> describeReservedNodeOfferings({
  String? marker,
  int? maxRecords,
  String? reservedNodeOfferingId,
}) async {
  _s.validateStringLength(
    'marker',
    marker,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'reservedNodeOfferingId',
    reservedNodeOfferingId,
    0,
    2147483647,
  );
  final $request = <String, dynamic>{};
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  reservedNodeOfferingId
      ?.also((arg) => $request['ReservedNodeOfferingId'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeReservedNodeOfferings',
    version: '2012-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeReservedNodeOfferingsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeReservedNodeOfferingsResult',
  );
  return ReservedNodeOfferingsMessage.fromXml($result);
}