Skip to content

Describe Reserved Nodes

memorydb_describe_reserved_nodes R Documentation

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

Description

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

Usage

memorydb_describe_reserved_nodes(ReservationId, ReservedNodesOfferingId,
  NodeType, Duration, OfferingType, MaxResults, NextToken)

Arguments

ReservationId

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

ReservedNodesOfferingId

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

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.

Duration

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

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"

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.

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.

Value

A list with the following syntax: 

list(
  NextToken = "string",
  ReservedNodes = list(
    list(
      ReservationId = "string",
      ReservedNodesOfferingId = "string",
      NodeType = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      Duration = 123,
      FixedPrice = 123.0,
      NodeCount = 123,
      OfferingType = "string",
      State = "string",
      RecurringCharges = list(
        list(
          RecurringChargeAmount = 123.0,
          RecurringChargeFrequency = "string"
        )
      ),
      ARN = "string"
    )
  )
)

Request syntax

svc$describe_reserved_nodes(
  ReservationId = "string",
  ReservedNodesOfferingId = "string",
  NodeType = "string",
  Duration = "string",
  OfferingType = "string",
  MaxResults = 123,
  NextToken = "string"
)