Neptune / Client / describe_orderable_db_instance_options

describe_orderable_db_instance_options

Neptune.Client.describe_orderable_db_instance_options(**kwargs)

Returns a list of orderable DB instance options for the specified engine.

See also: AWS API Documentation

Request Syntax

response = client.describe_orderable_db_instance_options(
    Engine='string',
    EngineVersion='string',
    DBInstanceClass='string',
    LicenseModel='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.

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

• Vpc (boolean) – The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

• Filters (list) –

  This parameter is not currently supported.

  • (dict) –

    This type is not currently supported.

    • Name (string) – [REQUIRED]

      This parameter is not currently supported.

    • Values (list) – [REQUIRED]

      This parameter is not currently supported.

      • (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 the remaining results can be retrieved.

  Default: 100

  Constraints: Minimum 20, maximum 100.

• 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',
            '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,
            'SupportsGlobalDatabases': True|False
        },
    ],
    'Marker': 'string'
}

Response Structure

• (dict) –

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

      • AvailabilityZones (list) –

        A list of Availability Zones for a DB instance.

        • (dict) –

          Specifies an Availability Zone.

          • 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) –

        (Not supported by Neptune)

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

      • SupportsGlobalDatabases (boolean) –

        A value that indicates whether you can use Neptune global databases with a specific combination of other DB engine attributes.

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