(constructor)

[configuration]

Constructs a new instance of the <code>IoTEventsClient</code> class

config

The resolved configuration of IoTEventsClient class. This is resolved and normalized from the [constructor configuration interface](@aws-sdk/client-iot-events!IoTEventsClientConfig:Interface).

destroy

Destroy underlying resources, like sockets. It's usually not necessary to do this. However in Node.js, it's best to explicitly shut down the client's agent when it is no longer needed. Otherwise, sockets might stay open for quite a long time before the server terminates them.

middlewareStack

send

command

options

IoTEventsClient

AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and detector models, and to list their versions.

defaultsMode

The [@smithy/smithy-client#DefaultsMode](@smithy/smithy-client!DefaultsMode:type) that will be used to determine how certain default configuration options are resolved in the SDK.

disableHostPrefix

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

extensions

logger

Optional logger for logging debug/info/warn/error.

maxAttempts

Value for how many times a request will be made at most in case of retry.

profile

Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.

region

The AWS region to which this client will send requests

requestHandler

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

retryMode

useDualstackEndpoint

useFipsEndpoint

ClientDefaults

CreateAlarmModelCommand

Creates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html">Create an alarm model</a> in the AWS IoT Events Developer Guide.

CreateDetectorModelCommand

CreateInputCommand

DeleteAlarmModelCommand

Deletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.

DeleteDetectorModelCommand

Deletes a detector model. Any active instances of the detector model are also deleted.

DeleteInputCommand

DescribeAlarmModelCommand

Retrieves information about an alarm model. If you don't specify a value for the <code>alarmModelVersion</code> parameter, the latest version is returned.

DescribeDetectorModelAnalysisCommand

Retrieves runtime information about a detector model analysis. <note> After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results. </note>

DescribeDetectorModelCommand

Describes a detector model. If the <code>version</code> parameter is not specified, information about the latest version is returned.

DescribeInputCommand

DescribeLoggingOptionsCommand

Retrieves the current settings of the AWS IoT Events logging options.

GetDetectorModelAnalysisResultsCommand

Retrieves one or more analysis results of the detector model. <note> After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results. </note>

ListAlarmModelVersionsCommand

Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version.

ListAlarmModelsCommand

Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model.

ListDetectorModelVersionsCommand

Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned.

ListDetectorModelsCommand

Lists the detector models you have created. Only the metadata associated with each detector model is returned.

ListInputRoutingsCommand

Lists one or more input routings.

ListInputsCommand

Lists the inputs you have created.

ListTagsForResourceCommand

Lists the tags (metadata) you have assigned to the resource.

PutLoggingOptionsCommand

Sets or updates the AWS IoT Events logging options. If you update the value of any <code>loggingOptions</code> field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the <code>roleArn</code> field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.

StartDetectorModelAnalysisCommand

Performs an analysis of your detector model. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html">Troubleshooting a detector model</a> in the AWS IoT Events Developer Guide.

TagResourceCommand

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

UntagResourceCommand

Removes the given tags (metadata) from the resource.

UpdateAlarmModelCommand

Updates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives.

UpdateDetectorModelCommand

Updates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.