MemoryDB / Client / describe_reserved_nodes_offerings

describe_reserved_nodes_offerings#

MemoryDB.Client.describe_reserved_nodes_offerings(**kwargs)#

Lists available reserved node offerings.

See also: AWS API Documentation

Request Syntax

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

  • ReservedNodesOfferingId (string) – The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

  • NodeType (string) – The node type for the reserved nodes. For more information, see Supported node types.

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

  • OfferingType (string) – 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”

  • MaxResults (integer) – 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.

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

Return type:

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.

Exceptions

  • MemoryDB.Client.exceptions.ReservedNodesOfferingNotFoundFault

  • MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault

  • MemoryDB.Client.exceptions.InvalidParameterValueException

  • MemoryDB.Client.exceptions.InvalidParameterCombinationException