DescribeOrderableDBInstanceOptionsCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DocDBClient, DescribeOrderableDBInstanceOptionsCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, DescribeOrderableDBInstanceOptionsCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // DescribeOrderableDBInstanceOptionsMessage
  Engine: "STRING_VALUE", // required
  EngineVersion: "STRING_VALUE",
  DBInstanceClass: "STRING_VALUE",
  LicenseModel: "STRING_VALUE",
  Vpc: true || false,
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE", // required
      Values: [ // FilterValueList // required
        "STRING_VALUE",
      ],
    },
  ],
  MaxRecords: Number("int"),
  Marker: "STRING_VALUE",
};
const command = new DescribeOrderableDBInstanceOptionsCommand(input);
const response = await client.send(command);
// { // OrderableDBInstanceOptionsMessage
//   OrderableDBInstanceOptions: [ // OrderableDBInstanceOptionsList
//     { // OrderableDBInstanceOption
//       Engine: "STRING_VALUE",
//       EngineVersion: "STRING_VALUE",
//       DBInstanceClass: "STRING_VALUE",
//       LicenseModel: "STRING_VALUE",
//       AvailabilityZones: [ // AvailabilityZoneList
//         { // AvailabilityZone
//           Name: "STRING_VALUE",
//         },
//       ],
//       Vpc: true || false,
//       StorageType: "STRING_VALUE",
//     },
//   ],
//   Marker: "STRING_VALUE",
// };

DescribeOrderableDBInstanceOptionsCommand Input

See DescribeOrderableDBInstanceOptionsCommandInput for more details

Parameter
Type
Description
Engine
Required
string | undefined

The name of the engine to retrieve instance options for.

DBInstanceClass
string | undefined

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

EngineVersion
string | undefined

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

Filters
Filter[] | undefined

This parameter is not currently supported.

LicenseModel
string | undefined

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

Marker
string | undefined

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.

MaxRecords
number | undefined

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.

Vpc
boolean | undefined

The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.

DescribeOrderableDBInstanceOptionsCommand Output

See DescribeOrderableDBInstanceOptionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Marker
string | undefined

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.

OrderableDBInstanceOptions
OrderableDBInstanceOption[] | undefined

The options that are available for a particular orderable instance.

Throws

Name
Fault
Details
DocDBServiceException
Base exception class for all service exceptions from DocDB service.