DescribeEventConfigurationsCommand

Suggest an Edit

Describes event configurations.

Requires permission to access the DescribeEventConfigurations  action.

Example Syntax

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

import { IoTClient, DescribeEventConfigurationsCommand } from "@aws-sdk/client-iot"; // ES Modules import
// const { IoTClient, DescribeEventConfigurationsCommand } = require("@aws-sdk/client-iot"); // CommonJS import
const client = new IoTClient(config);
const input = {};
const command = new DescribeEventConfigurationsCommand(input);
const response = await client.send(command);
// { // DescribeEventConfigurationsResponse
//   eventConfigurations: { // EventConfigurations
//     "<keys>": { // Configuration
//       Enabled: true || false,
//     },
//   },
//   creationDate: new Date("TIMESTAMP"),
//   lastModifiedDate: new Date("TIMESTAMP"),
// };

DescribeEventConfigurationsCommand Input

See DescribeEventConfigurationsCommandInput for more details
DescribeEventConfigurationsCommandInput extends DescribeEventConfigurationsRequest

DescribeEventConfigurationsCommand Output

See DescribeEventConfigurationsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
creationDate
Date | undefined

The creation date of the event configuration.

eventConfigurations
Partial<Record<EventType, Configuration> | undefined

The event configurations.

lastModifiedDate
Date | undefined

The date the event configurations were last modified.

Throws

Name
Fault
Details
InternalFailureException
server

An unexpected error has occurred.

ThrottlingException
client

The rate exceeds the limit.

IoTServiceException
Base exception class for all service exceptions from IoT service.