:doc:`RDS <../../rds>` / Paginator / DescribeReservedDBInstances

***************************
DescribeReservedDBInstances
***************************



.. py:class:: RDS.Paginator.DescribeReservedDBInstances

  ::

    
    paginator = client.get_paginator('describe_reserved_db_instances')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`RDS.Client.describe_reserved_db_instances`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeReservedDBInstances>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ReservedDBInstanceId='string',
          ReservedDBInstancesOfferingId='string',
          DBInstanceClass='string',
          Duration='string',
          ProductDescription='string',
          OfferingType='string',
          MultiAZ=True|False,
          LeaseId='string',
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ReservedDBInstanceId: string
    :param ReservedDBInstanceId: 

      The reserved DB instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.

      

    
    :type ReservedDBInstancesOfferingId: string
    :param ReservedDBInstancesOfferingId: 

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

      

    
    :type DBInstanceClass: string
    :param DBInstanceClass: 

      The DB instance class filter value. Specify this parameter to show only those reservations matching the specified DB instances class.

      

    
    :type Duration: string
    :param Duration: 

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

       

      Valid Values: ``1 | 3 | 31536000 | 94608000``

      

    
    :type ProductDescription: string
    :param ProductDescription: 

      The product description filter value. Specify this parameter to show only those reservations matching the specified product description.

      

    
    :type OfferingType: string
    :param OfferingType: 

      The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type.

       

      Valid Values: ``"Partial Upfront" | "All Upfront" | "No Upfront"``

      

    
    :type MultiAZ: boolean
    :param MultiAZ: 

      Specifies whether to show only those reservations that support Multi-AZ.

      

    
    :type LeaseId: string
    :param LeaseId: 

      The lease identifier filter value. Specify this parameter to show only the reservation that matches the specified lease ID.

       

      .. note::

        

        Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

        

      

    
    :type Filters: list
    :param Filters: 

      This parameter isn't currently supported.

      

    
      - *(dict) --* 

        A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

         

        .. note::

          

          Currently, wildcards are not supported in filters.

          

         

        The following actions can be filtered:

         

        
        * ``DescribeDBClusterBacktracks``
         
        * ``DescribeDBClusterEndpoints``
         
        * ``DescribeDBClusters``
         
        * ``DescribeDBInstances``
         
        * ``DescribeDBRecommendations``
         
        * ``DescribeDBShardGroups``
         
        * ``DescribePendingMaintenanceActions``
        

        

      
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the filter. Filter names are case-sensitive.

          

        
        - **Values** *(list) --* **[REQUIRED]** 

          One or more filter values. Filter values are case-sensitive.

          

        
          - *(string) --* 

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

      
      ::

        {
            'ReservedDBInstances': [
                {
                    'ReservedDBInstanceId': 'string',
                    'ReservedDBInstancesOfferingId': 'string',
                    'DBInstanceClass': 'string',
                    'StartTime': datetime(2015, 1, 1),
                    'Duration': 123,
                    'FixedPrice': 123.0,
                    'UsagePrice': 123.0,
                    'CurrencyCode': 'string',
                    'DBInstanceCount': 123,
                    'ProductDescription': 'string',
                    'OfferingType': 'string',
                    'MultiAZ': True|False,
                    'State': 'string',
                    'RecurringCharges': [
                        {
                            'RecurringChargeAmount': 123.0,
                            'RecurringChargeFrequency': 'string'
                        },
                    ],
                    'ReservedDBInstanceArn': 'string',
                    'LeaseId': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Contains the result of a successful invocation of the ``DescribeReservedDBInstances`` action.

        
        

        - **ReservedDBInstances** *(list) --* 

          A list of reserved DB instances.

          
          

          - *(dict) --* 

            This data type is used as a response element in the ``DescribeReservedDBInstances`` and ``PurchaseReservedDBInstancesOffering`` actions.

            
            

            - **ReservedDBInstanceId** *(string) --* 

              The unique identifier for the reservation.

              
            

            - **ReservedDBInstancesOfferingId** *(string) --* 

              The offering identifier.

              
            

            - **DBInstanceClass** *(string) --* 

              The DB instance class for the reserved DB instance.

              
            

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

              
            

            - **UsagePrice** *(float) --* 

              The hourly price charged for this reserved DB instance.

              
            

            - **CurrencyCode** *(string) --* 

              The currency code for the reserved DB instance.

              
            

            - **DBInstanceCount** *(integer) --* 

              The number of reserved DB instances.

              
            

            - **ProductDescription** *(string) --* 

              The description of the reserved DB instance.

              
            

            - **OfferingType** *(string) --* 

              The offering type of this reserved DB instance.

              
            

            - **MultiAZ** *(boolean) --* 

              Indicates whether the reservation applies to Multi-AZ deployments.

              
            

            - **State** *(string) --* 

              The state of the reserved DB instance.

              
            

            - **RecurringCharges** *(list) --* 

              The recurring price charged to run this reserved DB instance.

              
              

              - *(dict) --* 

                This data type is used as a response element in the ``DescribeReservedDBInstances`` and ``DescribeReservedDBInstancesOfferings`` actions.

                
                

                - **RecurringChargeAmount** *(float) --* 

                  The amount of the recurring charge.

                  
                

                - **RecurringChargeFrequency** *(string) --* 

                  The frequency of the recurring charge.

                  
            
          
            

            - **ReservedDBInstanceArn** *(string) --* 

              The Amazon Resource Name (ARN) for the reserved DB instance.

              
            

            - **LeaseId** *(string) --* 

              The unique identifier for the lease associated with the reserved DB instance.

               

              .. note::

                

                Amazon Web Services Support might request the lease ID for an issue related to a reserved DB instance.

                

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    