Redshift / Paginator / DescribeReservedNodes

DescribeReservedNodes

class Redshift.Paginator.DescribeReservedNodes

paginator = client.get_paginator('describe_reserved_nodes')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Redshift.Client.describe_reserved_nodes().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ReservedNodeId='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    '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'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • 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) –

  • NextToken (string) –

    A token to resume pagination.