Menu
Amazon Relational Database Service
API Reference (API Version 2014-10-31)

DescribeOrderableDBInstanceOptions

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

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

DBInstanceClass

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

Type: String

Required: No

Engine

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

Type: String

Required: Yes

EngineVersion

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

Type: String

Required: No

Filters.Filter.N

This parameter is not currently supported.

Type: array of Filter objects

Required: No

LicenseModel

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

Type: String

Required: No

Marker

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 .

Type: String

Required: No

MaxRecords

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.

Type: Integer

Required: No

Vpc

The VPC filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

Type: Boolean

Required: No

Response Elements

The following elements are returned by the service.

Marker

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 .

Type: String

OrderableDBInstanceOptions.OrderableDBInstanceOption.N

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

Type: array of OrderableDBInstanceOption objects

Errors

For information about the errors that are common to all actions, see Common Errors.

Example

Sample Request

Copy
https://rds.us-west-2.amazonaws.com/ ?Action=DescribeOrderableDBInstanceOptions &Engine=mysql &MaxRecords=100 &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-09-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request &X-Amz-Date=20140421T194733Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=b49545dd3c933bdded80655d433d84bf743261ea1bebb33a7922c5c2c5240cd8

Sample Response

Copy
<DescribeOrderableDBInstanceOptionsResponse xmlns="http://rds.amazonaws.com/doc/2014-09-01/"> <DescribeOrderableDBInstanceOptionsResult> <Marker>ZGIubTEuc21hbGwKZ2VuZXJhbC1wdWJsaWMtbGljZW5zZQo1LjEuNjkKTg==</Marker> <OrderableDBInstanceOptions> <OrderableDBInstanceOption> <MultiAZCapable>true</MultiAZCapable> <Engine>mysql</Engine> <LicenseModel>general-public-license</LicenseModel> <ReadReplicaCapable>true</ReadReplicaCapable> <Vpc>false</Vpc> <EngineVersion>5.1.57</EngineVersion> <AvailabilityZones> <AvailabilityZone> <Name>us-west-2a</Name> <ProvisionedIopsCapable>true</ProvisionedIopsCapable> </AvailabilityZone> <AvailabilityZone> <Name>us-west-2b</Name> <ProvisionedIopsCapable>true</ProvisionedIopsCapable> </AvailabilityZone> <AvailabilityZone> <Name>us-west-2c</Name> <ProvisionedIopsCapable>true</ProvisionedIopsCapable> </AvailabilityZone> </AvailabilityZones> <DBInstanceClass>db.m1.large</DBInstanceClass> </OrderableDBInstanceOption> <OrderableDBInstanceOption> <MultiAZCapable>true</MultiAZCapable> <Engine>mysql</Engine> <LicenseModel>general-public-license</LicenseModel> <ReadReplicaCapable>true</ReadReplicaCapable> <Vpc>true</Vpc> <EngineVersion>5.1.57</EngineVersion> <AvailabilityZones> <AvailabilityZone> <Name>us-west-2a</Name> <ProvisionedIopsCapable>true</ProvisionedIopsCapable> </AvailabilityZone> <AvailabilityZone> <Name>us-west-2b</Name> <ProvisionedIopsCapable>true</ProvisionedIopsCapable> </AvailabilityZone> <AvailabilityZone> <Name>us-west-2c</Name> <ProvisionedIopsCapable>true</ProvisionedIopsCapable> </AvailabilityZone> </AvailabilityZones> <DBInstanceClass>db.m1.large</DBInstanceClass> </OrderableDBInstanceOption> </OrderableDBInstanceOptions> </DescribeOrderableDBInstanceOptionsResult> <ResponseMetadata> <RequestId>b7ceb73e-b98c-11d3-a907-5a2c468b9cb0</RequestId> </ResponseMetadata> </DescribeOrderableDBInstanceOptionsResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: