Skip to content

describe_event_categories

describe_event_categories(
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    source_type: Optional[String] = None,
    filters: Optional[FilterList] = None,
) -> EventCategoriesMessage

Displays a list of categories for all event source types, or, if specified, for a specified source type.

Parameters:

  • source_type (Optional[String], default: None ) –

    The type of source that is generating the events.

    Valid values: db-instance, db-parameter-group, db-security-group

  • filters (Optional[FilterList], default: None ) –

    This parameter is not currently supported.

Raises:

Source code in docs_src/capo_docdb/_services/doc_db.py
def describe_event_categories(
    self,
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    source_type: Optional["capo_docdb.types.string.String"] = None,
    filters: Optional["capo_docdb.types.filter_list.FilterList"] = None,
) -> "capo_docdb.types.event_categories_message.EventCategoriesMessage":
    """<p>Displays a list of categories for all event source types, or, if specified, for a specified source type. </p>

    Args:
        source_type: <p>The type of source that is generating the events.</p> <p>Valid values: <code>db-instance</code>, <code>db-parameter-group</code>, <code>db-security-group</code> </p>
        filters: <p>This parameter is not currently supported.</p>

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

    def _handler(
        req: "OperationRequest[capo_docdb.types.describe_event_categories_message.DescribeEventCategoriesMessage]",
    ) -> OperationResponse[
        "capo_docdb.types.event_categories_message.EventCategoriesMessage"
    ]:
        import capo_docdb._operations.amazon_rd_sv19.describe_event_categories

        output, http_response = (
            capo_docdb._operations.amazon_rd_sv19.describe_event_categories.describe_event_categories(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEventCategories")
    )
    input_: capo_docdb.types.describe_event_categories_message.DescribeEventCategoriesMessage = {}
    if source_type is not None:
        input_["source_type"] = source_type
    if filters is not None:
        input_["filters"] = filters

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