DescribeOrderableDBInstanceOptions - Amazon Relational Database Service

Description

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

Request Parameters

For information about the common parameters that all actions use, see Common Query Parameters.

Name	Description	Required
`DBInstanceClass`	The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class. Type: String	No
`Engine`	The name of the engine to retrieve DB Instance options for. Type: String	Yes
`EngineVersion`	The engine version filter value. Specify this parameter to show only the available offerings matching the specified engine version. Type: String	No
`LicenseModel`	The license model filter value. Specify this parameter to show only the available offerings matching the specified license model. Type: String	No
`Marker`	An optional marker provided in the 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	No
`MaxRecords`	The maximum number of records to include in the response. If more records exist than the specified `MaxRecords` value, a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100 Type: Integer	No

Response Elements

The following elements come wrapped in a DescribeOrderableDBInstanceOptionsResult structure.

Name Description

Name	Description
`Marker`	A marker that can be used to retrieve paginated results. Type: String
`OrderableDBInstanceOptions`	An OrderableDBInstanceOption structure containing information about orderable options for the DB Instance. Type: OrderableDBInstanceOption list

Marker

A marker that can be used to retrieve paginated results.

Type: String

OrderableDBInstanceOptions

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

Type: OrderableDBInstanceOption list

Examples

Sample Request

https://rds.amazonaws.com/
   ?Action=DescribeOrderableDBInstanceOptions
   &Engine=mysql
   &MaxRecords=100
   &Version=2012-04-23
   &Timestamp=2011-05-23T07%3A49%3A17.749Z
   &SignatureVersion=2
   &SignatureMethod=HmacSHA256
   &AWSAccessKeyId=<AWS Access Key ID>
   &Signature=<Signature>

Sample Response

<DescribeOrderableDBInstanceOptionsResponse xmlns="http://rds.amazonaws.com/doc/2012-04-23/">
  <DescribeOrderableDBInstanceOptionsResult>
  <!-- NOTE: Example truncated for space -->
    <OrderableDBInstanceOptions>
      <OrderableDBInstanceOption>
        <MultiAZCapable>true</MultiAZCapable>
        <Engine>mysql</Engine>
        <LicenseModel>general-public-license</LicenseModel>
        <ReadReplicaCapable>true</ReadReplicaCapable>
        <EngineVersion>5.1.45</EngineVersion>
        <DBInstanceClass>db.m1.large</DBInstanceClass>
        <AvailabilityZones>
          <AvailabilityZone>
            <Name>us-east-1a</Name>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-east-1b</Name>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-east-1d</Name>
          </AvailabilityZone>
        </AvailabilityZones>
      </OrderableDBInstanceOption>
      <OrderableDBInstanceOption>
        <MultiAZCapable>true</MultiAZCapable>
        <Engine>mysql</Engine>
        <LicenseModel>general-public-license</LicenseModel>
        <ReadReplicaCapable>true</ReadReplicaCapable>
        <EngineVersion>5.1.45</EngineVersion>
        <DBInstanceClass>db.m1.small</DBInstanceClass>
        <AvailabilityZones>
          <AvailabilityZone>
            <Name>us-east-1a</Name>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-east-1b</Name>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-east-1d</Name>
          </AvailabilityZone>
        </AvailabilityZones>
      </OrderableDBInstanceOption>
      <OrderableDBInstanceOption>
        <MultiAZCapable>true</MultiAZCapable>
        <Engine>mysql</Engine>
        <LicenseModel>general-public-license</LicenseModel>
        <ReadReplicaCapable>true</ReadReplicaCapable>
        <EngineVersion>5.1.45</EngineVersion>
        <DBInstanceClass>db.m1.xlarge</DBInstanceClass>
        <AvailabilityZones>
          <AvailabilityZone>
            <Name>us-east-1a</Name>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-east-1b</Name>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-east-1d</Name>
          </AvailabilityZone>
        </AvailabilityZones>
      </OrderableDBInstanceOption>
      <OrderableDBInstanceOption>
        <MultiAZCapable>true</MultiAZCapable>
        <Engine>mysql</Engine>
        <LicenseModel>general-public-license</LicenseModel>
        <ReadReplicaCapable>true</ReadReplicaCapable>
        <EngineVersion>5.1.45</EngineVersion>
        <DBInstanceClass>db.m2.2xlarge</DBInstanceClass>
        <AvailabilityZones>
          <AvailabilityZone>
            <Name>us-east-1a</Name>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-east-1b</Name>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-east-1d</Name>
          </AvailabilityZone>
        </AvailabilityZones>
      </OrderableDBInstanceOption>
      <OrderableDBInstanceOption>
        <MultiAZCapable>true</MultiAZCapable>
        <Engine>mysql</Engine>
        <LicenseModel>general-public-license</LicenseModel>
        <ReadReplicaCapable>true</ReadReplicaCapable>
        <EngineVersion>5.1.45</EngineVersion>
        <DBInstanceClass>db.m2.4xlarge</DBInstanceClass>
        <AvailabilityZones>
          <AvailabilityZone>
            <Name>us-east-1a</Name>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-east-1b</Name>
          </AvailabilityZone>
          <AvailabilityZone>
            <Name>us-east-1d</Name>
          </AvailabilityZone>
        </AvailabilityZones>
      </OrderableDBInstanceOption>
    </OrderableDBInstanceOptions>
  </DescribeOrderableDBInstanceOptionsResult>
  <ResponseMetadata>
    <RequestId>2a0406d7-8511-11e0-90aa-eb648410240d</RequestId>
  </ResponseMetadata>
</DescribeOrderableDBInstanceOptionsResponse>