Request Parameters Response Elements Errors Examples See Also

DescribeOrderableDBInstanceOptions

Describes the orderable DB instance options for a specified DB engine.

Request Parameters

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

Engine

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

Required: Yes

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 AWS Region.

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

Type: String

Required: No

DBInstanceClass

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

Type: String

Required: No

EngineVersion

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

Type: String

Required: No

Filters.Filter.N

This parameter isn't currently supported.

Type: Array of Filter objects

Required: No

LicenseModel

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

RDS Custom supports only the BYOL licensing 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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 1000.

Type: Integer

Required: No

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

Examples

Example

This example illustrates one usage of DescribeOrderableDBInstanceOptions.

Sample Request



https://rds.us-west-2.amazonaws.com/
   ?Action=DescribeOrderableDBInstanceOptions
   &Engine=mysql
   &EngineVersion=8.0.26
   &DBInstanceClass=db.r6gd.large
   &SignatureMethod=HmacSHA256
   &SignatureVersion=4
   &Version=2014-10-31
   &X-Amz-Algorithm=AWS4-HMAC-SHA256
   &X-Amz-Credential=AKIADQKE4SARGYLE/20140421/us-west-2/rds/aws4_request
   &X-Amz-Date=20211020T205537Z
   &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date
   &X-Amz-Signature=b49545dd3c933bdded80655d433d84bf743261ea1bebb33a7922c5c2c5240cd8

Sample Response



<DescribeOrderableDBInstanceOptionsResponse xmlns="http://rds.amazonaws.com/doc/2014-10-31/">
  <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>