describe_option_groups ¶

def describe_option_groups(
    self,
    *,
    config_overrides: Optional[RDSClientConfig] = None,
    option_group_name: Optional["capo_rds.types.string.String"] = None,
    filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
    marker: Optional["capo_rds.types.string.String"] = None,
    max_records: Optional["capo_rds.types.integer_optional.IntegerOptional"] = None,
    engine_name: Optional["capo_rds.types.string.String"] = None,
    major_engine_version: Optional["capo_rds.types.string.String"] = None,
) -> "capo_rds.types.option_groups.OptionGroups":
    """<p>Describes the available option groups.</p>

    Args:
        option_group_name: <p>The name of the option group to describe. Can't be supplied together with EngineName or MajorEngineVersion.</p>
        filters: <p>This parameter isn't currently supported.</p>
        marker: <p>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>.</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>
        engine_name: <p>A filter to only include option groups associated with this database engine.</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>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.</p>

    Raises:
        capo_rds.errors.option_group_not_found_fault.OptionGroupNotFoundFault: <p>The specified option group could not be found.</p>
        capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe the available option groups
        The following example lists the options groups for an Oracle Database 19c instance.

        >>> client.describe_option_groups(engine_name='oracle-ee', major_engine_version='19')
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.describe_option_groups_message.DescribeOptionGroupsMessage]",
    ) -> OperationResponse["capo_rds.types.option_groups.OptionGroups"]:
        import capo_rds._operations.amazon_rd_sv19.describe_option_groups

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.describe_option_groups.describe_option_groups(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_rds.types.option_groups.OptionGroups",
    ) -> dict[str, Any]:
        import capo_rds.types.option_groups

        return capo_rds.types.option_groups.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeOptionGroups", redact_output=_redact_output),
    )
    input_: capo_rds.types.describe_option_groups_message.DescribeOptionGroupsMessage = {}
    if option_group_name is not None:
        input_["option_group_name"] = option_group_name
    if filters is not None:
        input_["filters"] = filters
    if marker is not None:
        input_["marker"] = marker
    if max_records is not None:
        input_["max_records"] = max_records
    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

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output