AWS API Changes

2022/12/27 - Amazon MemoryDB - 3 new api methods

Changes This release adds support for MemoryDB Reserved nodes which provides a significant discount compared to on-demand node pricing. Reserved nodes are not physical nodes, but rather a billing discount applied to the use of on-demand nodes in your account.

DescribeReservedNodesOfferings (new)

Link ¶

Lists available reserved node offerings.

See also: AWS API Documentation

Request Syntax

client.describe_reserved_nodes_offerings(
    ReservedNodesOfferingId='string',
    NodeType='string',
    Duration='string',
    OfferingType='string',
    MaxResults=123,
    NextToken='string'
)

type ReservedNodesOfferingId:

string

param ReservedNodesOfferingId:

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

type NodeType:

string

param NodeType:

The node type for the reserved nodes. For more information, see Supported node types.

type Duration:

string

param Duration:

Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

type OfferingType:

string

param OfferingType:

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "All Upfront"|"Partial Upfront"| "No Upfront"

type MaxResults:

integer

param MaxResults:

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

type NextToken:

string

param NextToken:

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'ReservedNodesOfferings': [
        {
            'ReservedNodesOfferingId': 'string',
            'NodeType': 'string',
            'Duration': 123,
            'FixedPrice': 123.0,
            'OfferingType': 'string',
            'RecurringCharges': [
                {
                    'RecurringChargeAmount': 123.0,
                    'RecurringChargeFrequency': 'string'
                },
            ]
        },
    ]
}

Response Structure

(dict) --
- NextToken (string) --
  
  An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- ReservedNodesOfferings (list) --
  
  Lists available reserved node offerings.
  - (dict) --
    
    The offering type of this node.
    - ReservedNodesOfferingId (string) --
      
      The offering identifier.
    - NodeType (string) --
      
      The node type for the reserved nodes. For more information, see Supported node types.
    - Duration (integer) --
      
      The duration of the reservation in seconds.
    - FixedPrice (float) --
      
      The fixed price charged for this reserved node.
    - OfferingType (string) --
      
      The offering type of this reserved node.
    - RecurringCharges (list) --
      
      The recurring price charged to run this reserved node.
      - (dict) --
        
        The recurring charge to run this reserved node.
        
        RecurringChargeAmount (float) --
        
        The amount of the recurring charge to run this reserved node.
        
        RecurringChargeFrequency (string) --
        
        The frequency of the recurring price charged to run this reserved node.

DescribeReservedNodes (new)

Link ¶

Returns information about reserved nodes for this account, or about a specified reserved node.

See also: AWS API Documentation

Request Syntax

client.describe_reserved_nodes(
    ReservationId='string',
    ReservedNodesOfferingId='string',
    NodeType='string',
    Duration='string',
    OfferingType='string',
    MaxResults=123,
    NextToken='string'
)

type ReservationId:

string

param ReservationId:

The reserved node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

type ReservedNodesOfferingId:

string

param ReservedNodesOfferingId:

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

type NodeType:

string

param NodeType:

The node type filter value. Use this parameter to show only those reservations matching the specified node type. For more information, see Supported node types.

type Duration:

string

param Duration:

The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

type OfferingType:

string

param OfferingType:

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "All Upfront"|"Partial Upfront"| "No Upfront"

type MaxResults:

integer

param MaxResults:

type NextToken:

string

param NextToken:

rtype:

dict

returns:

Response Syntax

{
    'NextToken': 'string',
    'ReservedNodes': [
        {
            'ReservationId': 'string',
            'ReservedNodesOfferingId': 'string',
            'NodeType': 'string',
            'StartTime': datetime(2015, 1, 1),
            'Duration': 123,
            'FixedPrice': 123.0,
            'NodeCount': 123,
            'OfferingType': 'string',
            'State': 'string',
            'RecurringCharges': [
                {
                    'RecurringChargeAmount': 123.0,
                    'RecurringChargeFrequency': 'string'
                },
            ],
            'ARN': 'string'
        },
    ]
}

Response Structure

