:doc:`MemoryDB <../../memorydb>` / Paginator / DescribeReservedNodes

*********************
DescribeReservedNodes
*********************



.. py:class:: MemoryDB.Paginator.DescribeReservedNodes

  ::

    
    paginator = client.get_paginator('describe_reserved_nodes')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`MemoryDB.Client.describe_reserved_nodes`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/memorydb-2021-01-01/DescribeReservedNodes>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ReservationId='string',
          ReservedNodesOfferingId='string',
          NodeType='string',
          Duration='string',
          OfferingType='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': '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 <https://docs.aws.amazon.com/memorydb/latest/devguide/nodes.reserved.html#reserved-nodes-supported>`__.

      

    
    :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 PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            '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) --* 
        

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

              
        
      
    