:doc:`DocDB <../../docdb>` / Paginator / DescribeOrderableDBInstanceOptions

**********************************
DescribeOrderableDBInstanceOptions
**********************************



.. py:class:: DocDB.Paginator.DescribeOrderableDBInstanceOptions

  ::

    
    paginator = client.get_paginator('describe_orderable_db_instance_options')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`DocDB.Client.describe_orderable_db_instance_options`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Engine='string',
          EngineVersion='string',
          DBInstanceClass='string',
          LicenseModel='string',
          Vpc=True|False,
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Engine: string
    :param Engine: **[REQUIRED]** 

      The name of the engine to retrieve instance options for.

      

    
    :type EngineVersion: string
    :param EngineVersion: 

      The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.

      

    
    :type DBInstanceClass: string
    :param DBInstanceClass: 

      The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.

      

    
    :type LicenseModel: string
    :param LicenseModel: 

      The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.

      

    
    :type Vpc: boolean
    :param Vpc: 

      The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

      

    
    :type Filters: list
    :param Filters: 

      This parameter is not currently supported.

      

    
      - *(dict) --* 

        A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.

         

        Wildcards are not supported in filters.

        

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

      
      ::

        {
            'OrderableDBInstanceOptions': [
                {
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'DBInstanceClass': 'string',
                    'LicenseModel': 'string',
                    'AvailabilityZones': [
                        {
                            'Name': 'string'
                        },
                    ],
                    'Vpc': True|False,
                    'StorageType': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

        Represents the output of  DescribeOrderableDBInstanceOptions.

        
        

        - **OrderableDBInstanceOptions** *(list) --* 

          The options that are available for a particular orderable instance.

          
          

          - *(dict) --* 

            The options that are available for an instance.

            
            

            - **Engine** *(string) --* 

              The engine type of an instance.

              
            

            - **EngineVersion** *(string) --* 

              The engine version of an instance.

              
            

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

              The instance class for an instance.

              
            

            - **LicenseModel** *(string) --* 

              The license model for an instance.

              
            

            - **AvailabilityZones** *(list) --* 

              A list of Availability Zones for an instance.

              
              

              - *(dict) --* 

                Information about an Availability Zone.

                
                

                - **Name** *(string) --* 

                  The name of the Availability Zone.

                  
            
          
            

            - **Vpc** *(boolean) --* 

              Indicates whether an instance is in a virtual private cloud (VPC).

              
            

            - **StorageType** *(string) --* 

              The storage type to associate with the DB cluster

              
        
      
        

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

          A token to resume pagination.

          
    