describe_event_categories `async` ¶

describe_event_categories(
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = 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. You can also see this list in the "Amazon RDS event categories and event messages" section of the Amazon RDS User Guide or the Amazon Aurora User Guide .

Parameters:

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

The type of source that is generating the events. For RDS Proxy events, specify db-proxy.

Valid Values: db-instance | db-cluster | db-parameter-group | db-security-group | db-snapshot | db-cluster-snapshot | db-proxy
filters (Optional[FilterList], default: None ) –

This parameter isn't currently supported.

Raises:

UnknownServiceError –

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

Examples:

To describe event categories The following example retrieves details about the event categories for all available event sources.

>>> await client.describe_event_categories(source_type='', filters=[])

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

async def describe_event_categories(
    self,
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    source_type: Optional["capo_rds.types.string.String"] = None,
    filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
) -> "capo_rds.types.event_categories_message.EventCategoriesMessage":
    """<p>Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html"> <i>Amazon RDS User Guide</i> </a> or the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html"> <i>Amazon Aurora User Guide</i> </a>.</p>

    Args:
        source_type: <p>The type of source that is generating the events. For RDS Proxy events, specify <code>db-proxy</code>.</p> <p>Valid Values: <code>db-instance</code> | <code>db-cluster</code> | <code>db-parameter-group</code> | <code>db-security-group</code> | <code>db-snapshot</code> | <code>db-cluster-snapshot</code> | <code>db-proxy</code> </p>
        filters: <p>This parameter isn't currently supported.</p>

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

    Examples:
        To describe event categories
        The following example retrieves details about the event categories for all available event sources.

        >>> await client.describe_event_categories(source_type='', filters=[])
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rds.types.describe_event_categories_message.DescribeEventCategoriesMessage]",
    ) -> AsyncOperationResponse[
        "capo_rds.types.event_categories_message.EventCategoriesMessage"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_event_categories

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEventCategories")
    )
    input_: capo_rds.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 = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

describe_event_categories async ¶

describe_event_categories `async` ¶