Skip to content

RDS  >  Operations  >  describe_option_groups

describe_option_groups

Operation

describe_option_groups async

describe_option_groups(request: DescribeOptionGroupsInput | DescribeOptionGroupsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeOptionGroupsOutput
describe_option_groups(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeOptionGroupsInputDict]) -> DescribeOptionGroupsOutput

Describes the available option groups.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeOptionGroupsOutput

An instance of DescribeOptionGroupsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeOptionGroupsInput dataclass

Bases: _SerdeShape

Attributes
engine_name class-attribute instance-attribute
engine_name: str | None = ...

A filter to only include option groups associated with this database engine.

Valid Values:

  • db2-ae

  • db2-ce

  • db2-se

  • mariadb

  • mysql

  • oracle-ee

  • oracle-ee-cdb

  • oracle-se2

  • oracle-se2-cdb

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

filters class-attribute instance-attribute
filters: list[Filter] | None = ...

This parameter isn't currently supported.

major_engine_version class-attribute instance-attribute
major_engine_version: str | None = ...

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.

marker class-attribute instance-attribute
marker: str | None = ...

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

max_records class-attribute instance-attribute
max_records: int | None = ...

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

option_group_name class-attribute instance-attribute
option_group_name: str | None = ...

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

Dictionaries

DescribeOptionGroupsInputDict

Bases: TypedDict

Dictionary form of DescribeOptionGroupsInput.

Attributes
engine_name instance-attribute
engine_name: str | None

A filter to only include option groups associated with this database engine.

Valid Values:

  • db2-ae

  • db2-ce

  • db2-se

  • mariadb

  • mysql

  • oracle-ee

  • oracle-ee-cdb

  • oracle-se2

  • oracle-se2-cdb

  • postgres

  • sqlserver-ee

  • sqlserver-se

  • sqlserver-ex

  • sqlserver-web

filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

This parameter isn't currently supported.

major_engine_version instance-attribute
major_engine_version: str | None

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.

marker instance-attribute
marker: str | None

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

max_records instance-attribute
max_records: int | None

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

option_group_name instance-attribute
option_group_name: str | None

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

Output

DescribeOptionGroupsOutput dataclass

Bases: _SerdeShape

List of option groups.

Attributes

marker class-attribute instance-attribute
marker: str | None = ...

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.

option_groups_list class-attribute instance-attribute
option_groups_list: list[OptionGroup] | None = ...

List of option groups.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.