(dict) --
- NextToken (string) --
  
  An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
- ReservedNodes (list) --
  
  Returns information about reserved nodes for this account, or about a specified reserved node.
  - (dict) --
    
    Represents the output of a PurchaseReservedNodesOffering operation.
    - ReservationId (string) --
      
      A customer-specified identifier to track this reservation.
    - ReservedNodesOfferingId (string) --
      
      The ID of the reserved node offering to purchase.
    - NodeType (string) --
      
      The node type for the reserved nodes.
    - StartTime (datetime) --
      
      The time the reservation started.
    - Duration (integer) --
      
      The duration of the reservation in seconds.
    - FixedPrice (float) --
      
      The fixed price charged for this reserved node.
    - NodeCount (integer) --
      
      The number of nodes that have been reserved.
    - OfferingType (string) --
      
      The offering type of this reserved node.
    - State (string) --
      
      The state of the reserved node.
    - RecurringCharges (list) --
      
      The recurring price charged to run this reserved node.
      - (dict) --
        
        The recurring charge to run this reserved node.
        
        RecurringChargeAmount (float) --
        
        The amount of the recurring charge to run this reserved node.
        
        RecurringChargeFrequency (string) --
        
        The frequency of the recurring price charged to run this reserved node.
    - ARN (string) --
      
      The Amazon Resource Name (ARN) of the reserved node.

PurchaseReservedNodesOffering (new)

Link ¶

Allows you to purchase a reserved node offering. Reserved nodes are not eligible for cancellation and are non-refundable.

See also: AWS API Documentation

Request Syntax

client.purchase_reserved_nodes_offering(
    ReservedNodesOfferingId='string',
    ReservationId='string',
    NodeCount=123,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ReservedNodesOfferingId:

string

param ReservedNodesOfferingId:

[REQUIRED]

The ID of the reserved node offering to purchase.

type ReservationId:

string

param ReservationId:

A customer-specified identifier to track this reservation.

type NodeCount:

integer

param NodeCount:

The number of node instances to reserve.

type Tags:

list

param Tags:

A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.

(dict) --

A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
- Key (string) --
  
  The key for the tag. May not be null.
- Value (string) --
  
  The tag's value. May be null.

rtype:

dict

returns:

Response Syntax

{
    'ReservedNode': {
        'ReservationId': 'string',
        'ReservedNodesOfferingId': 'string',
        'NodeType': 'string',
        'StartTime': datetime(2015, 1, 1),
        'Duration': 123,
        'FixedPrice': 123.0,
        'NodeCount': 123,
        'OfferingType': 'string',
        'State': 'string',
        'RecurringCharges': [
            {
                'RecurringChargeAmount': 123.0,
                'RecurringChargeFrequency': 'string'
            },
        ],
        'ARN': 'string'
    }
}

Response Structure

(dict) --
- ReservedNode (dict) --
  
  Represents the output of a PurchaseReservedNodesOffering operation.
  - ReservationId (string) --
    
    A customer-specified identifier to track this reservation.
  - ReservedNodesOfferingId (string) --
    
    The ID of the reserved node offering to purchase.
  - NodeType (string) --
    
    The node type for the reserved nodes.
  - StartTime (datetime) --
    
    The time the reservation started.
  - Duration (integer) --
    
    The duration of the reservation in seconds.
  - FixedPrice (float) --
    
    The fixed price charged for this reserved node.
  - NodeCount (integer) --
    
    The number of nodes that have been reserved.
  - OfferingType (string) --
    
    The offering type of this reserved node.
  - State (string) --
    
    The state of the reserved node.
  - RecurringCharges (list) --
    
    The recurring price charged to run this reserved node.
    - (dict) --
      
      The recurring charge to run this reserved node.
      - RecurringChargeAmount (float) --
        
        The amount of the recurring charge to run this reserved node.
      - RecurringChargeFrequency (string) --
        
        The frequency of the recurring price charged to run this reserved node.
  - ARN (string) --
    
    The Amazon Resource Name (ARN) of the reserved node.