MemoryDB / Client / describe_reserved_nodes

describe_reserved_nodes#

MemoryDB.Client.describe_reserved_nodes(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

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

  • ReservationId (string) – The reserved node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

  • ReservedNodesOfferingId (string) – The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

  • NodeType (string) – 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.

  • Duration (string) – The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this 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',
    '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.

Exceptions

  • MemoryDB.Client.exceptions.ReservedNodeNotFoundFault

  • MemoryDB.Client.exceptions.ServiceLinkedRoleNotFoundFault

  • MemoryDB.Client.exceptions.InvalidParameterValueException

  • MemoryDB.Client.exceptions.InvalidParameterCombinationException