Redshift / Client / get_reserved_node_exchange_configuration_options

get_reserved_node_exchange_configuration_options#

Redshift.Client.get_reserved_node_exchange_configuration_options(**kwargs)#

Gets the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node offering. Details include the node type, the price, the node count, and the offering type.

Request Syntax

response = client.get_reserved_node_exchange_configuration_options(
    ActionType='restore-cluster'|'resize-cluster',
    ClusterIdentifier='string',
    SnapshotIdentifier='string',
    MaxRecords=123,
    Marker='string'
)

Parameters:

ActionType (string) –
[REQUIRED]

The action type of the reserved-node configuration. The action type can be an exchange initiated from either a snapshot or a resize.
ClusterIdentifier (string) – The identifier for the cluster that is the source for a reserved-node exchange.
SnapshotIdentifier (string) – The identifier for the snapshot that is the source for the reserved-node exchange.
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.
Marker (string) – An optional pagination token provided by a previous GetReservedNodeExchangeConfigurationOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by the MaxRecords parameter. 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',
    'ReservedNodeConfigurationOptionList': [
        {
            'SourceReservedNode': {
                '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'
            },
            'TargetReservedNodeCount': 123,
            'TargetReservedNodeOffering': {
                '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 pagination token provided by a previous GetReservedNodeExchangeConfigurationOptions request.
- ReservedNodeConfigurationOptionList (list) –
  
  the configuration options for the reserved-node exchange. These options include information about the source reserved node and target reserved node. Details include the node type, the price, the node count, and the offering type.
  - (dict) –
    
    Details for a reserved-node exchange. Examples include the node type for a reserved node, the price for a node, the node’s state, and other details.
    - SourceReservedNode (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) –
    - TargetReservedNodeCount (integer) –
      
      The target reserved-node count.
    - TargetReservedNodeOffering (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.ReservedNodeNotFoundFault
Redshift.Client.exceptions.InvalidReservedNodeStateFault
Redshift.Client.exceptions.ReservedNodeAlreadyMigratedFault
Redshift.Client.exceptions.ReservedNodeOfferingNotFoundFault
Redshift.Client.exceptions.UnsupportedOperationFault
Redshift.Client.exceptions.DependentServiceUnavailableFault
Redshift.Client.exceptions.ClusterNotFoundFault
Redshift.Client.exceptions.ClusterSnapshotNotFoundFault