Amazon IoT Events Alarm Models API is one of 8 APIs that Amazon IoT Events publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Alarm Models. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.
This API exposes
6 operations
across 3 paths,
and defines 101 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.0.
Requests are made against 4 base URLs: http://iotevents.{region}.amazonaws.com, https://iotevents.{region}.amazonaws.com, http://iotevents.{region}.amazonaws.com.cn, https://iotevents.{region}.amazonaws.com.cn.
6 operations3 paths101 schemas1 DELETE3 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Amazon IoT Events Alarm Models API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (hmac).
By default, every request must be authenticated.
hmac — Amazon Signature authorization v4
Paths & Operations 6
Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 101 schemas that model the data the API accepts and returns. The most detailed are DescribeAlarmModelResponse (15 properties), DynamoDBAction (10 properties), AlarmAction (9 properties), AlarmModelVersionSummary (8 properties). Each schema is shown below with its type and property counts.
DynamoKeyField
string
AssetPropertyQuality
string
IotEventsAction
object
Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
2 properties1 required
AlarmEventActions
object
Contains information about one or more alarm actions.
1 property
SNSTopicPublishAction
object
Information required to publish the Amazon SNS message.
2 properties1 required
ContentExpression
string
AssetPropertyEntryId
string
InputProperty
string
UseBase64
boolean
EmailConfiguration
object
Contains the configuration information of email notifications.
3 properties2 required
AcknowledgeFlowEnabled
boolean
ComparisonOperator
string
InternalFailureException
AssetPropertyBooleanValue
string
AssetPropertyId
string
RecipientDetails
array
ResourceNotFoundException
FirehoseAction
object
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
3 properties1 required
SimpleRule
object
A rule that compares an input property value to a threshold value with a comparison operator.
3 properties3 required
ThrottlingException
NotificationTargetActions
object
Specifies an AWS Lambda function to manage alarm notifications. You can create one or use the AWS Lambda function provided by AWS IoT Events .
1 property
EmailSubject
string
AlarmModelSummary
object
Contains a summary of an alarm model.
3 properties
DynamoDBv2Action
object
Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model inst…
2 properties1 required
InitializationConfiguration
object
Specifies the default alarm state. The configuration applies to all alarms that were created based on this alarm model.
1 property1 required
AlarmAction
object
Specifies one of the following actions to receive notifications when the alarm state changes.
9 properties
IotSiteWiseAction
object
Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise. You must use exp…
5 properties
FromEmail
string
AssetPropertyTimeInSeconds
string
QueueUrl
string
Threshold
string
ResourceAlreadyExistsException
Payload
object
Information needed to configure the payload. By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all a…
2 properties2 required
DynamoOperation
string
DeliveryStreamName
string
AssetPropertyVariant
object
A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference . You must use expressions for all p…
4 properties
AssetPropertyValue
object
A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference . You must use expressions for…
3 properties
Timestamp
string
EmailConfigurations
array
AlarmModelName
string
SMSConfiguration
object
Contains the configuration information of SMS notifications.
3 properties1 required
AlarmModelVersionStatus
string
EmailContent
object
Contains the subject and message of an email.
2 properties
Tag
object
Metadata that can be used to manage the resource.
2 properties2 required
AssetPropertyAlias
string
DisabledOnInitialization
boolean
AlarmActions
array
Severity
integer
SqsAction
object
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
3 properties1 required
NotificationAction
object
Contains the notification settings of an alarm model. The settings apply to all alarms that were created based on this alarm model.
3 properties1 required
ResourceInUseException
InvalidRequestException
LambdaAction
object
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
2 properties1 required
AlarmModelVersion
string
AcknowledgeFlow
object
Specifies whether to get notified for alarm state changes.
1 property1 required
TagValue
string
SSOReferenceId
string
AlarmModelArn
string
RecipientDetail
object
The information that identifies the recipient.
1 property
LimitExceededException
UpdateAlarmModelResponse
object
5 properties
PayloadType
string
NextToken
string
InputName
string
EmailRecipients
object
Contains the information of one or more recipients who receive the emails. You must add the users that receive emails to your AWS SSO store .
1 property
MQTTTopic
string
IotTopicPublishAction
object
Information required to publish the MQTT message through the AWS IoT message broker.
2 properties1 required
FirehoseSeparator
string
AttributeJsonPath
string
DynamoTableName
string
AlarmModelVersionSummary
object
Contains a summary of an alarm model version.
8 properties
AssetPropertyTimestamp
object
A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference . You must use expressions for all…
2 properties1 required
AssetId
string
ListAlarmModelsResponse
object
2 properties
AssetPropertyDoubleValue
string
ListAlarmModelVersionsResponse
object
2 properties
AmazonResourceName
string
ServiceUnavailableException
NotificationActions
array
AssetPropertyOffsetInNanos
string
AssetPropertyIntegerValue
string
StatusMessage
string
DynamoDBAction
object
Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model ins…
10 properties3 required
AlarmModelVersionSummaries
array
AlarmNotification
object
Contains information about one or more notification actions.
1 property
AlarmModelSummaries
array
DeleteAlarmModelResponse
object
DynamoKeyType
string
DescribeAlarmModelResponse
object
15 properties
AlarmCapabilities
object
Contains the configuration information of alarm state changes.
2 properties
AssetPropertyStringValue
string
AlarmModelDescription
string
TagKey
string
SMSConfigurations
array
CreateAlarmModelResponse
object
5 properties
AlarmRule
object
Defines when your alarm is invoked.
1 property
SSOIdentity
object
Contains information about your identity source in AWS Single Sign-On. For more information, see the AWS Single Sign-On User Guide .
2 properties1 required
IdentityStoreId
string
NotificationAdditionalMessage
string
DynamoKeyValue
string
SMSSenderId
string
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Amazon IoT Events Alarm Models API, published by
API Evangelist. We do not operate, host, resell, or
support these APIs, and we are not affiliated with or endorsed by the company unless stated above.
Everything here is built from publicly available information — the company's own site,
developer portal, documentation, public repositories, and the specifications it publishes for public use.
Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's
public API artifacts, scored against a published rubric. They are not certifications,
endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and
you do not need to justify the request. A removed company is recorded as unrated, never scored
zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy → On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.
