Redshift / Client / describe_reserved_nodes

describe_reserved_nodes#

Redshift.Client.describe_reserved_nodes(**kwargs)#

Returns the descriptions of the reserved nodes.

See also: AWS API Documentation

Request Syntax

response = client.describe_reserved_nodes(
    ReservedNodeId='string',
    MaxRecords=123,
    Marker='string'
)
Parameters:

  • ReservedNodeId (string) – Identifier for the node reservation.

  • MaxRecords (integer) –

    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 (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'Marker': 'string',
    'ReservedNodes': [
        {
            'ReservedNodeId': 'string',
            'ReservedNodeOfferingId': 'string',
            'NodeType': 'string',
            'StartTime': datetime(2015, 1, 1),
            'Duration': 123,
            'FixedPrice': 123.0,
            'UsagePrice': 123.0,
            'CurrencyCode': 'string',
            'NodeCount': 123,
            'State': 'string',
            'OfferingType': 'string',
            'RecurringCharges': [
                {
                    'RecurringChargeAmount': 123.0,
                    'RecurringChargeFrequency': 'string'
                },
            ],
            'ReservedNodeOfferingType': 'Regular'|'Upgradable'
        },
    ]
}

Response Structure

  • (dict) –

    • Marker (string) –

      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 (list) –

      The list of ReservedNode objects.

      • (dict) –

        Describes a reserved node. You can call the DescribeReservedNodeOfferings API to obtain the available reserved node offerings.

        • ReservedNodeId (string) –

          The unique identifier for the reservation.

        • ReservedNodeOfferingId (string) –

          The identifier for the reserved node offering.

        • NodeType (string) –

          The node type of the reserved node.

        • StartTime (datetime) –

          The time the reservation started. You purchase a reserved node offering for a duration. This is the start time of that duration.

        • Duration (integer) –

          The duration of the node reservation in seconds.

        • FixedPrice (float) –

          The fixed cost Amazon Redshift charges you for this reserved node.

        • UsagePrice (float) –

          The hourly rate Amazon Redshift charges you for this reserved node.

        • CurrencyCode (string) –

          The currency code for the reserved cluster.

        • NodeCount (integer) –

          The number of reserved compute nodes.

        • State (string) –

          The state of the reserved compute node.

          Possible Values:

          • pending-payment-This reserved node has recently been purchased, and the sale has been approved, but payment has not yet been confirmed.

          • active-This reserved node is owned by the caller and is available for use.

          • payment-failed-Payment failed for the purchase attempt.

          • retired-The reserved node is no longer available.

          • exchanging-The owner is exchanging the reserved node for another reserved node.

        • OfferingType (string) –

          The anticipated utilization of the reserved node, as defined in the reserved node offering.

        • RecurringCharges (list) –

          The recurring charges for the reserved node.

          • (dict) –

            Describes a recurring charge.

            • RecurringChargeAmount (float) –

              The amount charged per the period of time specified by the recurring charge frequency.

            • RecurringChargeFrequency (string) –

              The frequency at which the recurring charge amount is applied.

        • ReservedNodeOfferingType (string) –

Exceptions