EC2 / Client / get_reserved_instances_exchange_quote

get_reserved_instances_exchange_quote#

EC2.Client.get_reserved_instances_exchange_quote(**kwargs)#

Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use AcceptReservedInstancesExchangeQuote to perform the exchange.

Request Syntax

response = client.get_reserved_instances_exchange_quote(
    DryRun=True|False,
    ReservedInstanceIds=[
        'string',
    ],
    TargetConfigurations=[
        {
            'InstanceCount': 123,
            'OfferingId': 'string'
        },
    ]
)

Parameters:

DryRun (boolean) – Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
ReservedInstanceIds (list) –
[REQUIRED]

The IDs of the Convertible Reserved Instances to exchange.
- (string) –
TargetConfigurations (list) –
The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
- (dict) –
  
  Details about the target configuration.
  - InstanceCount (integer) –
    
    The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request
  - OfferingId (string) – [REQUIRED]
    
    The Convertible Reserved Instance offering ID.

Return type:

dict

Returns:

Response Syntax

{
    'CurrencyCode': 'string',
    'IsValidExchange': True|False,
    'OutputReservedInstancesWillExpireAt': datetime(2015, 1, 1),
    'PaymentDue': 'string',
    'ReservedInstanceValueRollup': {
        'HourlyPrice': 'string',
        'RemainingTotalValue': 'string',
        'RemainingUpfrontValue': 'string'
    },
    'ReservedInstanceValueSet': [
        {
            'ReservationValue': {
                'HourlyPrice': 'string',
                'RemainingTotalValue': 'string',
                'RemainingUpfrontValue': 'string'
            },
            'ReservedInstanceId': 'string'
        },
    ],
    'TargetConfigurationValueRollup': {
        'HourlyPrice': 'string',
        'RemainingTotalValue': 'string',
        'RemainingUpfrontValue': 'string'
    },
    'TargetConfigurationValueSet': [
        {
            'ReservationValue': {
                'HourlyPrice': 'string',
                'RemainingTotalValue': 'string',
                'RemainingUpfrontValue': 'string'
            },
            'TargetConfiguration': {
                'InstanceCount': 123,
                'OfferingId': 'string'
            }
        },
    ],
    'ValidationFailureReason': 'string'
}

Response Structure

(dict) –

Contains the output of GetReservedInstancesExchangeQuote.
- CurrencyCode (string) –
  
  The currency of the transaction.
- IsValidExchange (boolean) –
  
  If true, the exchange is valid. If false, the exchange cannot be completed.
- OutputReservedInstancesWillExpireAt (datetime) –
  
  The new end date of the reservation term.
- PaymentDue (string) –
  
  The total true upfront charge for the exchange.
- ReservedInstanceValueRollup (dict) –
  
  The cost associated with the Reserved Instance.
  - HourlyPrice (string) –
    
    The hourly rate of the reservation.
  - RemainingTotalValue (string) –
    
    The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
  - RemainingUpfrontValue (string) –
    
    The remaining upfront cost of the reservation.
- ReservedInstanceValueSet (list) –
  
  The configuration of your Convertible Reserved Instances.
  - (dict) –
    
    The total value of the Convertible Reserved Instance.
    - ReservationValue (dict) –
      
      The total value of the Convertible Reserved Instance that you are exchanging.
      - HourlyPrice (string) –
        
        The hourly rate of the reservation.
      - RemainingTotalValue (string) –
        
        The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
      - RemainingUpfrontValue (string) –
        
        The remaining upfront cost of the reservation.
    - ReservedInstanceId (string) –
      
      The ID of the Convertible Reserved Instance that you are exchanging.
- TargetConfigurationValueRollup (dict) –
  
  The cost associated with the Reserved Instance.
  - HourlyPrice (string) –
    
    The hourly rate of the reservation.
  - RemainingTotalValue (string) –
    
    The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
  - RemainingUpfrontValue (string) –
    
    The remaining upfront cost of the reservation.
- TargetConfigurationValueSet (list) –
  
  The values of the target Convertible Reserved Instances.
  - (dict) –
    
    The total value of the new Convertible Reserved Instances.
    - ReservationValue (dict) –
      
      The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange.
      - HourlyPrice (string) –
        
        The hourly rate of the reservation.
      - RemainingTotalValue (string) –
        
        The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
      - RemainingUpfrontValue (string) –
        
        The remaining upfront cost of the reservation.
    - TargetConfiguration (dict) –
      
      The configuration of the Convertible Reserved Instances that make up the exchange.
      - InstanceCount (integer) –
        
        The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request
      - OfferingId (string) –
        
        The ID of the Convertible Reserved Instance offering.
- ValidationFailureReason (string) –
  
  Describes the reason why the exchange cannot be completed.