import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeOptionGroupOptionsMessage, OptionGroupOptionsMessage } from "../models/models_0"; import type { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeOptionGroupOptionsCommand}. */ export interface DescribeOptionGroupOptionsCommandInput extends DescribeOptionGroupOptionsMessage { } /** * @public * * The output of {@link DescribeOptionGroupOptionsCommand}. */ export interface DescribeOptionGroupOptionsCommandOutput extends OptionGroupOptionsMessage, __MetadataBearer { } declare const DescribeOptionGroupOptionsCommand_base: { new (input: DescribeOptionGroupOptionsCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeOptionGroupOptionsCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Describes all available options for the specified engine.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { RDSClient, DescribeOptionGroupOptionsCommand } from "@aws-sdk/client-rds"; // ES Modules import * // const { RDSClient, DescribeOptionGroupOptionsCommand } = require("@aws-sdk/client-rds"); // CommonJS import * // import type { RDSClientConfig } from "@aws-sdk/client-rds"; * const config = {}; // type is RDSClientConfig * const client = new RDSClient(config); * const input = { // DescribeOptionGroupOptionsMessage * EngineName: "STRING_VALUE", // required * MajorEngineVersion: "STRING_VALUE", * Filters: [ // FilterList * { // Filter * Name: "STRING_VALUE", // required * Values: [ // FilterValueList // required * "STRING_VALUE", * ], * }, * ], * MaxRecords: Number("int"), * Marker: "STRING_VALUE", * }; * const command = new DescribeOptionGroupOptionsCommand(input); * const response = await client.send(command); * // { // OptionGroupOptionsMessage * // OptionGroupOptions: [ // OptionGroupOptionsList * // { // OptionGroupOption * // Name: "STRING_VALUE", * // Description: "STRING_VALUE", * // EngineName: "STRING_VALUE", * // MajorEngineVersion: "STRING_VALUE", * // MinimumRequiredMinorEngineVersion: "STRING_VALUE", * // PortRequired: true || false, * // DefaultPort: Number("int"), * // OptionsDependedOn: [ // OptionsDependedOn * // "STRING_VALUE", * // ], * // OptionsConflictsWith: [ // OptionsConflictsWith * // "STRING_VALUE", * // ], * // Persistent: true || false, * // Permanent: true || false, * // RequiresAutoMinorEngineVersionUpgrade: true || false, * // VpcOnly: true || false, * // SupportsOptionVersionDowngrade: true || false, * // OptionGroupOptionSettings: [ // OptionGroupOptionSettingsList * // { // OptionGroupOptionSetting * // SettingName: "STRING_VALUE", * // SettingDescription: "STRING_VALUE", * // DefaultValue: "STRING_VALUE", * // ApplyType: "STRING_VALUE", * // AllowedValues: "STRING_VALUE", * // IsModifiable: true || false, * // IsRequired: true || false, * // MinimumEngineVersionPerAllowedValue: [ // MinimumEngineVersionPerAllowedValueList * // { // MinimumEngineVersionPerAllowedValue * // AllowedValue: "STRING_VALUE", * // MinimumEngineVersion: "STRING_VALUE", * // }, * // ], * // }, * // ], * // OptionGroupOptionVersions: [ // OptionGroupOptionVersionsList * // { // OptionVersion * // Version: "STRING_VALUE", * // IsDefault: true || false, * // }, * // ], * // CopyableCrossAccount: true || false, * // }, * // ], * // Marker: "STRING_VALUE", * // }; * * ``` * * @param DescribeOptionGroupOptionsCommandInput - {@link DescribeOptionGroupOptionsCommandInput} * @returns {@link DescribeOptionGroupOptionsCommandOutput} * @see {@link DescribeOptionGroupOptionsCommandInput} for command's `input` shape. * @see {@link DescribeOptionGroupOptionsCommandOutput} for command's `response` shape. * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape. * * @throws {@link RDSServiceException} *

Base exception class for all service exceptions from RDS service.

* * * @example To describe all available options * ```javascript * // The following example lists the options for an RDS for MySQL version 8.0 DB instance. * const input = { * EngineName: "mysql", * MajorEngineVersion: "8.0" * }; * const command = new DescribeOptionGroupOptionsCommand(input); * const response = await client.send(command); * /* response is * { * OptionGroupOptions: [ * { * Description: "MariaDB Audit Plugin", * EngineName: "mysql", * MajorEngineVersion: "8.0", * MinimumRequiredMinorEngineVersion: "25", * Name: "MARIADB_AUDIT_PLUGIN", * OptionGroupOptionSettings: [ * { * ApplyType: "DYNAMIC", * IsModifiable: true, * IsRequired: false, * MinimumEngineVersionPerAllowedValue: [], * SettingDescription: "Include specified users", * SettingName: "SERVER_AUDIT_INCL_USERS" * }, * { * ApplyType: "DYNAMIC", * IsModifiable: true, * IsRequired: false, * MinimumEngineVersionPerAllowedValue: [], * SettingDescription: "Exclude specified users", * SettingName: "SERVER_AUDIT_EXCL_USERS" * } * ], * OptionsConflictsWith: [], * OptionsDependedOn: [], * Permanent: false, * Persistent: false, * PortRequired: false, * RequiresAutoMinorEngineVersionUpgrade: false, * VpcOnly: false * } * ] * } * *\/ * ``` * * @public */ export declare class DescribeOptionGroupOptionsCommand extends DescribeOptionGroupOptionsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeOptionGroupOptionsMessage; output: OptionGroupOptionsMessage; }; sdk: { input: DescribeOptionGroupOptionsCommandInput; output: DescribeOptionGroupOptionsCommandOutput; }; }; }