ioteventsdata/aws.sdk.kotlin.services.ioteventsdata

Package-level declarations

Types

interface IotEventsDataClient : SdkClient

IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to detectors, list detectors, and view or update a detector's status.

Properties

SdkVersion

const val SdkVersion: String

ServiceApiVersion

const val ServiceApiVersion: String

ServiceId

const val ServiceId: String

Inherited functions

batchAcknowledgeAlarm

inline suspend fun IotEventsDataClient.batchAcknowledgeAlarm(crossinline block: BatchAcknowledgeAlarmRequest.Builder.() -> Unit): BatchAcknowledgeAlarmResponse

Acknowledges one or more alarms. The alarms change to the ACKNOWLEDGED state after you acknowledge them.

batchDeleteDetector

inline suspend fun IotEventsDataClient.batchDeleteDetector(crossinline block: BatchDeleteDetectorRequest.Builder.() -> Unit): BatchDeleteDetectorResponse

Deletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of detectors. The deleted detector will no longer appear if referenced in the ListDetectors API call.

batchDisableAlarm

inline suspend fun IotEventsDataClient.batchDisableAlarm(crossinline block: BatchDisableAlarmRequest.Builder.() -> Unit): BatchDisableAlarmResponse

Disables one or more alarms. The alarms change to the DISABLED state after you disable them.

batchEnableAlarm

inline suspend fun IotEventsDataClient.batchEnableAlarm(crossinline block: BatchEnableAlarmRequest.Builder.() -> Unit): BatchEnableAlarmResponse

Enables one or more alarms. The alarms change to the NORMAL state after you enable them.

batchPutMessage

inline suspend fun IotEventsDataClient.batchPutMessage(crossinline block: BatchPutMessageRequest.Builder.() -> Unit): BatchPutMessageResponse

Sends a set of messages to the IoT Events system. Each message payload is transformed into the input you specify ("inputName") and ingested into any detectors that monitor that input. If multiple messages are sent, the order in which the messages are processed isn't guaranteed. To guarantee ordering, you must send messages one at a time and wait for a successful response.

batchResetAlarm

inline suspend fun IotEventsDataClient.batchResetAlarm(crossinline block: BatchResetAlarmRequest.Builder.() -> Unit): BatchResetAlarmResponse

Resets one or more alarms. The alarms return to the NORMAL state after you reset them.

batchSnoozeAlarm

inline suspend fun IotEventsDataClient.batchSnoozeAlarm(crossinline block: BatchSnoozeAlarmRequest.Builder.() -> Unit): BatchSnoozeAlarmResponse

Changes one or more alarms to the snooze mode. The alarms change to the SNOOZE_DISABLED state after you set them to the snooze mode.

batchUpdateDetector

inline suspend fun IotEventsDataClient.batchUpdateDetector(crossinline block: BatchUpdateDetectorRequest.Builder.() -> Unit): BatchUpdateDetectorResponse

Updates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model.

describeAlarm

inline suspend fun IotEventsDataClient.describeAlarm(crossinline block: DescribeAlarmRequest.Builder.() -> Unit): DescribeAlarmResponse

Retrieves information about an alarm.

describeDetector

inline suspend fun IotEventsDataClient.describeDetector(crossinline block: DescribeDetectorRequest.Builder.() -> Unit): DescribeDetectorResponse

Returns information about the specified detector (instance).

listAlarms

inline suspend fun IotEventsDataClient.listAlarms(crossinline block: ListAlarmsRequest.Builder.() -> Unit): ListAlarmsResponse

Lists one or more alarms. The operation returns only the metadata associated with each alarm.

listDetectors

inline suspend fun IotEventsDataClient.listDetectors(crossinline block: ListDetectorsRequest.Builder.() -> Unit): ListDetectorsResponse

Lists detectors (the instances of a detector model).

withConfig

fun IotEventsDataClient.withConfig(block: IotEventsDataClient.Config.Builder.() -> Unit): IotEventsDataClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.