Amazon DocumentDB
Developer Guide

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

DescribeOrderableDBInstanceOptions

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

Request Parameters

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

Engine

The name of the engine to retrieve instance options for.

Type: String

Required: Yes

DBInstanceClass

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

Type: String

Required: No

EngineVersion

The engine version filter value. Specify this parameter to show only the available offerings that match 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 that match the specified license model.

Type: String

Required: No

Marker

An optional pagination token provided by a previous 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 (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 virtual private cloud (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 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

The options that are available for a particular orderable instance.

Type: Array of OrderableDBInstanceOption objects

Errors

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

See Also

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