RDS / Client / describe_event_categories

describe_event_categories

RDS.Client.describe_event_categories(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_event_categories(
    SourceType='string',
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ]
)

Parameters:

• SourceType (string) –

  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 (list) –

  This parameter isn’t currently supported.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

    Note

    Currently, wildcards are not supported in filters.

    The following actions can be filtered:

    • DescribeDBClusterBacktracks

    • DescribeDBClusterEndpoints

    • DescribeDBClusters

    • DescribeDBInstances

    • DescribeDBRecommendations

    • DescribeDBShardGroups

    • DescribePendingMaintenanceActions

    • Name (string) – [REQUIRED]

      The name of the filter. Filter names are case-sensitive.

    • Values (list) – [REQUIRED]

      One or more filter values. Filter values are case-sensitive.

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'EventCategoriesMapList': [
        {
            'SourceType': 'string',
            'EventCategories': [
                'string',
            ]
        },
    ]
}

Response Structure

• (dict) –

  Data returned from the DescribeEventCategories operation.

  • EventCategoriesMapList (list) –

    A list of EventCategoriesMap data types.

    • (dict) –

      Contains the results of a successful invocation of the DescribeEventCategories operation.

      • SourceType (string) –

        The source type that the returned categories belong to

      • EventCategories (list) –

        The event categories for the specified source type

        • (string) –

Examples

This example lists all DB instance event categories.

response = client.describe_event_categories(
    SourceType='db-instance',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}