DocDB / Client / describe_event_categories

describe_event_categories#

DocDB.Client.describe_event_categories(**kwargs)#

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

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.

Valid values: db-instance, db-parameter-group, db-security-group
Filters (list) –
This parameter is not currently supported.
- (dict) –
  
  A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
  
  Wildcards are not supported in filters.
  - 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) –

Represents the output of DescribeEventCategories.
- EventCategoriesMapList (list) –
  
  A list of event category maps.
  - (dict) –
    
    An event source type, accompanied by one or more event category names.
    - SourceType (string) –
      
      The source type that the returned categories belong to.
    - EventCategories (list) –
      
      The event categories for the specified source type.
      - (string) –