Redshift / Client / describe_reserved_node_offerings

describe_reserved_node_offerings

Redshift.Client.describe_reserved_node_offerings(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_reserved_node_offerings(
    ReservedNodeOfferingId='string',
    MaxRecords=123,
    Marker='string'
)

Parameters:

• ReservedNodeOfferingId (string) – The unique identifier for the offering.

• 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 DescribeReservedNodeOfferings 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',
    'ReservedNodeOfferings': [
        {
            'ReservedNodeOfferingId': 'string',
            'NodeType': 'string',
            'Duration': 123,
            'FixedPrice': 123.0,
            'UsagePrice': 123.0,
            'CurrencyCode': '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.

  • ReservedNodeOfferings (list) –

    A list of ReservedNodeOffering objects.

    • (dict) –

      Describes a reserved node offering.

      • ReservedNodeOfferingId (string) –

        The offering identifier.

      • NodeType (string) –

        The node type offered by the reserved node offering.

      • Duration (integer) –

        The duration, in seconds, for which the offering will reserve the node.

      • FixedPrice (float) –

        The upfront fixed charge you will pay to purchase the specific reserved node offering.

      • UsagePrice (float) –

        The rate you are charged for each hour the cluster that is using the offering is running.

      • CurrencyCode (string) –

        The currency code for the compute nodes offering.

      • OfferingType (string) –

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

      • RecurringCharges (list) –

        The charge to your account regardless of whether you are creating any clusters using the node offering. Recurring charges are only in effect for heavy-utilization reserved nodes.

        • (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

• Redshift.Client.exceptions.ReservedNodeOfferingNotFoundFault

• Redshift.Client.exceptions.UnsupportedOperationFault

• Redshift.Client.exceptions.DependentServiceUnavailableFault