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

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



.. py:class:: RDS.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:`RDS.Client.describe_orderable_db_instance_options`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Engine='string',
          EngineVersion='string',
          DBInstanceClass='string',
          LicenseModel='string',
          AvailabilityZoneGroup='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 database engine to describe DB instance options for.

       

      Valid Values:

       

      
      * ``aurora-mysql``
       
      * ``aurora-postgresql``
       
      * ``custom-oracle-ee``
       
      * ``custom-oracle-ee-cdb``
       
      * ``custom-oracle-se2``
       
      * ``custom-oracle-se2-cdb``
       
      * ``db2-ae``
       
      * ``db2-se``
       
      * ``mariadb``
       
      * ``mysql``
       
      * ``oracle-ee``
       
      * ``oracle-ee-cdb``
       
      * ``oracle-se2``
       
      * ``oracle-se2-cdb``
       
      * ``postgres``
       
      * ``sqlserver-ee``
       
      * ``sqlserver-se``
       
      * ``sqlserver-ex``
       
      * ``sqlserver-web``
      

      

    
    :type EngineVersion: string
    :param EngineVersion: 

      A filter to include only the available options for the specified engine version.

      

    
    :type DBInstanceClass: string
    :param DBInstanceClass: 

      A filter to include only the available options for the specified DB instance class.

      

    
    :type LicenseModel: string
    :param LicenseModel: 

      A filter to include only the available options for the specified license model.

       

      RDS Custom supports only the BYOL licensing model.

      

    
    :type AvailabilityZoneGroup: string
    :param AvailabilityZoneGroup: 

      The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.

       

      Omit this parameter to show the available options in the specified Amazon Web Services Region.

       

      This setting doesn't apply to RDS Custom DB instances.

      

    
    :type Vpc: boolean
    :param Vpc: 

      Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.

       

      RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.

      

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

      
      ::

        {
            'OrderableDBInstanceOptions': [
                {
                    'Engine': 'string',
                    'EngineVersion': 'string',
                    'DBInstanceClass': 'string',
                    'LicenseModel': 'string',
                    'AvailabilityZoneGroup': 'string',
                    'AvailabilityZones': [
                        {
                            'Name': 'string'
                        },
                    ],
                    'MultiAZCapable': True|False,
                    'ReadReplicaCapable': True|False,
                    'Vpc': True|False,
                    'SupportsStorageEncryption': True|False,
                    'StorageType': 'string',
                    'SupportsIops': True|False,
                    'SupportsStorageThroughput': True|False,
                    'SupportsEnhancedMonitoring': True|False,
                    'SupportsIAMDatabaseAuthentication': True|False,
                    'SupportsPerformanceInsights': True|False,
                    'MinStorageSize': 123,
                    'MaxStorageSize': 123,
                    'MinIopsPerDbInstance': 123,
                    'MaxIopsPerDbInstance': 123,
                    'MinIopsPerGib': 123.0,
                    'MaxIopsPerGib': 123.0,
                    'MinStorageThroughputPerDbInstance': 123,
                    'MaxStorageThroughputPerDbInstance': 123,
                    'MinStorageThroughputPerIops': 123.0,
                    'MaxStorageThroughputPerIops': 123.0,
                    'AvailableProcessorFeatures': [
                        {
                            'Name': 'string',
                            'DefaultValue': 'string',
                            'AllowedValues': 'string'
                        },
                    ],
                    'SupportedEngineModes': [
                        'string',
                    ],
                    'SupportsStorageAutoscaling': True|False,
                    'SupportsKerberosAuthentication': True|False,
                    'OutpostCapable': True|False,
                    'SupportedActivityStreamModes': [
                        'string',
                    ],
                    'SupportsGlobalDatabases': True|False,
                    'SupportedNetworkTypes': [
                        'string',
                    ],
                    'SupportsClusters': True|False,
                    'SupportsDedicatedLogVolume': True|False,
                    'SupportsAdditionalStorageVolumes': True|False,
                    'SupportsHttpEndpoint': True|False,
                    'AvailableAdditionalStorageVolumesOptions': [
                        {
                            'SupportsStorageAutoscaling': True|False,
                            'SupportsStorageThroughput': True|False,
                            'SupportsIops': True|False,
                            'StorageType': 'string',
                            'MinStorageSize': 123,
                            'MaxStorageSize': 123,
                            'MinIops': 123,
                            'MaxIops': 123,
                            'MinIopsPerGib': 123.0,
                            'MaxIopsPerGib': 123.0,
                            'MinStorageThroughput': 123,
                            'MaxStorageThroughput': 123
                        },
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 

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

        
        

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

          An ``OrderableDBInstanceOption`` structure containing information about orderable options for the DB instance.

          
          

          - *(dict) --* 

            Contains a list of available options for a DB instance.

             

            This data type is used as a response element in the ``DescribeOrderableDBInstanceOptions`` action.

            
            

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

              The engine type of a DB instance.

              
            

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

              The engine version of a DB instance.

              
            

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

              The DB instance class for a DB instance.

              
            

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

              The license model for a DB instance.

              
            

            - **AvailabilityZoneGroup** *(string) --* 

              The Availability Zone group for a DB instance.

              
            

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

              A list of Availability Zones for a DB instance.

              
              

              - *(dict) --* 

                Contains Availability Zone information.

                 

                This data type is used as an element in the ``OrderableDBInstanceOption`` data type.

                
                

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

                  The name of the Availability Zone.

                  
            
          
            

            - **MultiAZCapable** *(boolean) --* 

              Indicates whether a DB instance is Multi-AZ capable.

              
            

            - **ReadReplicaCapable** *(boolean) --* 

              Indicates whether a DB instance can have a read replica.

              
            

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

              Indicates whether a DB instance is in a VPC.

              
            

            - **SupportsStorageEncryption** *(boolean) --* 

              Indicates whether a DB instance supports encrypted storage.

              
            

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

              The storage type for a DB instance.

              
            

            - **SupportsIops** *(boolean) --* 

              Indicates whether a DB instance supports provisioned IOPS.

              
            

            - **SupportsStorageThroughput** *(boolean) --* 

              Indicates whether a DB instance supports storage throughput.

              
            

            - **SupportsEnhancedMonitoring** *(boolean) --* 

              Indicates whether a DB instance supports Enhanced Monitoring at intervals from 1 to 60 seconds.

              
            

            - **SupportsIAMDatabaseAuthentication** *(boolean) --* 

              Indicates whether a DB instance supports IAM database authentication.

              
            

            - **SupportsPerformanceInsights** *(boolean) --* 

              Indicates whether a DB instance supports Performance Insights.

              
            

            - **MinStorageSize** *(integer) --* 

              Minimum storage size for a DB instance.

              
            

            - **MaxStorageSize** *(integer) --* 

              Maximum storage size for a DB instance.

              
            

            - **MinIopsPerDbInstance** *(integer) --* 

              Minimum total provisioned IOPS for a DB instance.

              
            

            - **MaxIopsPerDbInstance** *(integer) --* 

              Maximum total provisioned IOPS for a DB instance.

              
            

            - **MinIopsPerGib** *(float) --* 

              Minimum provisioned IOPS per GiB for a DB instance.

              
            

            - **MaxIopsPerGib** *(float) --* 

              Maximum provisioned IOPS per GiB for a DB instance.

              
            

            - **MinStorageThroughputPerDbInstance** *(integer) --* 

              Minimum storage throughput for a DB instance.

              
            

            - **MaxStorageThroughputPerDbInstance** *(integer) --* 

              Maximum storage throughput for a DB instance.

              
            

            - **MinStorageThroughputPerIops** *(float) --* 

              Minimum storage throughput to provisioned IOPS ratio for a DB instance.

              
            

            - **MaxStorageThroughputPerIops** *(float) --* 

              Maximum storage throughput to provisioned IOPS ratio for a DB instance.

              
            

            - **AvailableProcessorFeatures** *(list) --* 

              A list of the available processor features for the DB instance class of a DB instance.

              
              

              - *(dict) --* 

                Contains the available processor feature information for the DB instance class of a DB instance.

                 

                For more information, see `Configuring the Processor of the DB Instance Class <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html#USER_ConfigureProcessor>`__ in the *Amazon RDS User Guide.*

                
                

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

                  The name of the processor feature. Valid names are ``coreCount`` and ``threadsPerCore``.

                  
                

                - **DefaultValue** *(string) --* 

                  The default value for the processor feature of the DB instance class.

                  
                

                - **AllowedValues** *(string) --* 

                  The allowed values for the processor feature of the DB instance class.

                  
            
          
            

            - **SupportedEngineModes** *(list) --* 

              A list of the supported DB engine modes.

              
              

              - *(string) --* 
          
            

            - **SupportsStorageAutoscaling** *(boolean) --* 

              Indicates whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.

              
            

            - **SupportsKerberosAuthentication** *(boolean) --* 

              Indicates whether a DB instance supports Kerberos Authentication.

              
            

            - **OutpostCapable** *(boolean) --* 

              Indicates whether a DB instance supports RDS on Outposts.

               

              For more information about RDS on Outposts, see `Amazon RDS on Amazon Web Services Outposts <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/rds-on-outposts.html>`__ in the *Amazon RDS User Guide.*

              
            

            - **SupportedActivityStreamModes** *(list) --* 

              The list of supported modes for Database Activity Streams. Aurora PostgreSQL returns the value ``[sync, async]``. Aurora MySQL and RDS for Oracle return ``[async]`` only. If Database Activity Streams isn't supported, the return value is an empty list.

              
              

              - *(string) --* 
          
            

            - **SupportsGlobalDatabases** *(boolean) --* 

              Indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.

              
            

            - **SupportedNetworkTypes** *(list) --* 

              The network types supported by the DB instance ( ``IPV4`` or ``DUAL``).

               

              A DB instance can support only the IPv4 protocol or the IPv4 and the IPv6 protocols ( ``DUAL``).

               

              For more information, see `Working with a DB instance in a VPC <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.WorkingWithRDSInstanceinaVPC.html>`__ in the *Amazon RDS User Guide.*

              
              

              - *(string) --* 
          
            

            - **SupportsClusters** *(boolean) --* 

              Indicates whether DB instances can be configured as a Multi-AZ DB cluster.

               

              For more information on Multi-AZ DB clusters, see `Multi-AZ deployments with two readable standby DB instances <https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html>`__ in the *Amazon RDS User Guide.*

              
            

            - **SupportsDedicatedLogVolume** *(boolean) --* 

              Indicates whether a DB instance supports using a dedicated log volume (DLV).

              
            

            - **SupportsAdditionalStorageVolumes** *(boolean) --* 

              Indicates whether the DB instance class supports additional storage volumes.

              
            

            - **SupportsHttpEndpoint** *(boolean) --* 

              Indicates whether a DB instance supports HTTP endpoints.

              
            

            - **AvailableAdditionalStorageVolumesOptions** *(list) --* 

              The available options for additional storage volumes for the DB instance class.

              
              

              - *(dict) --* 

                Contains the available options for additional storage volumes for a DB instance class.

                
                

                - **SupportsStorageAutoscaling** *(boolean) --* 

                  Indicates whether the additional storage volume supports storage autoscaling.

                  
                

                - **SupportsStorageThroughput** *(boolean) --* 

                  Indicates whether the additional storage volume supports configurable storage throughput.

                  
                

                - **SupportsIops** *(boolean) --* 

                  Indicates whether the additional storage volume supports provisioned IOPS.

                  
                

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

                  The storage type for the additional storage volume.

                   

                  Valid Values: ``GP3 | IO2``

                  
                

                - **MinStorageSize** *(integer) --* 

                  The minimum amount of storage that you can allocate for the additional storage volume, in gibibytes (GiB).

                  
                

                - **MaxStorageSize** *(integer) --* 

                  The maximum amount of storage that you can allocate for the additional storage volume, in gibibytes (GiB).

                  
                

                - **MinIops** *(integer) --* 

                  The minimum number of I/O operations per second (IOPS) that the additional storage volume supports.

                  
                

                - **MaxIops** *(integer) --* 

                  The maximum number of I/O operations per second (IOPS) that the additional storage volume supports.

                  
                

                - **MinIopsPerGib** *(float) --* 

                  The minimum ratio of I/O operations per second (IOPS) to gibibytes (GiB) of storage for the additional storage volume.

                  
                

                - **MaxIopsPerGib** *(float) --* 

                  The maximum ratio of I/O operations per second (IOPS) to gibibytes (GiB) of storage for the additional storage volume.

                  
                

                - **MinStorageThroughput** *(integer) --* 

                  The minimum storage throughput that the additional storage volume supports, in mebibytes per second (MiBps).

                  
                

                - **MaxStorageThroughput** *(integer) --* 

                  The maximum storage throughput that the additional storage volume supports, in mebibytes per second (MiBps).

                  
            
          
        
      
        

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

          A token to resume pagination.

          
    