v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142826341.7 MB

Describes the available option groups.

get/#Action=DescribeOptionGroups

Query parameters

OptionGroupNamestring

The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.

Namestring required

The name of the filter. Filter names are case-sensitive.

Valuesstring[] required

One or more filter values. Filter values are case-sensitive.

This parameter isn't currently supported.

Markerstring

An optional pagination token provided by a previous DescribeOptionGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.

MaxRecordsinteger
<p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>
EngineNamestring
<p>Filters the list of option groups to only include groups associated with a specific database engine.</p> <p>Valid Values:</p> <ul> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>
MajorEngineVersionstring

Filters the list of option groups to only include groups associated with a specific database engine version. If specified, then EngineName must also be specified.

Action'DescribeOptionGroups' required
Version'2014-10-31' required

Response

Success