DescribeEventCategoriesCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DocDBClient, DescribeEventCategoriesCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, DescribeEventCategoriesCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // DescribeEventCategoriesMessage
  SourceType: "STRING_VALUE",
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE", // required
      Values: [ // FilterValueList // required
        "STRING_VALUE",
      ],
    },
  ],
};
const command = new DescribeEventCategoriesCommand(input);
const response = await client.send(command);
// { // EventCategoriesMessage
//   EventCategoriesMapList: [ // EventCategoriesMapList
//     { // EventCategoriesMap
//       SourceType: "STRING_VALUE",
//       EventCategories: [ // EventCategoriesList
//         "STRING_VALUE",
//       ],
//     },
//   ],
// };

DescribeEventCategoriesCommand Input

See DescribeEventCategoriesCommandInput for more details

Parameter
Type
Description
Filters
Filter[] | undefined

This parameter is not currently supported.

SourceType
string | undefined

The type of source that is generating the events.

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

DescribeEventCategoriesCommand Output

See DescribeEventCategoriesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
EventCategoriesMapList
EventCategoriesMap[] | undefined

A list of event category maps.

Throws

Name
Fault
Details
DocDBServiceException
Base exception class for all service exceptions from DocDB service.