describe_option_group_options `async` ¶

describe_option_group_options(
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    engine_name: Optional[String] = None,
    major_engine_version: Optional[String] = None,
    filters: Optional[FilterList] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> OptionGroupOptionsMessage

Describes all available options for the specified engine.

Parameters:

engine_name (Optional[String], default: 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
major_engine_version (Optional[String], default: None ) –

If specified, filters the results to include only options for the specified major engine version.
filters (Optional[FilterList], default: None ) –

This parameter isn't currently supported.
max_records (Optional[IntegerOptional], default: 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.
marker (Optional[String], default: 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.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Examples:

To describe all available options The following example lists the options for an RDS for MySQL version 8.0 DB instance.

>>> await client.describe_option_group_options(engine_name='mysql', major_engine_version='8.0')

Source code in docs_src/capo_rds/_services/async_rds.py

async def describe_option_group_options(
    self,
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    engine_name: Optional["capo_rds.types.string.String"] = None,
    major_engine_version: Optional["capo_rds.types.string.String"] = None,
    filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
    max_records: Optional["capo_rds.types.integer_optional.IntegerOptional"] = None,
    marker: Optional["capo_rds.types.string.String"] = None,
) -> "capo_rds.types.option_group_options_message.OptionGroupOptionsMessage":
    """<p>Describes all available options for the specified engine.</p>

    Args:
        engine_name: <p>The name of the engine to describe options for.</p> <p>Valid Values:</p> <ul> <li> <p> <code>db2-ae</code> </p> </li> <li> <p> <code>db2-ce</code> </p> </li> <li> <p> <code>db2-se</code> </p> </li> <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>
        major_engine_version: <p>If specified, filters the results to include only options for the specified major engine version.</p>
        filters: <p>This parameter isn't currently supported.</p>
        max_records: <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>
        marker: <p>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 <code>MaxRecords</code>.</p>

    Raises:
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe all available options
        The following example lists the options for an RDS for MySQL version 8.0 DB instance.

        >>> await client.describe_option_group_options(engine_name='mysql', major_engine_version='8.0')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rds.types.describe_option_group_options_message.DescribeOptionGroupOptionsMessage]",
    ) -> AsyncOperationResponse[
        "capo_rds.types.option_group_options_message.OptionGroupOptionsMessage"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_option_group_options

        (
            output,
            http_response,
        ) = await capo_rds._operations.amazon_rd_sv19.describe_option_group_options.async_describe_option_group_options(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeOptionGroupOptions")
    )
    input_: capo_rds.types.describe_option_group_options_message.DescribeOptionGroupOptionsMessage = {}
    if engine_name is not None:
        input_["engine_name"] = engine_name
    if major_engine_version is not None:
        input_["major_engine_version"] = major_engine_version
    if filters is not None:
        input_["filters"] = filters
    if max_records is not None:
        input_["max_records"] = max_records
    if marker is not None:
        input_["marker"] = marker

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_option_group_options async ¶

describe_option_group_options `async` ¶