Skip to content

Describe Reserved Nodes

redshift_describe_reserved_nodes R Documentation

Returns the descriptions of the reserved nodes

Description

Returns the descriptions of the reserved nodes.

Usage

redshift_describe_reserved_nodes(ReservedNodeId, MaxRecords, Marker)

Arguments

ReservedNodeId

Identifier for the node reservation.

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.

Marker

An optional parameter that specifies the starting point to return a set of response records. When the results of a describe_reserved_nodes 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.

Value

A list with the following syntax:

list(
  Marker = "string",
  ReservedNodes = list(
    list(
      ReservedNodeId = "string",
      ReservedNodeOfferingId = "string",
      NodeType = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      Duration = 123,
      FixedPrice = 123.0,
      UsagePrice = 123.0,
      CurrencyCode = "string",
      NodeCount = 123,
      State = "string",
      OfferingType = "string",
      RecurringCharges = list(
        list(
          RecurringChargeAmount = 123.0,
          RecurringChargeFrequency = "string"
        )
      ),
      ReservedNodeOfferingType = "Regular"|"Upgradable"
    )
  )
)

Request syntax

svc$describe_reserved_nodes(
  ReservedNodeId = "string",
  MaxRecords = 123,
  Marker = "string"
)