RDS / Client / describe_orderable_db_instance_options

describe_orderable_db_instance_options#

RDS.Client.describe_orderable_db_instance_options(**kwargs)#

Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.

Request Syntax

response = client.describe_orderable_db_instance_options(
    Engine='string',
    EngineVersion='string',
    DBInstanceClass='string',
    LicenseModel='string',
    AvailabilityZoneGroup='string',
    Vpc=True|False,
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxRecords=123,
    Marker='string'
)

Parameters:

Engine (string) –
[REQUIRED]

The name of the engine to retrieve DB instance options for.

Valid Values:
- aurora-mysql
- aurora-postgresql
- custom-oracle-ee
- mariadb
- mysql
- oracle-ee
- oracle-ee-cdb
- oracle-se2
- oracle-se2-cdb
- postgres
- sqlserver-ee
- sqlserver-se
- sqlserver-ex
- sqlserver-web
EngineVersion (string) – The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version.
DBInstanceClass (string) – The DB instance class filter value. Specify this parameter to show only the available offerings matching the specified DB instance class.
LicenseModel (string) –
The license model filter value. Specify this parameter to show only the available offerings matching the specified license model.

RDS Custom supports only the BYOL licensing model.
AvailabilityZoneGroup (string) –
The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available offerings for the Local Zones in the group.

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

This setting doesn’t apply to RDS Custom.
Vpc (boolean) –
A value that indicates 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.
Filters (list) –
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
  - 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) –
MaxRecords (integer) –
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 10000.
Marker (string) – An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions request. 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

{
    '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,
            'SupportsEnhancedMonitoring': True|False,
            'SupportsIAMDatabaseAuthentication': True|False,
            'SupportsPerformanceInsights': True|False,
            'MinStorageSize': 123,
            'MaxStorageSize': 123,
            'MinIopsPerDbInstance': 123,
            'MaxIopsPerDbInstance': 123,
            'MinIopsPerGib': 123.0,
            'MaxIopsPerGib': 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,
            'SupportsClusters': True|False,
            'SupportedNetworkTypes': [
                'string',
            ],
            'SupportsStorageThroughput': True|False,
            'MinStorageThroughputPerDbInstance': 123,
            'MaxStorageThroughputPerDbInstance': 123,
            'MinStorageThroughputPerIops': 123.0,
            'MaxStorageThroughputPerIops': 123.0
        },
    ],
    'Marker': '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) –
      
      Indicates the storage type for a DB instance.
    - SupportsIops (boolean) –
      
      Indicates whether a DB instance supports provisioned IOPS.
    - 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) –
      
      True if a DB instance supports Performance Insights, otherwise false.
    - 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.
    - 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 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) –
      
      Whether Amazon RDS can automatically scale storage for DB instances that use the specified DB instance class.
    - SupportsKerberosAuthentication (boolean) –
      
      Whether a DB instance supports Kerberos Authentication.
    - OutpostCapable (boolean) –
      
      Whether a DB instance supports RDS on Outposts.
      
      For more information about RDS on Outposts, see Amazon RDS on Amazon Web Services Outposts 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) –
      
      A value that indicates whether you can use Aurora global databases with a specific combination of other DB engine attributes.
    - SupportsClusters (boolean) –
      
      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 in the Amazon RDS User Guide.
    - 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 in the Amazon RDS User Guide.
      - (string) –
    - SupportsStorageThroughput (boolean) –
      
      Indicates whether a DB instance supports storage throughput.
    - 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.
- Marker (string) –
  
  An optional pagination token provided by a previous OrderableDBInstanceOptions request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Examples

This example lists information for all orderable DB instance options for the specified DB engine, engine version, DB instance class, license model, and VPC settings.

response = client.describe_orderable_db_instance_options(
    DBInstanceClass='db.t2.micro',
    Engine='mysql',
    EngineVersion='5.6.27',
    LicenseModel='general-public-license',
    Vpc=True,
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}