Skip to main content

@swamp/aws/iotevents

v2026.04.23.3

AWS IOTEVENTS infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

awsioteventscloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/aws/iotevents

@swamp/aws/iotevents/alarm-modelv2026.04.23.2alarm_model.ts

Global Arguments

ArgumentTypeDescription
AlarmModelName?stringThe name of the alarm model.
AlarmModelDescription?stringThe description of the alarm model.
RoleArnstringThe ARN of the IAM role that allows the alarm to perform actions and access AWS resources. For more information, see [Amazon Resource Names (ARNs)](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
Key?stringAn input attribute used as a key to create an alarm. ITE routes [inputs](https://docs.aws.amazon.com/iotevents/latest/apireference/API_Input.html) associated with this key to the alarm.
Severity?numberA non-negative integer that reflects the severity level of the alarm.
AlarmRuleobjectDefines when your alarm is invoked.
AlarmEventActions?objectContains information about one or more alarm actions.
AlarmCapabilities?objectContains the configuration information of alarm state changes.
Tags?arrayA list of key-value pairs that contain metadata for the alarm model. The tags help you manage the alarm model. For more information, see [Tagging your resources](https://docs.aws.amazon.com/iotevents/latest/developerguide/tagging-iotevents.html) in the *Developer Guide*. You can create up to 50 tags for one alarm model.
createCreate a IoTEvents AlarmModel
getGet a IoTEvents AlarmModel
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTEvents AlarmModel
updateUpdate a IoTEvents AlarmModel
deleteDelete a IoTEvents AlarmModel
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTEvents AlarmModel
syncSync IoTEvents AlarmModel state from AWS

Resources

state(infinite)— IoTEvents AlarmModel resource state
@swamp/aws/iotevents/detector-modelv2026.04.23.2detector_model.ts

Global Arguments

ArgumentTypeDescription
DetectorModelDefinitionobjectInformation that defines how a detector operates.
DetectorModelDescription?stringA brief description of the detector model.
DetectorModelName?stringThe name of the detector model.
EvaluationMethod?enumInformation about the order in which events are evaluated and how actions are executed.
Key?stringThe value used to identify a detector instance. When a device or system sends input, a new detector instance with a unique key value is created. ITE can continue to route input to its corresponding detector instance based on this identifying information. This parameter uses a JSON-path expression to select the attribute-value pair in the message payload that is used for identification. To route the message to the correct detector instance, the device must send a message payload that contains the
RoleArnstringThe ARN of the role that grants permission to ITE to perform its operations.
Tags?arrayAn array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
createCreate a IoTEvents DetectorModel
getGet a IoTEvents DetectorModel
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTEvents DetectorModel
updateUpdate a IoTEvents DetectorModel
deleteDelete a IoTEvents DetectorModel
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTEvents DetectorModel
syncSync IoTEvents DetectorModel state from AWS

Resources

state(infinite)— IoTEvents DetectorModel resource state
@swamp/aws/iotevents/inputv2026.04.23.2input.ts

Global Arguments

ArgumentTypeDescription
InputDefinitionobjectThe definition of the input.
InputDescription?stringA brief description of the input.
InputName?stringThe name of the input.
Tags?arrayAn array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html).
createCreate a IoTEvents Input
getGet a IoTEvents Input
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTEvents Input
updateUpdate a IoTEvents Input
deleteDelete a IoTEvents Input
ArgumentTypeDescription
identifierstringThe primary identifier of the IoTEvents Input
syncSync IoTEvents Input state from AWS

Resources

state(infinite)— IoTEvents Input resource state