Skip to content

RDS  >  Operations  >  describe_option_group_options

describe_option_group_options

Operation

describe_option_group_options async

describe_option_group_options(request: DescribeOptionGroupOptionsInput | DescribeOptionGroupOptionsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeOptionGroupOptionsOutput
describe_option_group_options(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeOptionGroupOptionsInputDict]) -> DescribeOptionGroupOptionsOutput

Describes all available options for the specified engine.

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
DescribeOptionGroupOptionsOutput

An instance of DescribeOptionGroupOptionsOutput.

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

DescribeOptionGroupOptionsInput dataclass

Bases: _SerdeShape

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

The name of the engine to describe options for.

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

If specified, filters the results to include only options for the specified major engine version.

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.

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.

Dictionaries

DescribeOptionGroupOptionsInputDict

Bases: TypedDict

Dictionary form of DescribeOptionGroupOptionsInput.

Attributes
engine_name instance-attribute
engine_name: Required[str]

The name of the engine to describe options for.

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

If specified, filters the results to include only options for the specified major engine version.

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

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.

Output

DescribeOptionGroupOptionsOutput dataclass

Bases: _SerdeShape

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_group_options class-attribute instance-attribute
option_group_options: list[OptionGroupOption] | None = ...

List of available option group options.

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.